Upgrading from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1

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

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

The following upgrade paths are supported:

Current version Can be upgraded to
4.8.0 5.1.0 and later
4.8.1 5.1.0 and later
4.8.2 5.1.0 and later
4.8.3 5.1.0 and later
4.8.4 5.1.0 and later
4.8.5 5.1.0 and later
4.8.6 5.1.0 and later
4.8.7 5.1.0 and later
4.8.8 5.1.1 and later
Restriction: You cannot upgrade from Version 4.8.8 to Version 5.1.1 if you have the following services installed:
  • Data Virtualization
  • Db2
  • Db2 Big SQL
  • Db2 Warehouse
  • OpenPages with an embedded Db2 database
  • watsonx.governance™ with OpenPages with an embedded Db2 database

If you want to upgrade to Version 5.1, you must upgrade to Version 5.1.2 or later.

Before you begin

Before you upgrade IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1:
  1. Review the information in the Planning section.

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

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

  3. Best practice Backup your Cloud Pak for Data Version 4.8 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 4.8 documentation.

Services that are not available on Version 5.1

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

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 Cloud Pak for Data Version 4.8:
  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 to Version 5.1

watsonx™ Orchestrate

watsonx Orchestrate does not support upgrading from Cloud Pak for Data Version 4.8 to 5.1.

Contact IBM Software Support to back up your existing watsonx Orchestrate data before you Uninstall watsonx Orchestrate.

You can reinstall watsonx Orchestrate after you upgrade to Cloud Pak for Data Version 5.1.

Upgrade overview

The upgrade is broken up into the following phases:

1. Updating your cluster

You can upgrade your cluster to a newer version of Red Hat OpenShift Container Platform that is supported by IBM Cloud Pak for Data Version 4.8 and IBM Software Hub Version 5.1. Depending on the storage on your cluster, you might need to upgrade your storage.

User icon Cluster administrator When icon One-time setup

a. Do you want to upgrade Red Hat OpenShift Container Platform?
Restriction: Data Virtualization and Db2 Big SQL are not supported on Red Hat OpenShift Container Platform Version 4.12. If your environment includes either service, you must ensure your cluster is running Red Hat OpenShift Container Platform Version 4.14 or later.
Options What to do
You don't want to upgrade Red Hat OpenShift Container Platform
  1. Go to b. Are you running a supported version of your persistent storage?.
You need or want to upgrade Red Hat OpenShift Container Platform
  1. Complete Upgrading Red Hat OpenShift Container Platform (Upgrading from Version 4.8 to Version 5.1).
  2. Complete Migrating your image content source policy to an image digest mirror set (Upgrading from Version 4.8 to Version 5.1).
  3. Go to b. Are you running a supported version of your persistent storage?.
b. Are you running a supported version of your persistent storage?
Supported versions of persistent storage
Storage option Version supported in 5.1 Upgrade notes
OpenShift Data Foundation
  • Version 4.12
  • Version 4.14
  • Version 4.15
  • Version 4.16
  • Version 4.17
  • Version 4.18 5.1.3 and later
 Ensure that you are running a version that is compatible with the version of Red Hat OpenShift Container Platform that you are running on your cluster.
IBM Fusion Data Foundation
  • Version 2.8.2 with the latest hotfix or later fixes
  • Version 2.9.0 with the latest hotfix or later fixes
  • Version 2.10.0 with the latest hotfix or later fixes (Recommended)
 Ensure that you are running a version that is compatible with the version of Red Hat OpenShift Container Platform that you are running on your cluster.
IBM Fusion Global Data Platform
  • Version 2.8.2 with the latest hotfix or later fixes
  • Version 2.9.0 with the latest hotfix or later fixes
  • Version 2.10.0 with the latest hotfix or later fixes (Recommended)
 Ensure that you are running a version that is compatible with the version of Red Hat OpenShift Container Platform that you are running on your cluster.
IBM Storage Scale Container Native (with IBM Storage Scale Container Storage Interface) Version 5.1.7 or later fixes, with CSI Version 2.9.0 or later fixes Ensure that you are running a version that is compatible with the version of Red Hat OpenShift Container Platform that you are running on your cluster.
Portworx
  • Version 2.13.3 or later fixes
  • Version 3.0.2 or later fixes
  • Version 3.2.1.1 or later fixes
 Ensure that you are running a version that is compatible with the version of Red Hat OpenShift Container Platform that you are running on your cluster.
