How to upgrade AM instance with File Based Configuration (FBC)

Setup
, , , , ,
1

Overview

File-based configuration FBC was introduced in AM 7.5.0 and will be officially documented in AM 8.0.0 onwards.

If you have an on-prem AM env using (FBC) or are using custom docker images with CI/CD pipeline, this article outlines the recommended process for performing a file-based configuration upgrade.

Requirements

• If you have an on-prem AM instance, we will shut down AM, upgrade the configuration, and then deploy the new version of AM.

• You must download the AM distribution kits for AM 7.5 if you use custom docker images.

Important: Always use the configuration upgrader corresponding to the version you are upgrading to.

Upgrading an On-Prem Instance from AM 7.3 to AM 7.5

The following example assumes you are upgrading an on prem instance from AM 7.3 to AM 7.5

Step 1: Download and Extract AM version 7.5

  1. Download AM-7.5.0.zip and extract it to access the necessary files:
$unzip -j AM-7.5.0.zip "openam/Config-Upgrader-7.5.0.zip" -d .
unzip Config-Upgrader-7.5.0.zip -d .

Step 2: Shutdown AM 7.3 and Run Configuration Upgrade

  1. Shutdown AM 7.3 Tomcat:
$ mv am/config/services am/config/services-7-3
  1. Run the configuration upgrade
$ amupgrade/amupgrade -i am/config/services-7-3 -o am/config/services --fileBasedMode -v amupgrade/rules/fbc/latest.groovy

Step 3: Deploy AM 7.5 WAR and Start the New Version of AM

Deploy the AM 7.5 WAR file and start the new version of AM with the upgraded file-based configuration:

  1. Use the following command to extract the AM 7.5.0 WAR file, place it in the webapps directory and start the new version of AM:
$ unzip -j AM-7.5.0.zip "openam/AM-7.5.0.war" -d tomcat/webapps && mv tomcat/webapps/AM-7.5.0.war tomcat/webapps/am.war
tomcat/bin/catalina.sh start

Upgrading AM 7.3 to 7.5 with Custom Docker Images

The following example assumes you are building custom Docker images:

Step 1: Download and Extract AM version 7.5

  1. Download AM-7.5.0.zip and extract it to access the necessary files:
$unzip -j AM-7.5.0.zip "openam/Config-Upgrader-7.5.0.zip" -d .
unzip Config-Upgrader-7.5.0.zip -d .

Next, we will run the configuration upgrade from AM 7.3 to AM 7.5.

Step 2: Run the Configuration Upgrade

  • Run the following command to copy the existing services directory from the AM pod and perform the configuration upgrade:
$ kubectl cp am_pod:am/config/services am/config/services-services-7-3
$ amupgrade/amupgrade -i am/config/services-7-3 -o services --fileBasedMode -v amupgrade/rules/fbc/latest.groovy

Step 3: Build the New Docker Image

  • Use the AM 7.5 WAR from the distribution kit and the upgraded services folder from Step 2 to build your new Docker image.

Step 4: Deploy the New AM 7.5 Instance

  • Deploy the new AM 7.5 instance using the newly created Docker image.

Additional References

image PingAM

Documentation

PingAM 7.5.x Downloads

Community