Upgrading Planning Analytics from Version 4.8.x to a later 4.8 refresh

Important: IBM Cloud Pak® for Data Version 4.8 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.8 reaches end of support. For more information, see Upgrading from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1.

An instance administrator can upgrade Planning Analytics from Cloud Pak for Data Version 4.8.x to a later 4.8 refresh.

Who needs to complete this task?

Instance administrator To upgrade Planning Analytics, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance

The operators for this instance of Cloud Pak for Data are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The Cloud Pak for Data control plane and the services for this instance of Cloud Pak for Data are installed in the operands project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

The tethered projects for the instance
If any projects are tethered to the operands project, you have permission to manage the software in the tethered projects.
When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to upgrade the Cloud Pak for Data control plane and one or more services at the same time, follow the process in Upgrading an instance of Cloud Pak for Data instead.
  • If you didn't upgrade Planning Analytics when you upgraded the Cloud Pak for Data control plane, complete this task to upgrade Planning Analytics.

    Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to upgrade more instances of Planning Analytics on the cluster.

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

Before you begin

This task assumes that the following prerequisites are met:

Prerequisite Where to find more information
The cluster meets the minimum requirements for Planning Analytics. 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 the following command-line interfaces:
  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift® CLI: oc
If this task is not complete, see Updating client workstations.
The Cloud Pak for Data control plane is upgraded. If this task is not complete, see Upgrading an instance of Cloud Pak for Data.
For environments that use a private container registry, such as air-gapped environments, the Planning Analytics software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.
For environments that use a private container registry, such as air-gapped environments, the cpd-cli is configured to pull the olm-utils-v2 image from the private container registry. If this task is not complete, see Pulling the olm-utils-v2 image from the private container registry.

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

Important: The Operator Lifecycle Manager (OLM) objects for Planning Analytics were updated when you upgraded the Cloud Pak for Data platform. The cpd-cli manage apply-olm updates all of the OLM objects in the operators project at the same time.

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 custom resource for Planning Analytics.
    cpd-cli manage apply-cr \
    --components=planning_analytics \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --license_acceptance=true \
    --upgrade=true

Validating the upgrade

Planning Analytics is upgraded when the apply-cr command returns:
[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=planning_analytics

Upgrading existing service instances

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

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. Change to the directory on your workstation where you want to create the YAML file that defines the service instance payload.
  2. Set the environment variables that are used for the service instance upgrade:
    1. Set the INSTANCE_PROJECT environment variable to project where the service instance exists.
      The service instance is in the operands project
      export INSTANCE_PROJECT=${PROJECT_CPD_INST_OPERANDS}

      The service instance is in a tethered project
      Important: If multiple tethered projects are associated with this instance of Cloud Pak for Data, make sure that the ${PROJECT_CPD_INSTANCE_TETHERED} environment variable is set to the correct project name before you run the export command:
      echo $PROJECT_CPD_INSTANCE_TETHERED
      export INSTANCE_PROJECT=${PROJECT_CPD_INSTANCE_TETHERED}

    2. Set the INSTANCE_NAME environment variable to the name of the service instance in the INSTANCE_PROJECT:
      export INSTANCE_NAME=$(oc get paserviceinstance --no-headers --namespace=${INSTANCE_PROJECT} | awk '{print $1}')
  3. Upgrade the service instance:
    cpd-cli service-instance upgrade \
    --service-type=pa \
    --profile=${CPD_PROFILE_NAME} \
    --instance-name=${INSTANCE_NAME}

What to do next

Upgrading the service instance 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.