Upgrading OpenPages from Version 5.3 to Version 5.4

Information you need to complete this task

Review the following information before you upgrade OpenPages:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is at Version 5.4.0, you must upgrade OpenPages to Version 5.4.0.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

• If you don't have the script that defines the environment variables, see Setting up installation environment variables.
• To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:

  source ./cpd_vars.sh

Before you begin

This task assumes that the following prerequisites are met:

System requirements

This task assumes that the cluster meets the minimum requirements for OpenPages.

Where to find more information
If this task is not complete, see System requirements.

Workstation

This task assumes that the workstation from which you will run the upgrade is set up as a client workstation and has the following command-line interfaces:

• IBM Software Hub CLI: cpd-cli
• OpenShift® CLI: oc
• Helm CLI: helm

Where to find more information
If this task is not complete, see Updating client workstations.

Control plane

This task assumes that the IBM Software Hub control plane is upgraded.

Where to find more information
If this task is not complete, see Upgrading an instance of IBM Software Hub.

Private container registry

If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:

1. The OpenPages software images are mirrored to the private container registry.

   Where to find more information
   If this task is not complete, see Mirroring images to a private container registry.

2. The cpd-cli is configured to pull the olm-utils-v4 image from the private container registry.

   Where to find more information
   If this task is not complete, see Pulling the olm-utils-v4 image from the private container registry.

Cluster-scoped resources

This task assumes that the cluster-scoped resources, such as custom resource definitions, cluster roles, and cluster role bindings, were updated.

Where to find more information
If this task is not complete, see Updating the cluster-scoped resources for the platform and services.

Procedure

Complete the following tasks to upgrade OpenPages:

1. Upgrading the service
2. Validating the upgrade
3. Upgrading existing service instances
4. What to do next

Upgrading the service

To upgrade OpenPages:

1. Log the cpd-cli in to the Red Hat® OpenShift Container Platform cluster:

   ${CPDM_OC_LOGIN}

   Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
2. Update the operator and custom resource for OpenPages.

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=openpages \
   --release=${VERSION} \
   --patch_id=${PATCH_ID} \
   --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --image_pull_prefix=${IMAGE_PULL_PREFIX} \
   --image_pull_secret=${IMAGE_PULL_SECRET} \
   --upgrade=true

--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}

Validating the upgrade

[SUCCESS]... The install-components command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=openpages

Upgrading existing service instances

After you upgrade OpenPages, you must upgrade any service instances that are associated with OpenPages.

When you upgrade an OpenPages instance, it shuts down and then restarts. This can take approximately 2 hours during which it is unavailable to users. Perform the instance upgrade when users are not logged in.

When you upgrade an OpenPages instance that uses an internal database, the Db2 as a service CR is upgraded to the latest version.

Before you begin

Create a profile on the workstation from which you will upgrade the service instances.

The profile must be associated with a IBM Software Hub user who has either the following permissions:

• Create service instances (can_provision)
• Manage service instances (manage_service_instances)

For more information, see Creating a profile to use the cpd-cli management commands.

Procedure

To upgrade the service instances:

1. Get the list of OpenPages service instances:

   cpd-cli service-instance list \
   --service-type=openpages \
   --profile=${CPD_PROFILE_NAME}

2. Set the INSTANCE_NAME environment variable to the name of the service instance that you want to upgrade:

   export INSTANCE_NAME="<instance-name>"

3. Run the following command to check whether your OpenPages service instances is in running state:

   cpd-cli service-instance status ${INSTANCE_NAME} \ 
   --profile=${CPD_PROFILE_NAME} \ 
   --service-type=openpages

4. Upgrade the service instance:

   cpd-cli service-instance upgrade \
   --service-type=openpages \
   --instance-name=${INSTANCE_NAME} \
   --force-version-upgrade=true \
   --profile=${CPD_PROFILE_NAME}

5. Repeat the preceding steps to upgrade each service instance associated with this instance of IBM Software Hub.

What to do next

If you have not enabled Global Search yet, follow the steps in Enabling Global Search. Then complete the task in Importing reports and generating the framework.

After you complete the preceding steps, OpenPages is ready to use. For next steps, see Post-installation setup for OpenPages.