Upgrading from IBM Cloud Pak for Data Version 4.6 to Version 4.8
Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.8 reaches end of support. For more information, see Upgrading 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 Cloud Pak for Data from Version 4.6.x to Version 4.8.
Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.8 reaches end of support. For more information, see Upgrading from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1.
In Version 4.8, the private topology replaces the express installation topology and the specialized installation topology. In the private topology, each instance of Cloud Pak for Data has its own set of operators. As part of the upgrade to Version 4.8, you are guided through the process of migrating to the new topology.
Services that cannot be upgraded to Version 4.8
- Cognos® Dashboards
-
Cognos Dashboards does not support upgrading from Cloud Pak for Data Version 4.6 to 4.8.
The component ID was changed from
cdetodashboardin Version 4.7. If you installed thecdecomponent in Version 4.6, ensure that you install thedashboardcomponent after you upgrade to Version 4.8. You can then migrate your existing dashboards to the new Cognos Dashboards service.
Before you begin
- If you installed the resource specification injection (RSI) feature when you installed IBM Cloud Pak for Data Version 4.6, uninstall the cluster-scoped
webhook. For more information, see Uninstalling the resource specification injection webhook on the cluster in
the Version 4.6 documentation.Important: If you plan to use the RSI feature in IBM Cloud Pak for Data Version 4.8, skip the step to delete the patches. You can re-activate the patches after you install the RSI-webhook at the instance-level.
- Review the information in the Planning section.
Specifically, ensure that you review the System requirements. Your cluster must have sufficient resources.
- 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.
- If you use SAML SSO, export your SSO configuration. You will need to reapply
your SAML SSO configuration after you upgrade to Version 4.8.
Skip this step if you use the IBM Cloud Pak foundational services Identity Management Service.
Run the following command to export your configuration to a file named samlConfig.json in the current working directory:
oc cp -n=${PROJECT_CPD_INSTANCE} \ $(oc get pods -l component=usermgmt -n ${PROJECT_CPD_INSTANCE} \ -o jsonpath='{.items[0].metadata.name}'):/user-home/_global_/config/saml ./samlConfig.json - 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 in the Version 4.6 documentation.
Upgrade overview
The upgrade is broken up into the following phases:
- 1. Updating your cluster
- 2. Updating client workstations
- 3. Collecting required information
- 4. Preparing to run upgrades in a restricted network
- 5. Preparing to run upgrades from a private container registry
- 6. Installing prerequisite software
- 7. Migrating to the private topology
- 8. Preparing to upgrade an instance of Cloud Pak for Data
- 9. Upgrading an instance of Cloud Pak for Data
- 10. Completing post-upgrade tasks
1. Updating your cluster
Before you upgrade IBM Cloud Pak for Data, ensure that your cluster is running a supported version of Red Hat OpenShift Container Platform and a supported version of your persistent storage.
Cluster administrator
One-time setup
- a. Are you running a supported version of Red Hat OpenShift Container Platform?
- Before you upgrade IBM Cloud Pak for Data, ensure that your cluster is running
Red Hat OpenShift Container Platform
Version 4.12.
Options What to do You are running a supported version of OpenShift You are running an older version of OpenShift - b. Are you running a supported version of your persistent storage?
-
Supported versions of persistent storage
Storage option Version supported in 4.8 Upgrade notes OpenShift Data Foundation - Version 4.12
- Version 4.14
- Version 4.15
- Version 4.16
- Version 4.17 4.8.9 or later
- Version 4.18 4.8.9 or 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® Storage Fusion Data Foundation 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 Fusion Global Data Platform 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
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 Version 22.4.0 or later fixes No action is required.
Options What to do You are running a supported version of your persistent storage You have an older version of your persistent storage
2. Updating client workstations
Before you can upgrade Cloud Pak for Data, you must ensure that the workstation has a supported version of the Cloud Pak for Data command-line interface and the OpenShift command-line interface.
All administrators
Repeat as needed
| What to do |
|---|
3. Collecting required information
To successfully upgrade from IBM Cloud Pak for Data Version 4.6 to Version 4.8, you must have specific information about your environment.
Cloud Pak for Data operations team
Repeat as needed
| What to do |
|---|
|
4. 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.
All administrators
Repeat as needed
| What to do |
|---|
|
5. Preparing to run upgrades from a private container registry
Different users need to complete the appropriate tasks.
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 4.6 to a private container
registry, you must mirror the images for Version 4.8 to the private
container registry before you upgrade your installation.
Registry administrator
Repeat as needed
What to do - Complete the appropriate task for your environment in Mirroring images to a private container registry (Upgrading from Version 4.6 to Version 4.8).
- Go to b. Do users need to pull the olm-utils-v2 image from the private container registry?
- b. Do users need to pull the
olm-utils-v2image from the private container registry? -
If the
olm-utils-v2image is available in the private container registry, you must update thecpd-clito pull the image from the private container registry.All administrators
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 Your cluster is not in a restricted network, but you want users to pull the image from the private container registry Your cluster is in a restricted network
6. Installing prerequisite software
Several services have prerequisite software that must be installed on the cluster by a cluster administrator.
Cluster administrator
One-time setup
Services with a dependency on prerequisite software
| Services that have prerequisites | Prerequisite software |
|---|---|
| Watson Discovery |
|
| Watson Speech services |
|
| watsonx Assistant |
|
| watsonx Orchestrate® |
|
| Options | What to do |
|---|---|
| You do not have any services with dependency on prerequisite software | |
| You have services with a dependency on Multicloud Object Gateway only |
|
| You have services with a dependency on Multicloud Object Gateway and Red Hat OpenShift Serverless Knative Eventing |
|
7. Migrating to the private topology
In IBM Cloud Pak for Data Version 4.6, all instances of Cloud Pak for Data shared a single set of operators. In Cloud Pak for Data Version 4.8, each instance of Cloud Pak for Data has its own set of operators. You must migrate your environment to the private topology.
Cluster administrator
One-time setup
8. Preparing to upgrade an instance of Cloud Pak for Data
Before you can upgrade IBM Cloud Pak for Data, you must configure the projects for the instance of Cloud Pak for Data that you plan to upgrade.
Cluster administrator
Repeat as needed
- a. Detaching the instance from the shared operators
-
Before you can upgrade an instance of IBM Cloud Pak for Data to Version 4.8, you must detach the instance from the shared operators.
What to do - b. Do you want to let the
cpd-clicreate projects? -
The IBM Cloud Pak for Data command-line interface can automatically create any projects that don't exist on the cluster. However, you can optionally create the operators project manually.
Options What to do You will let the cpd-clicreate the required projectsYou will create the required projects yourself - c. Applying the required permissions to the instance projects
-
Before you upgrade an instance of IBM Cloud Pak for Data, you must ensure that the project where the operators will be installed can watch the project where the IBM Cloud Pak for Data control plane and services are installed.
What to do - d. Who will upgrade and manage the instance?
- If a user other than the cluster administrator will
upgrade IBM Cloud Pak for Data, you must give a Red Hat OpenShift Container Platform user the required role to upgrade the
Cloud Pak for Data software in the instance
projects.
Options What to do The cluster administrator will upgrade the instance Another user will upgrade the instance - e. Does the instance include services with a dependency on Multicloud Object Gateway?
-
Services with a dependency on Multicloud Object Gateway
The following services have a dependency on Multicloud Object Gateway.
- watsonx Assistant
- Watson Discovery
- Watson Speech services
Options What to do The instance does not include services with a dependency on Multicloud Object Gateway The instance includes one or more services with a dependency on Multicloud Object Gateway
9. 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.
Instance administrator
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 - 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 - c. Upgrading the
cpdbrservice -
If you use the
cpdbrservice to back up and restore your IBM Cloud Pak for Data deployment on IBM Storage Fusion, you must upgrade thecpdbrservice after you upgrade Cloud Pak for Data.Options What to do You don't use the cpdbrserviceYou use the cpdbrservice
10. 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.
Instance administrator
Repeat as needed
| Options | What to do |
|---|---|
| You upgraded the services when you upgraded the platform |
|
| You didn't upgrade the services when you upgraded the platform |
|