.nh
.TH pki-upgrade 8 "Jul 22, 2013" PKI "PKI Upgrade Tool"
.SH NAME
.PP
pki-upgrade - Tool for upgrading system-wide PKI configuration.

.SH SYNOPSIS
.PP
\fBpki-upgrade\fP [\fIOPTIONS\fP]

.SH DESCRIPTION
.PP
There are two parts to upgrading PKI system: upgrading the system configuration files used by both the client
and the server processes and upgrading the server configuration files.

.PP
When upgrading PKI system, the existing system configuration files (e.g. /etc/pki/pki.conf)
may need to be upgraded because the content may have changed from one version to another.
The configuration upgrade is executed automatically during RPM upgrade.
However, in case there is a problem, the process can also be run manually using \fBpki-upgrade\fP\&.

.PP
The system upgrade process is done incrementally using upgrade scriptlets.
The upgrade process and scriptlet execution is monitored in upgrade trackers.
A counter shows the latest index number for the most recently executed scriptlet;
when all scriptlets have run, the component tracker shows the updated version number.

.PP
The upgrade scriptlets are stored in /usr/share/pki/upgrade/\fIversion\fP/\fIindex\fP-\fIname\fP\&.
The \fIversion\fP is the system version to be upgraded.
The \fIindex\fP is the script execution order.
The \fIname\fP is the scriptlet name.

.PP
During upgrade, the scriptlets will back up all changes to the filesystem into /var/log/pki/upgrade/\fIversion\fP/\fIindex\fP\&.
The \fIversion\fP and \fIindex\fP values indicate the scriptlet being executed.
A copy of the files and folders that are being modified or removed will be stored in \fBoldfiles\fP\&.
The names of the newly-added files and folders will be stored in \fBnewfiles\fP\&.

.PP
The system upgrade process is tracked in /etc/pki/pki.version.
The file stores the current configuration version and the last successful scriptlet index.

.SH OPTIONS
.SS General options
.PP
\fB--silent\fP
.br
    Upgrade in silent mode.

.PP
\fB--status\fP
.br
    Show upgrade status only \fBwithout\fP performing the upgrade.

.PP
\fB--revert\fP
.br
    Revert the last version.

.PP
\fB-X\fP
.br
    Show advanced options.

.PP
\fB-v\fP, \fB--verbose\fP
.br
    Run in verbose mode.

.PP
\fB-h\fP, \fB--help\fP
.br
    Show this help message.

.SS Advanced options
.PP
The advanced options circumvent the normal component tracking process by changing the
scriptlet order or changing the tracker information.

.PP
\fBWARNING:\fP These options may render the system unusable.

.PP
\fB--scriptlet-version\fP \fIversion\fP
.br
    Run scriptlets for a specific version only.

.PP
\fB--scriptlet-index\fP \fIindex\fP
.br
    Run a specific scriptlet only.

.PP
\fB--remove-tracker\fP
.br
    Remove the tracker.

.PP
\fB--reset-tracker\fP
.br
    Reset the tracker to match the package version.

.PP
\fB--set-tracker\fP \fIversion\fP
.br
    Set the tracker to a specific version.

.SH OPERATIONS
.SS Interactive mode
.PP
By default, \fBpki-upgrade\fP will run interactively.
It will ask for a confirmation before executing each scriptlet.

.PP
.RS

.nf
$ pki-upgrade

.fi
.RE

.PP
If there is an error, it will stop and show the error.

.SS Silent mode
.PP
The upgrade process can also be done silently without user interaction:

.PP
.RS

.nf
$ pki-upgrade --silent

.fi
.RE

.PP
If there is an error, it will stop and show the error.

.SS Checking upgrade status
.PP
It is possible to check the status of a running upgrade process.

.PP
.RS

.nf
$ pki-upgrade --status

.fi
.RE

.SS Troubleshooting
.PP
If there is an error, rerun the upgrade in verbose mode:

.PP
.RS

.nf
$ pki-upgrade --verbose

.fi
.RE

.PP
Check the scriptlet to see which operations are being executed.
Once the error is identified and corrected, the upgrade can be resumed by re-running \fBpki-upgrade\fP\&.

.PP
It is possible to rerun a failed script by itself, specifying the instance and subsystem,
version, and scriptlet index:

.PP
.RS

.nf
$ pki-upgrade --scriptlet-version 10.0.1 --scriptlet-index 1

.fi
.RE

.SS Reverting an upgrade
.PP
If necessary, the upgrade can be reverted:

.PP
.RS

.nf
$ pki-upgrade --revert

.fi
.RE

.PP
Files and folders that were created by the scriptlet will be removed.
Files and folders that were modified or removed by the scriptlet will be restored.

.SH FILES
.PP
/usr/sbin/pki-upgrade

.SH AUTHORS
.PP
Ade Lee <alee@redhat.com>, Ella Deon Lackey <dlackey@redhat.com>, and Endi S. Dewata <edewata@redhat.com>\&.

.SH COPYRIGHT
.PP
Copyright (c) 2013 Red Hat, Inc.
This is licensed under the GNU General Public License, version 2 (GPLv2).
A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.