NFS Version 3 or 4 No action is required.
Amazon Elastic Block Store (EBS) Not applicable No action is required.
Amazon Elastic File System (EFS) Not applicable No action is required.
NetApp Trident
  • 5.1.0 5.1.1 Version 23.07 or later fixes
  • 5.1.2 and later Version 25.02 or later fixes
 No action is required.
Options What to do
You are running a supported version of your persistent storage
  1. Go to 2. Updating client workstations.
You have an older version of your persistent storage
  1. Complete Upgrading your persistent storage (Upgrading from Version 4.8 to Version 5.1).
  2. Go to 2. Updating client workstations.

2. Updating client workstations

Before you can upgrade to IBM Software Hub Version 5.1, you must ensure that the workstation has a supported version of the IBM Software Hub command-line interface and the OpenShift command-line interface.

User icon All administrators When icon Repeat as needed

What to do
  1. Complete Updating client workstations (Upgrading from Version 4.8 to Version 5.1).
  2. Go to 3. Collecting required information.

3. Collecting required information

To successfully upgrade from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1, 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 4.8 to Version 5.1).
  2. Complete Updating your environment variables script (Upgrading from Version 4.8 to Version 5.1).
  3. Go to the appropriate section based on your environment:

4. 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 4.8 to Version 5.1).
  2. Complete Downloading CASE packages before running upgrade commands in a restricted network (Upgrading from Version 4.8 to Version 5.1).
  3. Go to the appropriate section based on your environment:

5. 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 4.8 to a private container registry, you must mirror the images for IBM Software Hub Version 5.1 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 4.8 to Version 5.1).
  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 6. 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 4.8 to Version 5.1).
  2. Go to 6. 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 4.8 to Version 5.1).
  2. Go to 6. Upgrading prerequisite software.

6. Upgrading prerequisite software

Several services have prerequisite software that must be installed or 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 that have a dependency on prerequisite software
Prerequisite software Services with this prerequisite Install or upgrade this software if...
Node Feature Discovery Operator
  • Watson Machine Learning (required to use deep learning and models that require GPU)
  • Watson Studio Runtimes (required to use runtimes that require GPU)
  • watsonx.ai™
  • watsonx Assistant (required to use optional GPU features)
  • watsonx Orchestrate
This software is also required for the following services, which were introduced in IBM Cloud Pak for Data Version 5.0:
  • IBM Knowledge Catalog Premium
  • IBM Knowledge Catalog Standard
  • watsonx Code Assistant™ for Red Hat Ansible® Lightspeed
  • watsonx Code Assistant for Z
  • watsonx Code Assistant for Z Code Explanation
Install
You don't have the Node Feature Discovery Operator on your cluster and you want to install or upgrade a service with a dependency on the Node Feature Discovery Operator.
Upgrade
You upgraded Red Hat OpenShift Container Platform and the operator is installed withinstallPlanApproval: Manual.
NVIDIA GPU Operator
  • Watson Machine Learning (required to use deep learning and models that require GPU)
  • Watson Studio Runtimes (required to use runtimes that require GPU)
  • watsonx.ai
  • watsonx Assistant (required to use optional GPU features)
  • watsonx Orchestrate
This software is also required for the following services, which were introduced in IBM Cloud Pak for Data Version 5.0:
  • IBM Knowledge Catalog Premium
  • IBM Knowledge Catalog Standard
  • watsonx Code Assistant for Red Hat Ansible Lightspeed
  • watsonx Code Assistant for Z
  • watsonx Code Assistant for Z Code Explanation
Install
You don't have the NVIDIA GPU Operator on your cluster and you want to install or upgrade a service with a dependency on the NVIDIA GPU Operator.
Upgrade
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 Operator
  • watsonx.ai
  • watsonx Assistant (required to use optional GPU features)
  • watsonx Orchestrate
This software is also required for the following services, which were introduced in IBM Cloud Pak for Data Version 5.0:
  • IBM Knowledge Catalog Premium
  • IBM Knowledge Catalog Standard
  • watsonx Code Assistant for Red Hat Ansible Lightspeed
  • watsonx Code Assistant for Z
  • watsonx Code Assistant for Z Code Explanation
Install
You don't have the Red Hat OpenShift AI Operator on your cluster and you want to install or upgrade a service with a dependency on the Red Hat OpenShift AI Operator.
Upgrade
You must upgrade this software when you upgrade from IBM Cloud Pak for Data Version 4.8 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 IBM Cloud Pak for Data that includes watsonx Assistant or watsonx Orchestrate, you must upgrade this software if any of the following statements are true:

  • 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.
