pki-upgrade(8)

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 up‐
22       grade is executed automatically during RPM upgrade.  However,  in  case
23       there  is a problem, the process can also be run manually using pki-up‐
24       grade.
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/version/in‐
35       dex-name.  The version is the system version to be upgraded.  The index
36       is the script execution order.  The name is the scriptlet name.
37
38
39       During upgrade, the scriptlets will back up all changes to the filesys‐
40       tem  into  /var/log/pki/upgrade/version/index.   The  version and index
41       values indicate the scriptlet being executed.  A copy of the files  and
42       folders  that are being modified or removed will be stored in oldfiles.
43       The names of the newly-added files and folders will be stored  in  new‐
44       files.
45
46
47       The  system  upgrade  process  is tracked in /etc/pki/pki.version.  The
48       file stores the current configuration version and the  last  successful
49       scriptlet index.
50
51

OPTIONS

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

OPERATIONS

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

FILES

173       /usr/sbin/pki-upgrade
174
175

AUTHORS

177       Ade Lee  &lt;alee@redhat.com&gt;,  Ella  Deon  Lackey  &lt;dlackey@red‐
178       hat.com&gt;, and Endi S. Dewata &lt;edewata@redhat.com&gt;.
179
180

COPYRIGHT

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