Upgrading Planning Analytics from Version 5.0 to Version 5.1

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.1.3, you must upgrade Planning Analytics to Version 5.1.3.

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:

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

[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 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. 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 IBM Software Hub, 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.