ForgeOps

Upgrade the platform product Docker images to a new major or minor version

If you’ve performed ForgeOps deployment using the older AM, IDM, and DS Docker images, you should upgrade your ForgeOps deployment to use the newer version of platform product Docker images.

Using this procedure, you can upgrade all the platform product Docker images sequentially, one at a time.

This upgrade methodology has been tested against a deployment based on ForgeOps-provided Docker images with basic configuration settings.

Because the Ping Identity Platform is highly customizable, testing all possible upgrade scenarios is challenging. It is your responsibility to validate that these upgrade steps work correctly in a test environment with your customized configuration before you upgrade a production environment.

Prerequisites and assumptions

To upgrade platform products in a ForgeOps deployment to a newer release, you’ll need:

  • A forgeops repository clone of ForgeOps 2025.1.0 release tag or later.

  • A running ForgeOps deployment environment, which has been configured using the forgeops env command.

Example commands in the steps on this page assume that your ForgeOps deployment:

  • Is using the default configuration.

  • Doesn’t include PingGateway.

Back up critical data

Before upgrading, back up all critical data, including:

  • Directory data stored in the ds-idrepo and ds-cts backends

  • AM and IDM configuration data

  • Customized artifacts in your forgeops repository clone

After you’ve started upgrading, you might not be able to roll back directory data easily because the data is upgraded in place. To roll back directory data, you must redeploy DS and restore directory data. Consider backing up directory data on volume snapshots for a simpler restore scenario.

Get ready to upgrade

  1. Set your Kubernetes context to the cluster running your ForgeOps deployment.

  2. View the list of supported product versions:

    $ cd /path/to/forgeops
$ ./bin/forgeops info --list-releases

Upgrade the platform product images to a new major or minor version

Amster and AM images need to be on the same version. So if you’re upgrading AM, carry out the same steps to upgrade Amster.

  1. Create a new release file for all the platform products. In the forgeops image command, specify:

    • The new product version in the --release flag, such as 7.5.1.

    • The platform option to apply the product version to the whole platform.

      $ cd /path/to/forgeops
$ ./bin/forgeops image --release 7.5.1 --release-name my-custom-release platform

  2. Upgrade your custom AM configuration profile to the new version:

    Use the --release-name option to ensure you use the version of the upgrade-am-config that matches your deployment.

    		 
    $ cd /path/to/forgeops
$ ./bin/forgeops upgrade-am-config --release-name my-custom-release \
 --config-profile docker/am/config-profiles/my-config-profile

  3. Build new custom images for all platform products:

    $ cd /path/to/forgeops
$ ./bin/forgeops build platform --env-name my-custom-env \
  --release-name my-custom-release \
  --config-profile docker/am/config-profiles/my-config-profile

  4. Deploy your updated images for all platform products:

    In a Kustomize environment 
    $ cd /path/to/forgeops
$ ./bin/forgeops apply --env-name my-custom-env platform
    In a Helm environment 
    $ cd /path/to/forgeops/charts/identity-platform
$ helm upgrade --install identity-platform ./ \
 --values /path/to/forgeops/helm/my-env/values.yaml

Upgrade the platform UIs to a new version

This section refers to an upgrade to the platform UIs only.

You don’t need to build new Docker images when you upgrade Platform UIs.

  1. Update your environment to the new version. Specify the new version in the --release flag:

    $ cd /path/to/forgeops
$ ./bin/forgeops image --release 8.0.0 ui --env-name my-custom-env

  2. Deploy your updated version (Kustomize only)

    $ cd /path/to/forgeops
$ ./bin/forgeops apply --env-name my-custom-env ui