Rolling back an upgrade of the Cloud Pak for Data control plane

If you are running Cloud Pak for Data Version 4.0.x, you can roll back to the previous 4.0.x refresh after you upgrade the Cloud Pak for Data control plane.

Remember: To obtain fixes, security updates, and new functionality, you must install the latest refresh of the Cloud Pak for Data software. The software includes the control plane, shared cluster components, and services. Therefore, rolling back your upgrade should be a last resort.

You might need to roll back the upgrade if:

  • The upgrade was unsuccessful and you are unable to resolve the problem with the assistance of IBM Software Support.
  • The upgrade causes your cluster to become unstable
  • You want to revert your installation to the previously installed version

Before you begin

Best practice: You can run the commands in this task exactly as written if you set up environment variables for your installation. For instructions, see Best practice: Setting up install variables.

Ensure that you run the environment variable script before you run the commands in this task.

About this task

If you want to roll back the upgrade, you must roll back the version of the ZenService in the following order:

  • 4.4.3 to 4.4.2
  • 4.4.2 to 4.4.0
  • 4.4.0 to 4.3.2
  • 4.3.2 to 4.3.1
  • 4.3.1 to 4.2.0
  • 4.2.0 to 4.1.1
  • 4.1.1 to 4.1.0
  • 4.1.0 to 4.0.1
  • 4.0.1 to 4.0.0

It is recommended that you roll back one version at a time and check the status of the installation.

Procedure

To roll back one version:

  1. Enable the Cloud Pak for Data control plane to roll back and specify the version to roll back to. For example, to rollback from 4.4.4, run: 
    oc patch ZenService lite-cr \
--namespace ${PROJECT_CPD_INSTANCE} \
--type=merge \
--patch='{"spec": {"acceptRollback": true, "version": "4.4.3"}}'
    The command should return:
    zenservice.zen.cpd.ibm.com/lite-cr patched
  2. Monitor the progress of the rollback. Run the following commands:
    1. Confirm that roll back started: 
      oc get configmaps zen-lite-operation-configmap \
--namespace ${PROJECT_CPD_INSTANCE} \
-o jsonpath='{.data.operation}{"\n"}'

      If the roll back started, the command should return rollback.

    2. Confirm that the operator is installing the specified version of the software: 
      oc get configmaps zen-lite-operation-configmap \
--namespace ${PROJECT_CPD_INSTANCE} \
-o jsonpath='{.data.version}{"\n"}'

      The command should return the version that you specified, for example 4.4.3.

    3. Confirm that the roll back is complete: 
      oc get configmaps zen-lite-operation-configmap \
--namespace ${PROJECT_CPD_INSTANCE} \
-o jsonpath='{.data.status}{"\n"}'

      Wait for the command to return Completed before moving to the next step. It can take up to 90 minutes for the roll back to complete.

  3. Prevent the Cloud Pak for Data control plane from rolling back again: 
    oc patch ZenService lite-cr \
--namespace ${PROJECT_CPD_INSTANCE} \
--type=merge \
--patch '{"spec": {"acceptRollback": false}}'
  4. Use the URL that is returned by roll back operation to access the web client and to determine whether your issues were resolved.
    If you continue to see issues, complete another roll back to the previous version.