Upgrading Planning Analytics from Version 4.5

A project administrator can upgrade Planning Analytics from Cloud Pak for Data Version 4.5 to Version 4.6.

What permissions do you need to complete this task?
The permissions that you need depend on which tasks you must complete:
  • To update the Planning Analytics 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 Planning Analytics, you must be an administrator of the project where Planning Analytics is installed. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

    If any instances of Planning Analytics 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 Planning Analytics when you upgraded the platform to Version 4.6, you can complete this task to upgrade your existing Planning Analytics 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 Planning Analytics:

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
Planning Analytics 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 Planning Analytics might be in projects that are tethered to the control plane.

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 cpd-cli has the latest version of the olm-utils-play image. 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 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.

Procedure

Complete the following tasks to upgrade Planning Analytics:

  1. Logging in to the cluster
  2. Updating the operator
  3. Updating the technical preview operators (optional)
  4. Upgrading the service
  5. Validating the upgrade
  6. Upgrading existing service instances
  7. 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 Planning Analytics operator simplifies the process of managing the Planning Analytics service on Red Hat® OpenShift® Container Platform.

To upgrade Planning Analytics, 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 Planning Analytics service.

Updating the technical preview operators (optional)

If the technical preview is enabled, you need to update the technical preview operators for the technical preview of the Planning Analytics Engine.

Who needs to complete this task?
You must be an administrator of the project where you will install Planning Analytics.
When do you need to complete this task?
Complete this task if you want to use the technical preview of the Planning Analytics Engine.

To update the technical preview operators:

  1. Launch the Red Hat OpenShift Container Platform web console.
  2. On the navigation menu, click Operators > Installed Operators.
  3. Verify that the Project drop-down menu is set to All projects or ibm-common-services.
  4. Navigate to the IBM Planning Analytics operator, click the ellipsis menu, then select Uninstall operator.

    The Planning Analytics operator uninstalls.

  5. Navigate to the IBM Planning Analytics Spreadsheet Services operator, click the ellipsis menu, then select Uninstall operator.

    The Planning Analytics Spreadsheet operator uninstalls.

  6. Navigate to the IBM Planning Analytics TM1 operator, click the ellipsis menu, then select Uninstall operator.

    The Planning Analytics TM1 operator uninstalls.

  7. Install the latest operators from the following command:
    cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--components=planning_analytics \
--extra-vars="{\"override_components_meta\":{\"planning_analytics\":{\"sub_channel\":\"beta-v5.1\"}}}"

After the install is successful, if you navigate to the Operators > Installed Operators page, you will see the following Planning Analytics operators:

  • IBM Planning Analytics
  • IBM Planning Analytics Spreadsheet Services
  • IBM Planning Analytics TM1

Upgrading the service

After the Planning Analytics operator is updated, you can upgrade Planning Analytics.

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

To upgrade the service:

  1. Update the custom resource for Planning Analytics.
    cpd-cli manage apply-cr \
--components=planning_analytics \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--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.

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

Upgrading existing service instances

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

To upgrade the service 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. Edit the PAServiceInstance custom resource:
    oc edit PAServiceInstance <pa-serviceinstance-cr> --namespace ${PROJECT_CPD_INSTANCE}
  3. Update the version entry to 4.6.6.
  4. Save your changes and exit. For example, if you are using vi, hit esc and enter :wq.

What to do next

Note: After upgrading Planning Analytics from Version 4.5.3 to 4.6.5, the following Planning Analytics MongoDB pods might fail to start: mongo-data-1, neo-idviz, and neo-provision. For details on resolving this issue, see Limitations and known issues in Planning Analytics.

The service is now ready to use. See Modeling and reporting patterns in data with Planning Analytics for more information on using Planning Analytics.