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

NAME

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

SYNOPSIS

10       pki-server [CLI-options] upgrade [OPTIONS]
11
12

DESCRIPTION

14       There  are two parts to upgrading PKI server: 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  server,  the  existing server configuration files
20       (e.g. server.xml, web.xml) 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-server upgrade.
25
26
27       The  server  upgrade  process  is  done  incrementally  using   upgrade
28       scriptlets.   A  server  consists of the server instance itself and the
29       subsystems running in that instance.  The upgrade process executes  one
30       scriptlet  at  a  time, running through each component (server instance
31       and subsystem) in parallel and completing  before  executing  the  next
32       scriptlet.   If  one  component  encounters an error, that component is
33       skipped in the subsequent upgrade scriptlets.  The upgrade process  and
34       scriptlet  execution  for each component is monitored in upgrade track‐
35       ers.  A counter shows the latest index number  for  the  most  recently
36       executed scriptlet; when all scriptlets have run, the component tracker
37       shows the updated version number.
38
39
40       The scriptlets are stored in the upgrade directory:
41
42
43              /usr/share/pki/server/upgrade/<version>/<index>-<name>
44
45
46
47       The version is the server version to be  upgraded.  The  index  is  the
48       script execution order.  The name is the scriptlet name.
49
50
51       During  upgrade,  the  scriptlets  will back up all changes to the file
52       system into the following folder:
53
54
55              /var/log/pki/server/upgrade/<version>/<index>
56
57
58
59       The version and index values indicate the scriptlet being executed.   A
60       copy  of  the files and folders that are being modified or removed will
61       be stored in oldfiles.  The names of the newly-added files and  folders
62       will be stored in newfiles.
63
64
65       The instance upgrade process is tracked using this file:
66
67
68              /var/lib/pki/<instance>/conf/tomcat.conf
69
70
71
72       The subsystem upgrade process is tracked using this file:
73
74
75              /var/lib/pki/<instance>/<subsystem>/conf/CS.cfg
76
77
78
79       The file stores the current configuration version and the last success‐
80       ful scriptlet index.
81
82

OPTIONS

84   General options
85       --status
86           Show upgrade status only without performing the upgrade.
87
88
89       --revert
90           Revert the last version.
91
92
93       -i, --instance instance
94           Upgrade a specific instance only.
95
96
97       -X
98           Show advanced options.
99
100
101       -v, --verbose
102           Run in verbose mode.
103
104
105       -h, --help
106           Show this help message.
107
108
109   Advanced options
110       The advanced options circumvent the normal upgrade process by  changing
111       the tracker information.
112
113
114       WARNING: These options may render the system unusable.
115
116
117       --remove-tracker
118           Remove the tracker.
119
120
121       --reset-tracker
122           Reset the tracker to match the package version.
123
124
125       --set-tracker version
126           Set the tracker to a specific version.
127
128

OPERATIONS

130   Upgrade process
131       To start the upgrade process:
132
133
134              $ pki-server upgrade
135
136
137
138   Upgrade status
139       To check the upgrade status:
140
141
142              $ pki-server upgrade --status
143
144
145
146   Troubleshooting
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-server upgrade.
150
151
152       If necessary, the upgrade can be run in verbose mode:
153
154
155              $ pki-server upgrade --verbose
156
157
158
159       It is possible to rerun a failed upgrade for a specific instance:
160
161
162              $ pki-server upgrade --instance pki-tomcat
163
164
165
166   Reverting an upgrade
167       If necessary, the upgrade can be reverted:
168
169
170              $ pki-server upgrade --revert
171
172
173
174       Files  and  folders that were created by the scriptlet will be removed.
175       Files and folders that were modified or removed by the  scriptlet  will
176       be restored.
177
178

AUTHORS

180       Ade   Lee   lt;alee@redhat.comgt;,  Ella  Deon  Lackey  lt;dlackey@red‐
181       hat.comgt;, and Endi S. Dewata lt;edewata@redhat.comgt;.
182
183

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