Upgrading OpenPages from Version 4.8.x to a later 4.8 refresh

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 Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is at Version 4.8.9, you must upgrade OpenPages to Version 4.8.9.

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

Storage requirements

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

Before you begin

This task assumes that the following prerequisites are met:

Procedure

Complete the following tasks to upgrade OpenPages:

1. If you are using the database that is provided with OpenPages, Update the application memory settings for Db2.
2. Upgrading the service
3. Validating the upgrade
4. Upgrading existing service instances
5. What to do next

Update the application memory settings for Db2

Edit the Db2uCluster custom resource to change the Db2 configuration settings appl_memory to "80000 AUTOMATIC" and applheapsz to "51200 AUTOMATIC".

The appl_memory configuration parameter specifies the size of the application memory set.

The applheapsz configuration parameter refers to the total amount of application memory that can be consumed by the entire application.

1. Find the Db2uCluster custom resource that you want to configure and assign it to an environment variable.
   1. Retrieve a list of your Db2uCluster custom resources by running the following command:

      oc get db2ucluster -n ${PROJECT_CPD_INST_OPERANDS}

   2. Extract DB2UCLUSTER_ID from the OpenPages instance:

      DB2UCLUSTER_ID=$(oc get openpagesinstance ${OPENPAGES_INSTANCE_NAME} -n ${PROJECT_CPD_INST_OPERANDS} -o json | jq -r '.spec.zenServiceInstanceId')

2. Run the following command to edit the Db2uCluster custom resource:

   oc edit db2ucluster db2oltp-${DB2UCLUSTER_ID} -n ${PROJECT_CPD_INST_OPERANDS}

3. Make changes to your database configuration parameter settings. To find your database configuration parameters, see the yaml path: spec.environment.database.dbConfig.

   Under the key dbConfig, ensure that the key-value pairs for appl_memory and applheapsz are set as shown in the following example.

   spec:
     environment:
       database:
         dbConfig:
           APPLHEAPSZ: "51200 AUTOMATIC"
           APPL_MEMORY: "80000 AUTOMATIC"

   If the key-value pairs do not exist, add them.

   For more information on the parameters, see Database configuration parameters in the Db2 documentation.

4. Log in to the Db2® container.

   oc exec -it c-db2oltp-${DB2UCLUSTER_ID}-db2u-0 bash

5. Run the following commands from the database pod:

   db2 connect to opx
   db2 update db cfg for opx using applheapsz 51200 automatic
   db2 update db cfg for opx using appl_memory 80000 automatic

6. Restart the database pod by running the following command:

   oc delete po c-db2oltp-${DB2UCLUSTER_ID}-db2u-0

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 custom resource for OpenPages.

   cpd-cli manage apply-cr \
   --components=openpages \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --license_acceptance=true \
   --upgrade=true

Validating the upgrade

[SUCCESS]... The apply-cr 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, OpenPages will be unavailable to users for a period of time. 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 Cloud Pak for Data 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. Upgrade the service instance:

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

4. Repeat these steps for each OpenPages service instance.

What to do next