Upgrading from IBM Cloud Pak for Data Version 5.0.x to a later 5.0 refresh

A Red Hat® OpenShift® Container Platform cluster administrator and instance administrator can work together to upgrade IBM Cloud Pak for Data from Version 5.0.x to a later 5.0 refresh.

Before you begin

Before you upgrade Cloud Pak for Data:
  1. Review the information in the Planning section.

    Specifically, ensure that you review the System requirements. Your cluster must have sufficient resources.

  2. Review the information in Planning an upgrade.
  3. Ensure that you have a copy of script that defines the installation environment variables for your deployment.

    The script enables you to run most of the installation and upgrade commands without modifying them.

  4. Best practice Backup your Cloud Pak for Data installation before you upgrade.

    In the event of an unrecoverable failure, you can use the backup to recover your existing installation. For details, see Backing up and restoring Cloud Pak for Data.

Upgrade overview

The upgrade is broken up into the following phases:

1. Updating client workstations

Before you upgrade to a later 5.0 refresh, you must ensure that the workstation has the latest version of the cpd-cli and the olm-utils-v3 image.

User icon All administrators When icon Repeat as needed

What to do
  1. Complete Updating client workstations (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 2. Collecting required information.

2. Collecting required information

To successfully upgrade from IBM Cloud Pak for Data Version 5.0.x to a later 5.0 refresh, you must have specific information about your environment.

User icon Cloud Pak for Data operations team When icon Repeat as needed

What to do
  1. Complete Determining which components to upgrade (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Complete Updating your environment variables script (Upgrading from Version 5.0.x to a later 5.0 refresh).
  3. Go to the appropriate section based on your environment:

3. Preparing to run upgrades in a restricted network

If you will run the IBM Cloud Pak for Data upgrade commands in a restricted network, you must prepare the client workstations before you move them behind your firewall.

User icon All administrators When icon Repeat as needed

What to do
  1. Complete Obtaining the olm-utils-v3 image before running IBM Cloud Pak for Data installation commands in a restricted network (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Complete Downloading CASE packages before running IBM Cloud Pak for Data upgrade commands in a restricted network (Upgrading from Version 5.0.x to a later 5.0 refresh).
  3. Go to the appropriate section based on your environment:

4. Preparing to run upgrades from a private container registry

User icon Different users need to complete the appropriate tasks.

When icon Some of these tasks can be completed once, but some of the tasks must be repeated for each user involved in the installation.

If you use a private container registry to host the IBM Cloud Pak for Data software images, you must mirror the updated images from the IBM Entitled Registry to the private container registry.

a. Mirroring images to the private container registry

If you mirrored the images for IBM Cloud Pak for Data Version 5.0.x to a private container registry, you must mirror the images for the 5.0 refresh that you want to install to the private container registry before you upgrade your installation.

User icon Registry administrator When icon Repeat as needed

What to do
  1. Complete the appropriate task for your environment in Mirroring images to a private container registry (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to b. Do users need to pull the olm-utils-v3 image from the private container registry?.
b. Do users need to pull the olm-utils-v3 image from the private container registry?

If the olm-utils-v3 image is available in the private container registry, you must update the cpd-cli to pull the image from the private container registry.

User icon All administrators When icon Repeat as needed

Options What to do
Your cluster is not in a restricted network and users can pull the image from the IBM Entitled Registry
  1. Go to 5. Upgrading prerequisite software.
Your cluster is not in a restricted network, but you want users to pull the image from the private container registry
  1. Complete Pulling the olm-utils-v3 image from the private container registry (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 5. Upgrading prerequisite software.
Your cluster is in a restricted network
  1. Complete Pulling the olm-utils-v3 image from the private container registry (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 5. Upgrading prerequisite software.

5. Upgrading prerequisite software

Several services have prerequisite software that must be upgraded by a cluster administrator.

User icon Cluster administrator When icon Some of these tasks can be completed once, but some of the tasks must be repeated for each instance of Cloud Pak for Data where the services are installed.

Services with a dependency on prerequisite software
Services that have prerequisites Prerequisite software
IBM Knowledge Catalog Premium To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
IBM Knowledge Catalog Standard To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
Watson Discovery To install this service, you must install the following software:
  • Multicloud Object Gateway
Watson Machine Learning If you plan to use models that require GPUs, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
Watson Machine Learning Accelerator To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
Watson Speech services To install this service, you must install the following software:
  • Multicloud Object Gateway
Watson Studio Runtimes that require GPU To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
watsonx.ai To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
watsonx Assistant To install this service, you must install the following software:
  • Multicloud Object Gateway
  • Red Hat OpenShift Serverless Knative Eventing

If you plan to use conversational skills or conversational search features, you must install the following operators:

  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
watsonx Code Assistant for Red Hat Ansible® Lightspeed To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
watsonx Code Assistant for Z To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
watsonx Code Assistant for Z Code Explanation To install this service, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
watsonx.governance
  • 5.0.0 To install this service, you must install the following operators:
    • Red Hat OpenShift AI Operator
  • 5.0.1 or later This software does not require any prerequisite software.
watsonx Orchestrate To install this service, you must install the following software:
  • Multicloud Object Gateway
  • Red Hat OpenShift Serverless Knative Eventing
  • IBM App Connect in containers
In addition, you must install the following operators:
  • Node Feature Discovery Operator
  • NVIDIA GPU Operator
  • Red Hat OpenShift AI Operator
Options What to do
The instance that you are upgrading does not include any services with a dependency on prerequisite software
  1. Go to 6. Upgrading shared cluster components.
You are upgrading services with a dependency on prerequisite software
  1. Complete Upgrading prerequisite software (Upgrading from Version 5.0.x to a later 5.0 refresh).
    Important: Not all prerequisites need to be upgraded.
  2. Go to 6. Upgrading shared cluster components.

6. Upgrading shared cluster components

Before you upgrade IBM Cloud Pak for Data, you must upgrade the Certificate manager, License Service, and scheduling service.

User icon Cluster administrator When icon Repeat as needed

What to do
  1. Complete Upgrading shared cluster components (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 7. Preparing to upgrade an instance of Cloud Pak for Data.

7. Preparing to upgrade an instance of Cloud Pak for Data

Before you upgrade an instance of IBM Cloud Pak for Data from Version 5.0 to a later 5.0.x refresh, a cluster administrator must prepare the instance for upgrade.

User icon Cluster administrator When icon Repeat as needed

a. Do you need to reauthorize the instance administrator?

If you gave an instance administrator the minimum role-based access control (RBAC) to install IBM Cloud Pak for Data software, you must update the roles that are assigned to the user so that the user has sufficient privileges to upgrade the instance.

Options What to do
The cluster administrator will upgrade the instance
  1. Go to b. Do you need to update your entitlements?.
An instance administrator will upgrade the instance, but the user has the admin role on the projects
  1. Go to b. Do you need to update your entitlements?.
An instance administrator will upgrade the instance, and the user has the minimum permissions to install the software
  1. Complete Reauthorizing an instance administrator with the minimum RBAC to upgrade components (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to b. Do you need to update your entitlements?.
b. Do you need to update your entitlements?
You are required to keep a record of the size of deployments to report to IBM as requested. The License Service measures your use against your license terms.
Options What to do
You are not changing the solutions or services associated with the instance
  1. Go to 8. Upgrading an instance of Cloud Pak for Data.
You are changing one or more solutions or services associated with the instance
  1. Complete the appropriate task for your environment in Applying your entitlements to monitor and report use against license terms (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 8. Upgrading an instance of Cloud Pak for Data.

8. Upgrading an instance of Cloud Pak for Data

To upgrade an instance of IBM Cloud Pak for Data, you must update the operators and operands (custom resources) that are associated with the instance.

User icon Instance administrator When icon Repeat as needed

a. Upgrading the IBM Cloud Pak foundational services for the instance

Before you can upgrade IBM Cloud Pak for Data, you must upgrade the IBM Cloud Pak foundational services that Cloud Pak for Data requires. Each instance of Cloud Pak for Data has its own instance of the IBM Cloud Pak foundational services.

What to do
  1. Complete Upgrading the IBM Cloud Pak foundational services (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to b. Upgrading Cloud Pak for Data.
b. Upgrading Cloud Pak for Data

After you upgrade the IBM Cloud Pak foundational services for the instance, you can upgrade the IBM Cloud Pak for Data control plane and services.

What to do
  1. Complete Upgrading IBM Cloud Pak for Data (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to c. Upgrading the cpdbr service.
c. Upgrading the cpdbr service

If you use IBM Storage Fusion, NetApp Astra Control Center, or Portworx to back up and restore your Cloud Pak for Data deployment, you must upgrade the cpdbr service after you upgrade Cloud Pak for Data.

Options What to do
You do not use the cpdbr service to back up and restore your IBM Cloud Pak for Data deployment
  1. Go to 12. Completing post-upgrade tasks.
You use the cpdbr service to back up and restore your IBM Cloud Pak for Data deployment
  1. Complete Updating the cpdbr service (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 12. Completing post-upgrade tasks.

9. Installing or upgrading the privileged monitoring service

Privileged monitors provide additional information about the health of the cluster and resources that are not typically included in the platform monitors. If you installed the privileged monitors, a cluster administrator must upgrade the monitors as part of the upgrade from Version 5.0.x to a later Version 5.0 refresh.

User icon Cluster administrator When icon Repeat as needed

Options What to do
You did not install the privileged monitoring service, and you don't plan to install it
  1. Go to 10. Installing or upgrading the admission controller webhook.
You did not install the privileged monitoring service, but you plan to install it
  1. Complete Upgrading privileged monitors (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 10. Installing or upgrading the admission controller webhook.
You installed the privileged monitoring service
  1. Complete Upgrading privileged monitors (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 10. Installing or upgrading the admission controller webhook.

10. Installing or upgrading the admission controller webhook

If you installed the Cloud Pak for Data configuration admission controller webhook, a cluster administrator must upgrade the webhook as part of the upgrade from Version 5.0.x to a later Version 5.0 refresh.

User icon Cluster administrator When icon Repeat as needed

Options What to do
You did not install the admission controller webhook, and you don't plan to install it
  1. Go to 11. Installing or upgrading the RSI webhook.
You did not install the admission controller webhook, but you plan to install it
  1. Complete Upgrading the IBM Cloud Pak for Data configuration admission controller webhook (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 11. Installing or upgrading the RSI webhook.
You installed the admission controller webhook
  1. Complete Upgrading the IBM Cloud Pak for Data configuration admission controller webhook (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 11. Installing or upgrading the RSI webhook.

11. Installing or upgrading the RSI webhook

The resource specification injection (RSI) webhook is required if you plan to use node pinning to manage entitlement or if you want to apply your cluster-level HTTP proxy configuration to your IBM Cloud Pak for Data. If you installed the RSI webhook in Cloud Pak for Data Version 5.0.x, a cluster administrator must upgrade the webhook as part of the upgrade to a later Version 5.0 refresh.

User icon Cluster administrator When icon Repeat as needed

Options What to do
You did not install RSI webhook, and you don't plan to install it
  1. Go to b. Do you need to update your entitlements?.
You did not install the RSI webhook, but you plan to install it
  1. Complete Installing or upgrading the IBM Cloud Pak for Data resource specification injection webhook (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 12. Completing post-upgrade tasks.
You installed the RSI webhook
  1. Complete Installing or upgrading the IBM Cloud Pak for Data resource specification injection webhook (Upgrading from Version 5.0.x to a later 5.0 refresh).
  2. Go to 12. Completing post-upgrade tasks.

12. Completing post-upgrade tasks

After you upgrade Cloud Pak for Data, determine whether there are any additional tasks that you should complete to configure your Cloud Pak for Data cluster.

User icon Instance administrator When icon Repeat as needed

Options What to do
You upgraded the services when you upgraded the platform
  1. Complete the appropriate tasks for your environment in Setting up services after install or upgrade.
You didn't upgrade the services when you upgraded the platform
  1. Upgrade the services in the instance. For more information, see Services.
  2. Complete the appropriate tasks for your environment in Setting up services after install or upgrade.