PingAccess

Upgrading a PingAccess cluster using the incremental update package

Upgrade a PingAccess cluster to a newer version using the incremental update package.

Use the PingAccess incremental update bundle to upgrade from your current environment version (the source version) to a more recent maintenance release for that version of PingAccess (the target version). For example, use the bundle to upgrade PingAccess 6.3 to the most recent maintenance release for 6.3.

The upgrade procedure causes some downtime. To upgrade a cluster with no downtime, use the Zero Downtime Upgrade guide.

Before you begin

  • Make a backup copy of the PingAccess home directory. If the upgrade fails, restore your environment from this backup.

  • Review the release notes for every version between the source and target version.

  • Verify the following:

    • Basic authentication is configured and enabled for the admin API of the source PingAccess instance.

      You might need to enable basic authentication if you have limited access permissions to OAuth because of your configured role. Learn more in Configuring API authentication.

    • Each node is using the same PingAccess version.

      You can check the version by viewing the <PA_HOME>/lib/pingaccess-admin-ui-<version_number>.jar file.

    • The PingAccess administrative node is running.

    • You have the incremental update .zip file for the target version of PingAccess.

Steps

  1. Upgrade the administrative node:

    1. Extract the .zip archive for the target version of PingAccess.

    2. Open the readme file included in the extracted .zip archive.

    3. Make the file changes specified in the readme file.

  2. Upgrade the replica administrative node:

    1. Extract the .zip archive for the target version of PingAccess.

    2. Open the readme file included in the extracted .zip archive.

    3. Make the file changes specified in the readme file.

  3. Upgrade each engine node:

    1. Extract the .zip archive for the target version of PingAccess.

    2. Open the readme file included in the extracted .zip archive.

    3. Make the file changes specified in the readme file.

  4. Shut down the entire cluster.

  5. Start the upgraded administrative node.

  6. Start the upgraded replica administrative node.

  7. Start each upgraded engine node.

Next steps

Review Performing post-upgrade tasks.