pki-upgrade(8)

📦
version 11.7.1 · 3 versions
, in centos-stream 9, ubuntu jammy

💖 pki-upgrade(8) — PKI Upgrade Tool 💖

okay bestie, welcome to pki-upgrade(8) — the PKI Upgrade Tool — and yes, it does exactly what it says on the tin: it upgrades system-wide PKI configuration. Let's get into it 💅

🌸 NAME 🌸

pki-upgrade — tool for upgrading system-wide PKI configuration. periodt.

📜 SYNOPSIS 📜

pki-upgrade [OPTIONS]

💅 DESCRIPTION 💅

Okay so upgrading the PKI system has two parts, bestie:

  1. upgrading the system configuration files used by both the client and the server processes, and
  2. upgrading the server configuration files.

When you're upgrading the 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. But if there's a problem, the process can also be run manually using pki-upgrade. lowkey a lifesaver.

The system upgrade process is done incrementally using upgrade scriptlets. The upgrade process and scriptlet execution are 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. it's giving progress-bar energy ✨

The upgrade scriptlets are stored in /usr/share/pki/upgrade/version/index-name.

  • version — the system version to be upgraded.
  • index — the script execution order.
  • name — the scriptlet name.

During upgrade, the scriptlets will back up all changes to the filesystem into /var/log/pki/upgrade/version/index. The version and index values indicate the scriptlet being executed. A copy of the files and folders that are being modified or removed will be stored in oldfiles. The names of the newly-added files and folders will be stored in newfiles. organized. iconic. 🎀

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

🎀 OPTIONS 🎀

🌼 General options 🌼

  • --silent — Upgrade in silent mode. no chatter, just vibes.
  • --status — Show upgrade status only without performing the upgrade. a little peek 👀
  • --revert — Revert the last version.
  • -X — Show advanced options.
  • -v, --verbose — Run in verbose mode. give me all the details, bestie.
  • -h, --help — Show this help message.

🚨 Advanced options 🚨

The advanced options circumvent the normal component tracking process by changing the scriptlet order or changing the tracker information. highkey powerful, so be careful.

⚠️ WARNING: These options may render the system unusable. ⚠️
  • --scriptlet-version version — Run scriptlets for a specific version only.
  • --scriptlet-index index — Run a specific scriptlet only.
  • --remove-tracker — Remove the tracker.
  • --reset-tracker — Reset the tracker to match the package version.
  • --set-tracker version — Set the tracker to a specific version.

🦋 OPERATIONS 🦋

💬 Interactive mode 💬

By default, pki-upgrade will run interactively. It will ask for a confirmation before executing each scriptlet. very "are you sure, bestie?" of it.

$ pki-upgrade

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

🤫 Silent mode 🤫

The upgrade process can also be done silently without user interaction:

$ pki-upgrade --silent

If there is an error, it will stop and show the error. yes, even in silent mode — it's not gonna suffer in silence 😭

🔍 Checking upgrade status 🔍

It is possible to check the status of a running upgrade process. v helpful.

$ pki-upgrade --status

🛠️ Troubleshooting 🛠️

If there is an error, rerun the upgrade in verbose mode:

$ pki-upgrade --verbose

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 pki-upgrade. you got this 🫶

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

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

⏪ Reverting an upgrade ⏪

If necessary, the upgrade can be reverted:

$ pki-upgrade --revert

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. it's giving undo button, but make it filesystem 💅

📁 FILES 📁

  • /usr/sbin/pki-upgrade

👑 AUTHORS 👑

Ade Lee lt;alee@redhat.comgt;, Ella Deon Lackey lt;dlackey@redhat.comgt;, and Endi S. Dewata lt;edewata@redhat.comgt;. absolute icons, all of them 👑

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.

okay bestie, that's the whole page — signed off by PKI, dated Jul 22, 2013, and it's pki-upgrade(8). slay, stay upgraded, and don't touch the advanced options unless you mean it 💖✨

📦 where this page comes from