Upgrading from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2

Starting in Version 5.1, the control plane is called IBM Software Hub. You can upgrade from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2.

A Red Hat® OpenShift® Container Platform cluster administrator and instance administrator can work together to upgrade IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2.

Important: It is strongly recommended that you upgrade to Version 5.2.1 or later.

Upgrading to Version 5.2.0 is not recommended because you must manually apply fixes after you upgrade to 5.2.0.

The fixes are included in Version 5.2.1 and later.

Before you begin

Before you upgrade to IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2:
  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 IBM 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 IBM Cloud Pak for Data in the IBM Cloud Pak for Data Version 5.0 documentation.

Services that are not available on Version 5.2

Watson Machine Learning Accelerator
Watson Machine Learning Accelerator is not available on IBM Software Hub Version 5.2.

If you use Watson Machine Learning, you no longer need Watson Machine Learning Accelerator to train deep learning experiments.

If Watson Machine Learning Accelerator is installed on IBM Cloud Pak for Data Version 5.0:
  1. Back up any model definitions that you plan on recreating in Watson Machine Learning.
  2. Uninstall the Watson Machine Learning Accelerator service.

For more information, see Preparing to upgrade Watson Machine Learning.

Services that cannot be upgraded from Version 5.0 to Version 5.2

Match 360
You cannot directly upgrade the Match 360 service from Version 5.0.x to Version 5.2. If you have this service on your environment, you must:
  1. Upgrade from Cloud Pak for Data Version 5.0.x to IBM Software Hub Version 5.1.3.
  2. Upgrade Match 360 to Version 5.1.3.
  3. Migrate your database from FoundationDB to Neo4j.
  4. Upgrade from Version 5.1.3 to Version 5.2.
watsonx Code Assistant™ for Z Code Explanation
watsonx Code Assistant for Z Code Explanation cannot be upgraded from Version 5.0 to Version 5.2.

If you want to upgrade to IBM Software Hub Version 5.2, uninstall watsonx Code Assistant for Z Code Explanation before you upgrade to IBM Software Hub Version 5.2.

You can re-install watsonx Code Assistant for Z Code Explanation after you upgrade to watsonx Code Assistant for Z Code Explanation.

Upgrade overview

The upgrade is broken up into the following phases:

1. Updating client workstations

Before you upgrade to IBM Software Hub Version 5.2, 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 to Version 5.2).
  2. Go to 2. Collecting required information.

2. Collecting required information

To successfully upgrade from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2, you must have specific information about your environment.

User icon Operations team When icon Repeat as needed

What to do
  1. Complete Determining which components to upgrade (Upgrading from Version 5.0 to Version 5.2).
  2. If you use a private container registry, complete Determining which models and images to mirror to your private container registry (Upgrading from Version 5.0 to Version 5.2).
  3. Complete Updating your environment variables script (Upgrading from Version 5.0 to Version 5.2).
  4. Go to the appropriate section based on your environment:

3. Preparing to run upgrades in a restricted network

If you will run the 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 upgrade commands in a restricted network (Upgrading from Version 5.0 to Version 5.2).
  2. Complete Downloading CASE packages before running upgrade commands in a restricted network (Upgrading from Version 5.0 to Version 5.2).
  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 Software Hub 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 to a private container registry, you must mirror the images for IBM Software Hub 5.2 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 to Version 5.2).
  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 to Version 5.2).
  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 to Version 5.2).
  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 Most of the tasks can be completed once, but some of the tasks must be repeated if you have multiple instances of the service on the cluster.

Services with a dependency on prerequisite software
Prerequisite software Services with this prerequisite Upgrade this software if...
Node Feature Discovery Operator

An asterisk (*) indicates that the service requires GPU in some situations.

  • IBM Knowledge Catalog Premium *
  • IBM Knowledge Catalog Standard *
  • Watson Machine Learning *
  • Watson Studio Runtimes *
  • watsonx.ai™
  • watsonx Assistant *
  • Watsonx BI
  • watsonx Code Assistant
  • watsonx Code Assistant for Red Hat Ansible® Lightspeed
  • watsonx Code Assistant for Z
  • watsonx Code Assistant for Z Agentic 5.2.1 and later
  • watsonx Code Assistant for Z Code Explanation
  • watsonx Code Assistant for Z Code Generation 5.2.1 and later
  • watsonx.data™ *
  • watsonx.data Premium
  • watsonx.data intelligence
  • watsonx™ Orchestrate *
 You upgraded Red Hat OpenShift Container Platform and the operator is installed with installPlanApproval: Manual.
