Upgrading Planning Analytics from Version 5.3 to Version 5.4

Information you need to complete this task

Review the following information before you upgrade Planning Analytics:

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 Planning Analytics 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 Planning Analytics.

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 Planning Analytics 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 Planning Analytics:

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

Upgrading the service

To upgrade Planning Analytics:

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 Planning Analytics.

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=planning_analytics \
   --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

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=planning_analytics

Upgrading existing service instances

The service instances are automatically upgraded when you upgrade Planning Analytics.

What to do next

Upgrading the service might cause the service instance to be down for at least 5 minutes. After this time, the service is ready to use. To check the status of the Planning Analytics service instance, run one of the following commands:

• oc get PAServiceInstance ${INSTANCE_NAME} -n ${INSTANCE_PROJECT} -w

  The service is ready to use when the command output shows that the instance is Completed in the STATUS column.

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

  The service is ready to use when the command output shows that the instance is RUNNING in the Service status column.

For more information about using Planning Analytics, Modeling and reporting patterns in data with Planning Analytics.