Upgrading OpenPages from version 4.0.5 and later 4.0.x

A project administrator can upgrade OpenPages from version 4.0.5 or later 4.0.x to version 4.6.

Important: To complete this task, you must be running OpenPages Version 8.204.2 or later. (Version 8.204.2 was released with Refresh 5 of Cloud Pak for Data Version 4.0.)

You can upgrade from Version 4.0 to Versions 4.6.0 - 4.6.2 only.

You cannot upgrade from Version 4.0 to Version 4.6.3 or later. You must upgrade to 4.6.2 before you upgrade to 4.6.3 or later.

What permissions do you need to complete this task?
The permissions that you need depend on which tasks you must complete:
  • To update the OpenPages operators, you must have the appropriate permissions to create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
  • To upgrade OpenPages, you must be an administrator of the project where OpenPages is installed. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

    If any instances of OpenPages are in tethered projects, you must be an administrator of the tethered projects.

When do you need to complete this task?
If you didn't upgrade OpenPages when you upgraded the platform, you can complete this task to upgrade your existing OpenPages installation.

If you want to upgrade all of the Cloud Pak for Data components at the same time, follow the process in Upgrading the platform and services instead.

Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.

Information you need to complete this task

Review the following information before you upgrade OpenPages:

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:
    source ./cpd_vars.sh
Installation location
OpenPages is installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

Instances of OpenPages might be in projects that are tethered to the control plane.

Storage requirements
You don't need to specify storage when you upgrade OpenPages.

Before you begin

Prerequisite Where to find more information
The cluster meets the minimum requirements for OpenPages. If this task is not complete, see System requirements.
The workstation from which you will run the upgrade is set up as a client workstation and includes the following command-line interfaces:
  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift® CLI: oc
 If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is upgraded. If this task is not complete, see Upgrading the platform and services.
For environments that use a private container registry, such as air-gapped environments, the OpenPages software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.
Back up your OpenPages instances. For more information, see Backing up, restoring, and migrating OpenPages.
If you are using Cognos® Analytics, uninstall Cognos Analytics 4.0.x and install Cognos Analytics 4.6 and provision an instance.
  1. Disable the integration between Cognos Analytics and OpenPages.
  2. Uninstall Cognos Analytics 4.0.x.
  3. Install Cognos Analytics 4.6 and provision an instance.

    For more information, see Upgrading Cognos Analytics.

Procedure

Complete the following tasks to upgrade OpenPages:

  1. Logging in to the cluster
  2. Updating the operator
  3. Upgrading the service
  4. Validating the upgrade
  5. Upgrading OpenPages instances
  6. What to do next

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

  1. Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
    cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
    Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.

Updating the operator

The OpenPages operator simplifies the process of managing the OpenPages service on Red Hat® OpenShift Container Platform.

To upgrade OpenPages, ensure that all of the Operator Lifecycle Manager (OLM) objects in the ${PROJECT_CPD_OPS} project, such as the catalog sources and subscriptions, are upgraded to the appropriate release. All of the OLM objects must be at the same release.

Who needs to complete this task?
You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.
When do you need to complete this task?
Complete this task only if the OLM artifacts have not been updated for the current release using the cpd-cli manage apply-olm command with the --upgrade=true option.

It is not necessary to run this command multiple times for each service that you plan to upgrade. If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli will recreate the OLM objects for all of the existing components in the ${PROJECT_CPD_OPS} project.

To update the operator:

  1. Update the OLM objects:
    cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--upgrade=true
    • If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
    • If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Upgrade the OpenPages service.

Upgrading the service

After the OpenPages operator is updated, you can upgrade OpenPages.

Who needs to complete this task?
You must be an administrator of the project where OpenPages is installed.
When do you need to complete this task?
Complete this task for each instance of OpenPages that is associated with an instance of Cloud Pak for Data Version 4.6.

To upgrade the service:

  1. Update the custom resource for OpenPages.
    cpd-cli manage apply-cr \
--components=openpages \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

OpenPages is upgraded when the apply-cr command returns [SUCCESS]... The apply-cr command ran successfully.

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

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

Upgrading OpenPages instances

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

To upgrade OpenPages instances:
  1. Log in to Red Hat OpenShift Container Platform as a user with sufficient permissions to complete the task:
    oc login OpenShift_URL:port
  2. Change to the project where OpenPages is installed. Use the following command where <project> is ${PROJECT_CPD_INSTANCE} when the instance exists in the CP4D control plane namespace, or ${PROJECT_TETHERED} when the OpenPages instance is installed in a tethered namespace.
    oc project project
  3. Verify the status of the OpenPages instance by running the following command:
    oc get OpenPagesInstance instance-name -o jsonpath='{.status.openpagesStatus} {"\n"}'

    OpenPages is ready when the command returns Completed.

  4. Edit the OpenPages instance custom resource:
    oc edit OpenPagesInstance instance-name
  5. Update version with the version of the OpenPages operand, for example version: "8.302.1".
  6. If you are using Cognos Analytics with OpenPages, verify that a Cognos Analytics instance is running, and then enable the integration. 
    enableIntegrationWithCognos: true
  7. Verify the upgrade by running the following command:
    oc get OpenPagesInstance instance-name -o jsonpath='{.status.openpagesStatus} {"\n"}'
  8. Update Db2® settings. See Updating Db2 instance settings.
  9. Repeat these steps for each OpenPages instance.

What to do next

Complete the following post-upgrade tasks before users access OpenPages: