Upgrading OpenIAM from versions 4.2.1.x to 4.2.2 in RPM

The upgrading process to the newest OpenIAM version of 4.2.2 is straightforward. The steps below detail the prerequisite steps for upgrading to OpenIAM 4.2.2 for both single-node and HA-based RPM clusters.

Pre-upgrade prerequisites

  1. Make sure to backup the VM.
    • Take a full snapshot of all three Linux VMs.
    • Take a full snapshot/backup of the OpenIAM and Activiti databases from the external database instance.
  2. Observe the Firewall / Network requirements, as given in the table below.
HostPortDescription
OpenIAM cluster nodes8500/TCP, 8503/TCP, 8301/TCP, 8301/UDP, 8301/TCP, 8302/UDP, 8300/TCP, 8600/TCP, 8600/UDPThe following ports must be open between Consul agents (server/client) and other services.
8081(http)IDP port
8082(http)WEBCONSOLE_PORT
8083(http)SELFSERVICE_PORT
8084(http)SELFSERVICE_EXT_PORT
8085(http)REPORTVIEWER_PORT
8086(http)UI_STATIC_PORT
8087(http)Harproxy.
  1. Access requirements
    • Admin-privileged credentials are required for all three Linux servers participating in the HA setup.
    • Admin-privileged credentials are also required for the external database instance.
  2. Database preparation
    • Create the Groovy initialization script on the database instance.
    • This script will be shared by OpenIAM as per database type prior to the upgrade.
Note: Depending on the type of database, the SQL script will be provided from OpenIAM side in the upgrade ticket.
  1. Disk space requirement
    • Approximately 50 GB of free disk space should be available.
    • This must be verified based on the current utilization of the /root partition.

Upgrading scenarios

Internet-based upgrade

To upgrade OpenIAM from 4.2.1.x to 4.2.2 with internet access, use the following command.

curl https://download.openiam.com/release/enterprise/infra/upgrade.sh --output /usr/src/upgrade.sh

Non-internet-based upgrade

To upgrade OpenIAM from 4.2.1.x to 4.2.2 without internet access follow the steps below.

  1. Download below files and keep it in /usr/src in Linux server and prepare the upgrade script as follows.
curl https://download.openiam.com/release/enterprise/infra/upgrade.sh --output /usr/src/upgrade.sh
chmod +x /usr/src/upgrade.sh
cp /usr/src/upgrade.sh /usr/local/openiam/utils/
  1. Download required artifacts with the following commands.
curl https://download.openiam.com/release/enterprise/infra/elasticdump-offlines.tar.gz --output /usr/src/elasticdump-offlines.tar.gz

For EL9.

curl https://download.openiam.com/release/enterprise/4.2.2/rpm/openiam-4.2.2.noarch.x86_64.rpm --output /usr/src/openiam-4.2.2.noarch.x86_64.rpm
curl https://download.openiam.com/release/enterprise/4.2.2/dependencies/el9/openiamrepo.tar.gz --output /usr/src/openiamrepo.tar.gz
curl https://download.openiam.com/release/enterprise/4.2.2/binaries/frontend.tar.gz --output /usr/src/frontend.tar.gz
curl https://download.openiam.com/release/enterprise/4.2.2/binaries/backend.tar.gz --output /usr/src/backend.tar.gz

For EL8

curl https://download.openiam.com/release/enterprise/4.2.2/rpm/openiam-4.2.2.noarch.x86_64.rpm --output /usr/src/openiam-4.2.2.noarch.x86_64.rpm
curl https://download.openiam.com/release/enterprise/4.2.2/dependencies/el8/openiamrepo.tar.gz --output /usr/src/openiamrepo.tar.gz
curl https://download.openiam.com/release/enterprise/4.2.2/binaries/frontend.tar.gz --output /usr/src/frontend.tar.gz
curl https://download.openiam.com/release/enterprise/4.2.2/binaries/backend.tar.gz --output /usr/src/backend.tar.gz

Once all prerequisites are completed, start the upgrade using the command below:

openiam-cli upgrade