The PingFederate Upgrade Guide describes how to upgrade your PingFederate environment to the latest version on Windows and Linux systems.
Depending on your PingFederate installation, you can upgrade by using the PingFederate installer for Windows or the Upgrade Utility, which automatically migrates existing PingFederate installations of version 6.0 and later to the latest version. As of PingFederate 10.0, the Upgrade Utility is included with the software distribution rather than being a separate download.
For general information about upgrading Ping Identity products and an upgrade planning guide, see Planning your upgrade.
We recommend that you upgrade your test environment and verify that the new installation meets your expectations before upgrading your production environment. Also thoroughly retest the behavior of any customized components. After you complete the upgrade process, you can create a backup of your previous installation and remove it from the server.
Additionally, end users might experience service disruptions as you upgrade your PingFederate environment. As needed, schedule a maintenance window to perform the upgrade.
Download the latest version of PingFederate from the PingFederate Downloads website.
- To download the PingFederate installer for Windows, click Windows.
- To download the PingFederate product distribution .zip file, click Linux. The distribution .zip file can be used to upgrade PingFederate on both Windows and Linux.
|Operating system||Source version||Source installation medium||Possible upgrade paths|
|Microsoft Windows||8.x through 10.x||PingFederate installer for Windows||PingFederate installer for Windows, or PingFederate Upgrade Utility|
|6.x through 10.x||PingFederate product distribution.zip file||PingFederate Upgrade Utility|
|Linux||6.x through 10.x||PingFederate product distribution .zip file||PingFederate Upgrade Utility|
If you are upgrading from PingFederate 5.3 or earlier, contact Support for more information.
Both the PingFederate installer for Windows and the Upgrade Utility create a new installation based on the new product distribution .zip file, and then copy the relevant files and property values from the existing installation (the source) to the new installation (the target). As a result, neither tool affects the source installation.
Both upgrade tools also copy the program files for the deployed adapters, connectors, and token translators (the integration kits in general) from the source installation to the target installation. While the tools do not upgrade the integration kits automatically, you can download newer versions by visiting the Ping Identity Downloads website and upgrade the integration kits manually. Documentation for integration kits is available on the Ping Identity website.
Prepare for the PingFederate upgrade by:
- Reviewing the PingFederate release notes for enhancements, upgrade considerations, deprecated features, and other known issues and limitations.
- Reviewing the post-upgrade tasks.
- Reviewing potential changes in system and port requirements.
- Obtaining a new license key if needed.
- Updating the Java runtime to version 8 or 11 on your PingFederate servers if needed.
When you upgrade the Java runtime, modify the previously defined paths for the system JAVA_HOME and PATH environment variables.Important:
PingFederate versions prior to 7.2 will not start using the currently supported Java runtime. If you need to start the previous PingFederate version on the same server after the upgrade, retain the older Java installation and change environment variables back when needed.
- Completing any unfinished connections (Drafts) in the administrative console, if you want to include them in the migration.