ForgeOps

Upgrade the platform from version 7.3 to 7.4

If you’ve already installed ForgeRock Identity Platform version 7.3 using artifacts from the forgeops repository, follow the steps provided on this page to upgrade to version 7.4.

Use these steps to upgrade the platform in place.

This upgrade methodology has been tested against a deployment based on ForgeRock’s evaluation-only Docker images with basic configuration settings.

Because the ForgeRock Identity Platform is highly customizable, it is difficult for ForgeRock to test all possible upgrade scenarios. 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 the platform from version 7.3 to 7.4, you’ll need:

  • A running version 7.3 CDK deployment with your current AM and IDM configurations

  • A running version 7.3 CDM deployment

  • A forgeops repository clone with a branch that contains 7.3 artifacts

  • A forgeops repository clone with a branch that contains 7.4 artifacts

Example commands in the steps on this page assume:

  • 7.3-profile is the name of the 7.3 configuration profile.

  • Your 7.3 CDM deployment is a small cluster.

  • Your 7.3 CDM deployment does not include IG.

When you perform the upgrade:

  • Choose a different name for the configuration profile, if you prefer.

  • Specify a different cluster size, if applicable.

  • Add commands to upgrade IG, if applicable.

Subscribe to release note updates

Get updates from ForgeRock when there are changes to ForgeOps 7.4.

For more information about getting notifications or subscribing to the ForgeOps 7.4 RSS feed, refer to ForgeOps 7.4 release notes.

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 to upgrade, you may not be able to roll back directory data easily because the data is upgraded in place. If you need to roll back directory data, you’ll have to redeploy DS and restore directory data from a backup.

Consider backing up directory data on volume snapshots for a simpler restore scenario.

Export the version 7.3 AM and IDM configurations

  1. Locate a branch of your forgeops repository clone that contains version 7.3 artifacts and check out the branch.

  2. (Optional) Check out a new branch based on the branch that contains version 7.3 artifacts.

  3. Locate a namespace running version 7.3 of the CDK that contains your current AM and IDM configurations.

  4. Export the AM and IDM configurations from the running 7.3 CDK deployment:

    $ cd /path/to/forgeops
$ ./bin/config export am 7.3-profile --sort 
$ ./bin/config export idm 7.3-profile --sort

  5. Run the git add . and git commit commands.

Upgrade the exported configuration profiles to version 7.4

  1. Locate the branch of your forgeops repository clone that contains version 7.4 artifacts and check out the branch.

    The latest branch with 7.4 artifacts is the release/7.4-20240805 branch.

  2. (Optional) Check out a new branch based on the branch that contains version 7.4 artifacts.

  3. Copy the configuration profiles you exported from your 7.3 CDK into the 7.4 branch:

    • Copy the AM 7.3 configuration profile into the /path/to/forgeops/docker/am/config-profiles directory.

    • Copy the IDM 7.3 configuration profile into the /path/to/forgeops/docker/idm/config-profiles directory.

  4. Upgrade the AM configuration in the 7.4 branch.

    Run the am-config-upgrader utility:

    $ cd /path/to/forgeops
$ ./bin/am-config-upgrader docker/am/config-profiles/7.3-profile

  5. Upgrade the IDM configuration in the 7.4 branch.

    Follow the steps in Migrate your configuration in the IDM documentation.

  6. Run the git add . and git commit commands.

Upgrade the 7.3 pods to 7.4 and build custom 7.4 Docker images

  1. Set your Kubernetes context so that you can access the cluster on which you deployed the version 7.3 CDM.

  2. Check out the branch of your forgeops repository clone that contains version 7.4 artifacts.

  3. (Optional) If you want to continue using the deprecated DS operator, skip this step.

    Remove the deprecated DS operator from your CDM deployment:

    $ kubectl delete --ignore-not-found=true \
-f https://github.com/ForgeRock/ds-operator/releases/latest/download/ds-operator.yaml

    After you remove the DS operator:

    • The DS patch file names will be different after migrating from the DS Operator. For example, from ds-idrepo-op.yaml in 7.3 version with the DS operator to ds-idrepo.yaml in 7.4 version without the DS operator.

    • Your deployment is not available until after you upgrade the ds-idrepo and ds-cts pods in the next two steps.

    • Do not remove the DS operator from your CDM deployment if you need the deployment to remain continuously up and running.

  4. Upgrade the ds-cts pods from 7.3 to 7.4:

    $ cd /path/to/forgeops
$ ./bin/forgeops install ds-cts --small

    This command updates one ds-cts pod at a time. Run the kubectl get pods --watch command to observe the pod upgrades.

    After all the ds-cts pods have been upgraded, run the ds-debug.sh command to verify that directory replication is working correctly. Run commands similar to the following for each ds-cts pod:

    $ ./bin/ds-debug.sh rstatus podname

  5. Upgrade the ds-idrepo pods from 7.3 to 7.4:

    $ cd /path/to/forgeops
$ ./bin/forgeops install ds-idrepo --small

    This command updates one ds-idrepo pod at a time. Run the kubectl get pods --watch command to observe the pod upgrades.

    After all the ds-idrepo pods have been upgraded, run the ds-debug.sh command to verify that directory replication is working correctly. Run commands similar to the following for each ds-idrepo pod:

    $ ./bin/ds-debug.sh rstatus podname

  6. Check out the branch of your forgeops repository clone that contains version 7.4 artifacts.

    This branch should contain the 7.3-profile configuration profile you upgraded to work with version 7.4.

  7. Build Docker images for version 7.4 that contain the 7.3-profile configuration profile:

    $ cd /path/to/forgeops
$ ./bin/forgeops build am --config-profile 7.3-profile --push-to my-repo
$ ./bin/forgeops build idm --config-profile 7.3-profile --push-to my-repo

    The newly-built Docker images are based on ForgeRock’s evaluation-only Docker images.

  8. Upgrade the ForgeRock Identity Platform pods from 7.3 to 7.4:

    $ ./bin/forgeops install ui --small
$ ./bin/forgeops install am --small
$ ./bin/forgeops install idm --small

    Wait for the pod upgrades to complete. Run the kubectl get pods --watch command to observe the pod upgrades.

  9. Start the AM and IDM admin UIs in your upgraded CDM deployment. Verify that:

    • The start page for each admin UI indicates the component version is 7.4, not 7.3.

    • AM and IDM use your custom configuration.

  10. If you are using a Kubernetes-based ForgeRock Identity Platform deployment in production, you must rebuild base Docker images for version 7.4, and then build custom Docker images based on those images:

    1. Build your own Docker base images. Refer to Your own base Docker images for more information.

    2. Rebuild your custom Docker images, basing them on the images you built in the previous step. Refer to Create Docker images for use in production for more information.