Upgrading OpenIAM in RPM

The OpenIAM platform is constantly evolving to provide more functionality and convenience for users. As a result, new versions are regularly released that require upgrades. Depending on the version, the upgrade process may differ. However, there are several general steps that must be completed prior to the upgrade to ensure a smooth and successful OpenIAM upgrade. The prerequisite steps are described below.

Pre-requisites

As a first step, make sure to open a support case with OpenIAM Support to validate the current environment before proceeding with the upgrade.

Ensure the following utilities are installed on the server:

• wget
• unzip
• tar
• curl

Disk space verification

If OpenIAM is installed under the root (/) directory, verify disk usage for the OpenIAM path with the following command:

du -sh /usr/local/openiam

The general recommendation is to allocate at least 5 GB more than the directory currently consumes. For example, if /usr/local/openiam is consuming 20 GB, ensure that at least 25 GB of free space is available in the / filesystem before proceeding with the upgrade.

Backup requirements

Taking a backup prior to upgrading allows you to perform a quick rollback in the event that the upgrade fails or is unsuccessful. Therefore, it is important to take a full VM snapshot of all three VMs for an HA-based setup. For a single-node cluster, take a snapshot of the single node. If an external database is used, take a full database snapshot before starting the upgrade.

Environment configuration

Before upgrading, environment variables must be configured to ensure that the upgrade scripts and services reference the correct system paths, credentials, and configuration settings required for a successful upgrade. The required variables must be modified in env.conf.

To configure the environment variables, edit the configuration file with the following command:

vi /usr/local/openiam/env.conf

Ensure the following environment variables are set before running the upgrade:

export FLYWAY_ACTIVITI_PORT=
export FLYWAY_ACTIVITI_HOST=
export FLYWAY_OPENIAM_PORT=
export FLYWAY_OPENIAM_HOST=
export FLYWAY_DATABASE_TYPE="" # Possible values: mysql, postgres
UPGRADE_TO_VERSION=

Upgrading

Before executing the upgrade script, make sure that executable permission is provided.

cd /usr/local/openiam/utils/
chmod +x upgrade.sh

Once the permission is granted, run the upgrade:

openiam-cli upgrade

Versions available for upgrading

Currently, OpenIAM offers several upgrade options listed below. Before upgrading, ensure that all prerequisites have been completed.