NVIDIA GPU Operator

An asterisk (*) indicates that the service requires GPU in some situations.

  • IBM Knowledge Catalog Premium *
  • IBM Knowledge Catalog Standard *
  • Watson Machine Learning *
  • Watson Studio Runtimes *
  • watsonx.ai
  • watsonx Assistant *
  • Watsonx BI
  • watsonx Code Assistant
  • watsonx Code Assistant for Red Hat Ansible Lightspeed
  • watsonx Code Assistant for Z
  • watsonx Code Assistant for Z Agentic 5.2.1 and later
  • watsonx Code Assistant for Z Code Explanation
  • watsonx Code Assistant for Z Code Generation 5.2.1 and later
  • watsonx.data *
  • watsonx.data Premium
  • watsonx.data intelligence
  • watsonx Orchestrate *
 The version of the operator on your cluster has reached the end of support. For details, see NVIDIA GPU Operator Life Cycle in the NVIDIA GPU Operator documentation.
Red Hat OpenShift AI

An asterisk (*) indicates that the service requires Red Hat OpenShift AI in some situations.

  • IBM Knowledge Catalog Premium *
  • IBM Knowledge Catalog Standard *
  • watsonx.ai
  • watsonx Assistant *
  • Watsonx BI
  • watsonx Code Assistant
  • watsonx Code Assistant for Red Hat Ansible Lightspeed
  • watsonx Code Assistant for Z
  • watsonx Code Assistant for Z Agentic 5.2.1 and later
  • watsonx Code Assistant for Z Code Explanation
  • watsonx Code Assistant for Z Code Generation 5.2.1 and later
  • watsonx.data Premium
  • watsonx.data intelligence
  • watsonx Orchestrate *
 You must upgrade this software when you upgrade from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.1.
Multicloud Object Gateway
  • Watson Discovery
  • Watson Speech services
  • watsonx Assistant
  • watsonx Orchestrate
 You must upgrade this software if you upgrade Red Hat OpenShift Container Platform.
Red Hat OpenShift Serverless Knative Eventing
  • watsonx Assistant
  • watsonx Orchestrate
 If you plan to upgrade an instance of Cloud Pak for Data that includes watsonx Assistant or watsonx Orchestrate, you must upgrade this software if:
  • You upgrade Red Hat OpenShift Container Platform
  • The version of the Red Hat OpenShift Serverless Operator on your cluster is out of support.
  • There is a new version of the IBM Events Operator included with IBM Software Hub.
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 to Version 5.2).
  2. Go to 6. Upgrading shared cluster components.

6. Upgrading shared cluster components

Before you upgrade from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2, you must upgrade the Certificate manager, License Service, and scheduling service.

User icon Cluster administrator When icon One-time setup

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

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

Before you upgrade an instance of IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2, a cluster administrator must prepare the instance for upgrade.

User icon Cluster administrator When icon Repeat as needed

a. Checking the health of your cluster
The IBM Software Hub command-line interface includes commands that you can use the validate the health of your cluster before you upgrade from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2. If you do not validate the health of your cluster before you upgrade to IBM Software Hub Version 5.2, you might encounter issues during the upgrade.
What to do
  1. Complete Checking the health of your cluster before upgrading to IBM Software Hub (Upgrading from Version 5.0 to Version 5.2).
  2. Go to b. Do you need to reauthorize the instance administrator?
b. 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 Version 5.0 software, you must update the roles that are assigned to the user so that the user has sufficient privileges to upgrade the instance to IBM Software Hub Version 5.2.

Options What to do
The cluster administrator will upgrade the instance
  1. Go to c. 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 c. 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 to Version 5.2).
  2. Go to c. Do you need to update your entitlements?
c. 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 IBM 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 to Version 5.2).
  2. Go to 8. Upgrading an instance of IBM Cloud Pak for Data.

