Upgrade
Web Agents Documentation supports the following types of upgrade:
-
Usually, an update from a version of Web Agents Documentation to a newer minor version, as defined in Ping Identity Product Support Lifecycle Policy | PingGateway and Agents. For example, update from 2023.9 to 2023.11 can be a drop-in software update.
Drop-in software updates can introduce additional functionality and fix bugs or security issues. Consider the following restrictions for drop-in software updates:
-
Don’t require any update to the configuration
-
Can’t cause feature regression
-
Can change default or previously configured behavior only for bug fixes and security issues
-
Can deprecate but not remove existing functionality
-
-
Usually, an upgrade from a version of Web Agents Documentation to a newer major version, as defined in Ping Identity Product Support Lifecycle Policy | PingGateway and Agents. For example, upgrade from 2023.3 to 2024.3 is a major upgrade.
Major upgrades can introduce additional functionality and fix bugs or security issues. Major upgrades do not have the restrictions of drop-in software update. Consider the following features of major upgrades:
-
Can require code or configuration changes
-
Can cause feature regression
-
Can change default or previously configured behavior
-
Can deprecate and remove existing functionality
-
This guide describes how to upgrade a single ForgeRock Access Management Web Agents Documentation instance. To upgrade sites with multiple Web Agents Documentation instances, one by one, stop, upgrade, and then restart each server individually, leaving the service running during the upgrade.
For information about upgrade between supported versions of Web Agents Documentation, refer to Ping Identity Product Support Lifecycle Policy | PingGateway and Agents.
Example installation for this guide
Unless otherwise stated, the examples in this guide assume the following installation:
-
Web Agents Documentation installed on
http://agent.example.com:80. -
Access Management installed on
http://am.example.com:8088/am. -
Work in the top-level realm
/.
If you use a different configuration, substitute in the procedures accordingly.