1pki-upgrade(8)                 PKI Upgrade Tool                 pki-upgrade(8)
2
3
4

NAME

6       pki-upgrade - Tool for upgrading system-wide PKI configuration.
7
8

SYNOPSIS

10       pki-upgrade [OPTIONS]
11
12

DESCRIPTION

14       There  are two parts to upgrading PKI system: upgrading the system con‐
15       figuration files used by both the client and the server  processes  and
16       upgrading the server configuration files.
17
18
19       When  upgrading  PKI  system,  the  existing system configuration files
20       (e.g. /etc/pki/pki.conf) may need to be upgraded  because  the  content
21       may  have  changed  from  one  version  to  another.  The configuration
22       upgrade is executed automatically during RPM upgrade.  However, in case
23       there  is  a  problem,  the  process  can  also  be  run manually using
24       pki-upgrade.
25
26
27       The  system  upgrade  process  is  done  incrementally  using   upgrade
28       scriptlets.   The  upgrade process and scriptlet execution is monitored
29       in upgrade trackers.  A counter shows the latest index number  for  the
30       most  recently  executed  scriptlet;  when all scriptlets have run, the
31       component tracker shows the updated version number.
32
33
34       The  upgrade  scriptlets  are  stored  in   /usr/share/pki/upgrade/ver‐
35       sion/index-name.   The  version  is  the system version to be upgraded.
36       The index is the script execution order.  The  name  is  the  scriptlet
37       name.
38
39
40       During upgrade, the scriptlets will back up all changes to the filesys‐
41       tem into /var/log/pki/upgrade/version/index.   The  version  and  index
42       values  indicate the scriptlet being executed.  A copy of the files and
43       folders that are being modified or removed will be stored in  oldfiles.
44       The  names  of the newly-added files and folders will be stored in new‐
45       files.
46
47
48       The system upgrade process is  tracked  in  /etc/pki/pki.version.   The
49       file  stores  the current configuration version and the last successful
50       scriptlet index.
51
52

OPTIONS

54   General options
55       --silent
56           Upgrade in silent mode.
57
58
59       --status
60           Show upgrade status only without performing the upgrade.
61
62
63       --revert
64           Revert the last version.
65
66
67       -X
68           Show advanced options.
69
70
71       -v, --verbose
72           Run in verbose mode.
73
74
75       -h, --help
76           Show this help message.
77
78
79   Advanced options
80       The advanced options circumvent the normal component  tracking  process
81       by changing the scriptlet order or changing the tracker information.
82
83
84       WARNING: These options may render the system unusable.
85
86
87       --scriptlet-version version
88           Run scriptlets for a specific version only.
89
90
91       --scriptlet-index index
92           Run a specific scriptlet only.
93
94
95       --remove-tracker
96           Remove the tracker.
97
98
99       --reset-tracker
100           Reset the tracker to match the package version.
101
102
103       --set-tracker version
104           Set the tracker to a specific version.
105
106

OPERATIONS

108   Interactive mode
109       By default, pki-upgrade will run interactively.  It will ask for a con‐
110       firmation before executing each scriptlet.
111
112
113              $ pki-upgrade
114
115
116
117       If there is an error, it will stop and show the error.
118
119
120   Silent mode
121       The upgrade process can also be done silently without user interaction:
122
123
124              $ pki-upgrade --silent
125
126
127
128       If there is an error, it will stop and show the error.
129
130
131   Checking upgrade status
132       It is possible to check the status of a running upgrade process.
133
134
135              $ pki-upgrade --status
136
137
138
139   Troubleshooting
140       If there is an error, rerun the upgrade in verbose mode:
141
142
143              $ pki-upgrade --verbose
144
145
146
147       Check the scriptlet to see which operations are being  executed.   Once
148       the  error  is  identified and corrected, the upgrade can be resumed by
149       re-running pki-upgrade.
150
151
152       It is possible to rerun a  failed  script  by  itself,  specifying  the
153       instance and subsystem, version, and scriptlet index:
154
155
156              $ pki-upgrade --scriptlet-version 10.0.1 --scriptlet-index 1
157
158
159
160   Reverting an upgrade
161       If necessary, the upgrade can be reverted:
162
163
164              $ pki-upgrade --revert
165
166
167
168       Files  and  folders that were created by the scriptlet will be removed.
169       Files and folders that were modified or removed by the  scriptlet  will
170       be restored.
171
172

FILES

174       /usr/sbin/pki-upgrade
175
176

AUTHORS

178       Ade  Lee  <alee@redhat.com>, Ella Deon Lackey <dlackey@redhat.com>, and
179       Endi S. Dewata <edewata@redhat.com>.
180
181

183       Copyright (c) 2013 Red Hat, Inc.  This is licensed under the  GNU  Gen‐
184       eral  Public  License,  version  2  (GPLv2).  A copy of this license is
185       available at ⟨http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt⟩.
186
187
188
189PKI                              Jul 22, 2013                   pki-upgrade(8)
Impressum