IBM App Connect in containers
  • watsonx Orchestrate
  • 5.1.0 5.1.1 5.1.2

    If you plan to upgrade an instance of IBM Cloud Pak for Data that includes watsonx Orchestrate, you must upgrade this software when you upgrade from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub 5.1.

  • 5.1.3 This software is no longer required.
Options What to do
You do not have any services with a dependency on prerequisite software
  1. Go to 7. Upgrading shared cluster components.
You have services with a dependency on prerequisite software
  1. Complete Installing or upgrading prerequisite software (Upgrading from Version 4.8 to Version 5.1).
  2. Go to 7. Upgrading shared cluster components.

7. Upgrading shared cluster components

Before you upgrade from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1, 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 4.8 to Version 5.1).
  2. Go to 8. Preparing to upgrade an instance of Cloud Pak for Data.

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

Before you upgrade an instance of IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1, 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 4.8 to IBM Software Hub Version 5.1. If you do not validate the health of your cluster before you upgrade to IBM Software Hub Version 5.1, 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 4.8 to Version 5.1).
  2. Go to b. Who will upgrade the instance?
b. Who will upgrade the instance?
If a user other than the cluster administrator will upgrade IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1, you must update the permissions on the projects that are associated with the instance.
Options What to do
The cluster administrator will upgrade the instance
  1. Go to c. Do you want to install the privileged monitoring service?
Another user will upgrade the instance
  1. Complete the appropriate task in Reauthorizing the instance administrator (Upgrading from Version 4.8 to Version 5.1).
  2. Go to c. Do you want to install the privileged monitoring service?
c. Do you want to install 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.

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 do not want to install the privileged monitoring service
  1. Go to d. Do you need to apply or update your entitlements?
You want to install the privileged monitoring service
  1. Complete Upgrading privileged monitors (Upgrading from Version 4.8 to Version 5.1).
  2. Go to d. Do you need to apply or update your entitlements?
d. Do you need to apply or 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.

Situations that require you to run the apply-entitlement command
  • You did not run the cpd-cli manage apply-entitlement command when you installed IBM Cloud Pak for Data Version 4.8.
  • You plan to change the software that is installed when you upgrade from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1.
  • You want to use node pinning to comply with your license terms.
Options What to do
You do not need to apply or update your entitlements
  1. Go to 9. Upgrading an instance of Cloud Pak for Data.
You need to apply or update your entitlements
  1. Complete the appropriate task in Applying your entitlements to monitor and report use against license terms (Upgrading from Version 4.8 to Version 5.1).
  2. Go to 9. Upgrading an instance of Cloud Pak for Data.

9. Upgrading an instance of Cloud Pak for Data

To upgrade an instance of IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1, 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 4.8 to IBM Software Hub Version 5.1, 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 4.8 to Version 5.1).
  2. Go to b. Upgrading the cpdbr service.
b. Upgrading the cpdbr service

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

Options What to do
You do not use the cpdbr service to back up and restore your IBM Software Hub deployment
  1. Go to 10. Installing the configuration admission controller webhook.
You use the cpdbr service to back up and restore your IBM Software Hub deployment
  1. Complete Updating the cpdbr service (Upgrading from Version 4.8 to Version 5.1).
  2. Go to 10. Installing the configuration admission controller webhook.

10. Installing the configuration admission controller webhook

If you want to enable services to use a shared set of custom certificates, a cluster administrator must install the configuration admission controller webhook.

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® 5.1.2 and later
  • Watson Studio 5.1.2 and later
  • Watson Studio Runtimes 5.1.2 and later
  • watsonx Assistant
  • watsonx.data™
  • watsonx Orchestrate 5.1.1 and later
Options What to do
You do not need to install the configuration admission controller webhook
  1. Go to 11. Completing post-upgrade tasks.
You need to install the configuration admission controller webhook
  1. Complete Installing the configuration admission controller webhook (Upgrading from Version 4.8 to Version 5.1).
  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.
  2. JDBC driver upload is disabled by default. If you want to allow authorized users to upload JDBC driver files, you must complete Enabling users to upload JDBC drivers.
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.
  3. JDBC driver upload is disabled by default. If you want to allow authorized users to upload JDBC driver files, you must complete Enabling users to upload JDBC drivers.