8. Upgrading an instance of IBM Cloud Pak for Data

To upgrade an instance of IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2, 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 to IBM Software Hub

To upgrade an instance of IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2, you must upgrade the required operators and custom resources for the instance. After you upgrade the required operators for the instance, you must upgrade the operators for the services that are installed on the instance.

What to do
  1. Complete Upgrading to IBM Software Hub (Upgrading from Version 5.0 to Version 5.2).
  2. Go to b. Upgrading the cpdbr service.
b. Upgrading the cpdbr service

You must upgrade the cpdbr service after you upgrade IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2.

Options What to do
You do not use the cpdbr service to back up and restore your IBM Software Hub deployment
  1. Go to 9. Installing or upgrading the privileged monitoring service.
You use the cpdbr service to back up and restore your IBM Software Hub deployment
  1. Complete Updating the cpdbr service (Upgrading from Version 5.0 to Version 5.2).
  2. Go to 9. Installing or upgrading the privileged monitoring service.

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 IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2.

User icon Cluster administrator When icon Repeat as needed

Monitors provided by the privileged monitoring service
Cluster operator status check (check-cluster-operator-status)
Checks the status of the cluster operators that comprise the Red Hat OpenShift Container Platform infrastructure to determine whether:
  • All of the operators are AVAILABLE
  • Any of the operators are DEGRADED
Network status check (check-network-status)
Checks the status of the PodNetworkConnectivityCheck objects for cluster resources to determine whether the objects are Reachable.
Node imbalance status check (check-node-imbalance-status)
Checks whether vCPU requests are balanced across nodes or whether one node is supporting a disproportionately high load.
Node status check (check-node-status)
Checks whether the nodes on the cluster are ready and whether the nodes are using too many resources.
Volume usage status check (check-volume-status)
Checks whether the persistent volume claims associated with the deployment are running out of space.
Restriction: Only persistent volume claims that are mounted by a running pod are monitored.
Operator namespace status check (check-operator-namespace-status)
Checks whether the resources in the operators project for the deployment are healthy.
Important: If you also want to check the status of the operators in the project where the scheduling service is installed, you must run the apply-privileged-monitoring-service command with the --cluster_components_ns=${PROJECT_SCHEDULING_SERVICE} option.
EDB cluster status check (check-edb-cluster-status)
Checks whether any instances of EDB Postgres that are associated with the deployment are healthy. For example, whether the database that IBM Software Hub uses to store metadata for the deployment is healthy.
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 to Version 5.2).
  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 to Version 5.2).
  2. Go to 10. Installing or upgrading the admission controller webhook

10. Installing or upgrading the admission controller webhook

The configuration admission controller webhook enables services to use a shared set of custom certificates. If you installed the configuration admission controller webhook on IBM Cloud Pak for Data Version 5.0, a cluster administrator must upgrade the webhook after you upgrade the control plane from IBM Cloud Pak for Data Version 5.0 to IBM Software Hub Version 5.2.

User icon Cluster administrator When icon Repeat as needed

Services that support shared custom certificates
  • AI Factsheets
  • Analytics Engine powered by Apache Spark
  • Cognos Analytics
  • Data Privacy
  • DataStage
  • Data Virtualization
  • Db2 Big SQL
  • IBM Match 360
  • OpenPages
  • RStudio®
  • Watson Studio
  • Watson Studio Runtimes
  • watsonx Assistant
  • watsonx.data
  • watsonx Orchestrate
Options What to do
You did not install the admission controller webhook, and you don't plan to install it
  1. Go to 11. Completing post-upgrade tasks
You did not install the admission controller webhook, but you plan to install it
  1. Complete Upgrading the configuration admission controller webhook (Upgrading from Version 5.0 to Version 5.2).
  2. Go to 11. Completing post-upgrade tasks
You installed the admission controller webhook
  1. Complete Upgrading the configuration admission controller webhook (Upgrading from Version 5.0 to Version 5.2).
  2. Go to 11. Completing post-upgrade tasks

11. Completing post-upgrade tasks

After you upgrade to IBM Software Hub, determine whether there are any additional tasks that you should complete to configure your installation.

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.