Upgrading from IBM Cloud Pak for Data Version 3.5 to Version 4.6

A Red Hat® OpenShift® Container Platform cluster administrator and project administrator can work together to prepare the cluster and upgrade IBM Cloud Pak for Data from Version 3.5 to Version 4.6.

Restrictions

You can upgrade from Cloud Pak for Data Version 3.5 to a subset of the Cloud Pak for Data Version 4.6 releases:
Refresh Supported?
4.6.0 Yes
4.6.1 Yes
4.6.2 Yes
4.6.3 Not supported.

4.6.3 requires Red Hat OpenShift Container Platform Version 4.10, which is not supported with Cloud Pak for Data Version 3.5.

You must upgrade to 4.6.2 before you upgrade to 4.6.3.

4.6.4 Not supported.

4.6.4 requires Red Hat OpenShift Container Platform Version 4.10 or 4.12, which are not supported with Cloud Pak for Data Version 3.5.

You must upgrade to 4.6.2 before you upgrade to 4.6.4.

4.6.5 Not supported.

4.6.5 requires Red Hat OpenShift Container Platform Version 4.10 or 4.12, which are not supported with Cloud Pak for Data Version 3.5.

You must upgrade to 4.6.2 before you upgrade to 4.6.5.

4.6.6 Not supported.

4.6.6 requires Red Hat OpenShift Container Platform Version 4.10 or 4.12, which are not supported with Cloud Pak for Data Version 3.5.

You must upgrade to 4.6.2 before you upgrade to 4.6.6.

Before you begin

  1. Ensure that you are running Red Hat OpenShift Container Platform Version 4.8, which is supported by Cloud Pak for Data Version 3.5 and Cloud Pak for Data Version 4.6.0 - 4.6.2.

    For details, see Upgrading Red Hat OpenShift Container Platform (Upgrading from Version 3.5 to Version 4.6).

  2. If the scheduling service is installed on your cluster, determine whether it's installed in the ibm-common-services project:
    oc get scheduling -A

    If the command returns a project other than ibm-common-services, uninstall the scheduling service.

    Remember: When you upgrade to Cloud Pak for Data Version 4.6, specify the scheduler component.

    The scheduling service will be installed in the project where IBM Cloud Pak foundational services is installed.

  3. If the Watson™ Query service is installed on your cluster, you must export your users from Watson Query before you upgrade to Cloud Pak for Data Version 4.6.

    For details, see Exporting users and custom JARs before you upgrade Watson Query.

Deprecated services

The following services were deprecated in a previous release of Cloud Pak for Data.

If you want to continue using any of these services, you cannot upgrade to Cloud Pak for Data Version 4.6:

  • Db2® Event Store
  • Db2 for z/OS®
  • Edge Analytics
  • Financial Crimes Insight®
  • Master Data Connect
  • Streams
  • Streams Flows
  • Watson Language Translator

If you don't have any of these services, proceed to the next section.

Services that are not available on Version 4.6

The following services are not deprecated; however, they are not available on Cloud Pak for Data Version 4.6.6.

If you are running any of these services, you cannot upgrade to Cloud Pak for Data Version 4.6:

Service Details
Guardium® External S-TAP® As of 30 November 2022, the Guardium External S-TAP service is not available on Cloud Pak for Data Version 4.6.
Open Data for Industries As of 30 November 2022, the Open Data for Industries service is not available on Cloud Pak for Data Version 4.6.

If you don't have any of these services, proceed to the next section.

Services that do not support upgrade from Version 3.5

The following services do not support upgrade from Cloud Pak for Data Version 3.5 to Version 4.6.

If you are running any of these services, work with your IBM Support representative to determine what steps you need to take before you install these services on Cloud Pak for Data Version 4.6.

  • EDB Postgres
  • MongoDB
  • OpenPages®
  • Voice Gateway
  • Watson Machine Learning Accelerator

If you don't have any of these services, proceed to the next section.

Services that must be migrated from Version 3.5

The following services do not support upgrade from Cloud Pak for Data Version 3.5 to Version 4.6. However, you can migrate the data and objects from your existing installation on Version 3.5 to a new installation on Version 4.6:

Software Migration information
Cognos® Analytics To migrate to Cloud Pak for Data Version 4.6, you must:
  1. Back up your Cognos Analytics data store.
  2. Uninstall Cognos Analytics.

You can re-install Cognos Analytics when you upgrade to Cloud Pak for Data Version 4.6. You can choose whether you:

  • Reuse your existing content store.
  • Create a new content store and use the backup that you created to restore the data.
DataStage® To migrate to Cloud Pak for Data Version 4.6, you must migrate your DataStage installation.
Informix® To migrate to Cloud Pak for Data Version 4.6, you must:
  1. Export the data from your existing Informix database using the Informix dbexport utility.
  2. Uninstall Informix.

You can re-install Informix when you upgrade to when you upgrade to Cloud Pak for Data Version 4.6. Then, re-import the data using the Informix dbimport utility.

Watson Assistant To migrate to Cloud Pak for Data Version 4.6, you must:
  1. Back up your Watson Assistant installation.
  2. Uninstall Watson Assistant.

You can re-install Watson Assistant when you upgrade to Cloud Pak for Data Version 4.6.

Watson Discovery To migrate to Cloud Pak for Data Version 4.6, you must:
  1. Back up your Watson Discovery installation.
  2. Uninstall Watson Discovery.

You can re-install Watson Discovery when you upgrade to when you upgrade to Cloud Pak for Data Version 4.6.

Watson Knowledge Studio To migrate to Cloud Pak for Data Version 4.6, you must:
  1. Back up your Watson Knowledge Studio installation.
  2. Uninstall Watson Knowledge Studio.

You can re-install Watson Knowledge Studio when you upgrade to when you upgrade to Cloud Pak for Data Version 4.6.

Watson Speech
services


(Formerly Watson Speech
to Text
and Watson Text
to Speech
)
To migrate to Cloud Pak for Data Version 4.6, you must:
  1. Back up your Watson Speech services installation.
  2. Uninstall the Watson Speech services:

You can re-install Watson Speech services when you upgrade to Cloud Pak for Data Version 4.6.

Minimum required version for upgrade

You must install one of the following refreshes before you upgrade from Cloud Pak for Data Version 3.5 to Version 4.6:
  • Cloud Pak for Data Version 3.5 Refresh 15
  • Cloud Pak for Data Version 3.5 Refresh 16

If any of the following software is installed on your cluster, ensure that it is at the minimum required version before you upgrade from Cloud Pak for Data Version 3.5 to Version 4.6.

Minimum versions of required components
Software Minimum version
Cloud Pak for Data control plane Version 3.5.7 or later.
Common core services Version 3.5.12 or later.
Scheduling service Version 1.1.10 or later.
Minimum versions of services
Software Minimum version
Analytics Engine Powered by Apache Spark Version 3.5.8 or later.
Cognos Dashboards Version 3.5.3 or later.
Data Refinery Version 3.5.10 or later.
This service is upgraded when you upgrade one of the following services:
  • Watson Knowledge Catalog
  • Watson Studio
Data Virtualization
(Renamed to Watson
Query
in Version 4.6.)
Version 1.5.0.
Db2 Version 3.5.10 or later.
Db2 Big SQL Version 7.1.1 or later.
Db2 Data Gate Version 1.1.3 or later.
Db2 Data Management Console Version 3.5.3 or later.
Db2 Warehouse Version 3.5.10 or later.
Decision Optimization Version 3.5.15 or later.
Execution Engine for Hadoop Version 3.5.10 or later.
Jupyter Notebooks
(Renamed to Watson Studio
Runtimes
in Version 4.5.)
Version 3.5.9 or later.
Planning Analytics Version 3.5.6 or later.
RStudio Server with R3.6
(Renamed to RStudio® Server
Runtimes
in Version 4.6.)
Version 3.5.10 or later.
SPSS® Modeler Version 3.5.10 or later.
Watson Knowledge Catalog Version 3.5.12 or later.
Watson Machine Learning Version 3.5.14 or later.
Watson OpenScale Version 3.5.12 or later.
Watson Studio Version 3.5.9 or later.

1. Setting up a client workstation

To upgrade to IBM Cloud Pak for Data Version 4.6, you must have a client workstation that can connect to the Red Hat OpenShift Container Platform cluster.

Tip: You can set up multiple client workstations if you want to enable multiple people to work on the upgrade.
The client workstation must be a Windows, Mac OS, or Linux® machine with the following software installed:
  • Cloud Pak for Data command-line interface (cpd-cli) Version 12.0.6 or later.
  • OpenShift command-line interface (oc) at a version that is compatible with your cluster.
Options What to do
You already have a client workstation set up
  1. Go to 2. Collecting required information
You don't have a client workstation set up
  1. Review the guidance in Setting up a client workstation (Upgrading from Version 3.5 to Version 4.6).
  2. Complete the following tasks to install the required software on the client workstation:
    1. Installing the IBM Cloud Pak for Data command-line interface (Upgrading from Version 3.5 to Version 4.6)
    2. Installing the OpenShift command-line interface (Upgrading from Version 3.5 to Version 4.6)
  3. Go to 2. Collecting required information

2. Collecting required information

a. Obtaining your IBM entitlement API key
All IBM Cloud Pak for Data images are accessible from the IBM® Entitled Registry. The IBM entitlement API key enables you to pull software images from the IBM Entitled Registry, either for installation or for mirroring to a private container registry.
Options What to do
You already have your API key
  1. Go to b. Determining the list of components that you plan to upgrade
You don't have your API key
  1. Complete Obtaining your IBM entitlement API key (Upgrading from Version 3.5 to Version 4.6)
  2. Go to b. Determining the list of components that you plan to upgrade
b. Determining the list of components that you plan to upgrade
Before you upgrade from Version 3.5, determine which components are installed on your cluster. In addition, determine whether you want to install any additional services on your cluster.
What to do
  1. You must review the list of components to ensure that you:
    • Upgrade all the required components
    • Know which tasks you must complete to prepare your cluster (some services have additional prerequisite configurations)

    Complete Determining which components to upgrade (Upgrading from Version 3.5 to Version 4.6).

  2. Go to c. Collecting information about your cluster that can be used to set up environment variables.
c. Collecting information about your cluster that can be used to set up environment variables
The commands for installing and upgrading IBM Cloud Pak for Data use variables with the format ${VARIABLE_NAME}. You can create a script to automatically export the appropriate values as environment variables before you run the installation commands. After you source the script, you will be able to copy most install and upgrade commands from the documentation and run them without making any changes.
What to do
  1. Complete Setting up installation environment variables (Upgrading from Version 3.5 to Version 4.6).
  2. Go to 3. Preparing your cluster.

3. Preparing your cluster

Before you upgrade Cloud Pak for Data, you must prepare your cluster.

a. Do you need to upgrade your Red Hat OpenShift Container Platform cluster?
Your cluster must be running Red Hat OpenShift Container Platform Version 4.8.

Red Hat OpenShift Container Platform Version 4.8 is the only version of OpenShift that is supported for both Cloud Pak for Data Version 3.5 and Cloud Pak for Data Version 4.6.

Options What to do
You are running a supported version of OpenShift
  1. Go to b. Do you need to run the upgrade in a restricted environment?
You have an older version of OpenShift
  1. Upgrade your cluster.
  2. Go to b. Do you need to run the upgrade in a restricted environment?
b. Do you need to run the upgrade in a restricted environment?
If you need to run cpd-cli manage commands against a cluster in a restricted network, you must make the olm-utils image available inside the cluster network.
Options What to do
Your cluster is not in a restricted network
  1. Go to c. Do you have supported persistent storage on your cluster?
Your cluster is in a restricted network
  1. Review Running cpd-cli manage commands in a restricted network (Upgrading from Version 3.5 to Version 4.6).
  2. Go to c. Do you have supported persistent storage on your cluster?
c. Do you have supported persistent storage on your cluster?

Supported storage for the Cloud Pak for Data platform

The Cloud Pak for Data platform supports the following storage:

Storage option Version Notes
OpenShift Data Foundation
  • Version 4.8 or later fixes

    4.6.0 - 4.6.2 only

  • Version 4.10 or later fixes

    4.6.x

  • Version 4.12 or later fixes

    4.6.4 or later

Available in either:
  • IBM Storage Fusion
  • Red Hat OpenShift Platform Plus

Ensure that you install a version of OpenShift Data Foundation that is compatible with the version of Red Hat OpenShift Container Platform that you are running. For details, see https://access.redhat.com/articles/4731161.

IBM Storage Scale Container Native (with IBM Storage Scale Container Storage Interface) Version 5.1.5 or later fixes

CSI Version 2.6.x or later fixes

Available in either:
  • IBM Storage Fusion
  • IBM Storage Suite for IBM Cloud® Paks
Portworx
  • Version 2.9.1.3 or later fixes
  • Version 2.12.2 or later fixes
 
NFS Version 3 or 4 Version 3 is recommended if you are using any of the following services:
  • Db2
  • Db2 Big SQL
  • Db2 Warehouse
  • Watson Knowledge Catalog
  • Watson Query

If you use Version 4, ensure that your storage class uses NFS Version 3 as the mount option. For details, see Setting up dynamic provisioning.

IBM Cloud Block Storage Not applicable In addition to IBM Cloud Block Storage, your environment must also include IBM Cloud File Storage.
IBM Cloud File Storage Not applicable It is recommended that you use both IBM Cloud Block Storage and IBM Cloud File Storage storage.

Options What to do
You have supported storage
  1. Go to d. Do you have the required OpenShift projects on your cluster?
You don't have supported storage
  1. Review Upgrading shared persistent storage (Upgrading from Version 3.5 to Version 4.6).
  2. Go to d. Do you have the required OpenShift projects on your cluster?
d. Do you have the required OpenShift projects on your cluster?
At a minimum, you must have a project where you will install the Cloud Pak for Data operators and the project where your existing instance of Cloud Pak for Data is installed. You might need additional projects depending on whether:
  • Separate the Cloud Pak for Data operators from the IBM Cloud Pak foundational services operators
  • You have multiple instances of Cloud Pak for Data on the cluster
  • Deploy service instances or workloads in tethered projects

For details, see Supported project (namespace) configurations.

Options What to do
You know which projects you plan to use when you install the software
  1. Review the guidance in Setting up projects (namespaces) on Red Hat OpenShift Container Platform (Upgrading from Version 3.5 to Version 4.6) to:
    • Ensure that you have the necessary projects on your cluster
    • Determine whether you need to label any projects
    • Set up tethered projects
  2. Go to e. Do you plan to upgrade any services that require custom SCCs?
You don't know which projects you plan to use when you install the software
  1. Review the guidance in Setting up projects (namespaces) on Red Hat OpenShift Container Platform (Upgrading from Version 3.5 to Version 4.6) to determine which projects you need to create on your cluster.
  2. Go to e. Do you plan to upgrade any services that require custom SCCs?
e. Do you plan to upgrade any services that require custom SCCs?

Services that require custom SCCs

If you plan to upgrade any of the following Cloud Pak for Data services, you must create the appropriate custom SCCs:

  • Db2
  • Db2 Big SQL
  • Db2 Warehouse
  • Informix
  • OpenPages
  • Watson Knowledge Catalog
  • Watson Query

Options What to do
You plan to upgrade one or more of these services
  1. Create the appropriate SCCs for your environment. For details, see Creating custom security context constraints for services (Upgrading from Version 3.5 to Version 4.6).
  2. Go to f. Do you plan to upgrade any services that require specific node settings?
You don't plan to upgrade any of these services
  1. Go to f. Do you plan to upgrade any services that require specific node settings?
f. Do you plan to upgrade any services that require specific node settings?

Services that require node settings
Node setting Services that require changes to the setting
Load balancer timeout settings
  • Db2
  • Db2 Data Gate
  • Db2 Warehouse
  • OpenPages
  • Watson Discovery
  • Watson Knowledge Catalog
  • Watson Query
  • Watson Speech services
  • Watson Studio
CRI-O container settings
  • Cognos Analytics
  • Db2
  • Db2 Big SQL
  • Db2 Warehouse
  • Watson Discovery
  • Watson Knowledge Catalog
  • Watson Query
  • Watson Studio
  • Watson Machine Learning Accelerator
Kernel parameter settings
  • Db2
  • Db2 Big SQL
  • Db2 Warehouse
  • Watson Knowledge Catalog
  • Watson Query
GPU settings
  • Runtime 22.1 with Python 3.9 for GPU
  • Runtime 22.2 with Python 3.10 for GPU
  • Watson Machine Learning Accelerator

Options What to do
You plan to upgrade one or more of these services
  1. Update the node settings. For details, see Changing required node settings (Upgrading from Version 3.5 to Version 4.6).
  2. Go to g. How are you going to access the software images?
You don't plan to upgrade any of these services
  1. Go to g. How are you going to access the software images?
g. How are you going to access the software images?
Cloud Pak for Data images are accessible from the IBM Entitled Registry. In most situations, it is strongly recommended that you mirror the necessary software images from the IBM Entitled Registry to a private container registry.
Where should you pull images from?
Important:
You must mirror the necessary images to your private container registry in the following situations:
  • Your cluster is air-gapped (also called an offline or disconnected cluster).
  • Your cluster uses an allowlist to permit direct access by specific sites, and the allowlist does not include the IBM Entitled Registry.
  • Your cluster uses a blocklist to prevent direct access by specific sites, and the blocklist includes the IBM Entitled Registry.
Even if these situations do not apply to your environment, you should consider using a private container registry if you want to:
  • Run security scans against the software images before you install them on your cluster
  • Ensure that you have the same images available for multiple deployments, such as development or test environments and production environments

The only situation in which you might consider pulling images directly from the IBM Entitled Registry is when your cluster is not air-gapped, your network is extremely reliable, and latency is not a concern. However, for predictable and reliable performance, you should mirror the images to a private container registry.


Options What to do
You are pulling images from the IBM Entitled Registry
  1. Complete Updating the global image pull secret (Upgrading from Version 3.5 to Version 4.6).
  2. Go to 4. Upgrading the Cloud Pak for Data platform and services
You are pulling images from a private container registry
  1. Complete Updating the global image pull secret (Upgrading from Version 3.5 to Version 4.6).
  2. Complete Mirroring images to a private container registry (Upgrading from Version 3.5 to Version 4.6).
  3. Go to 4. Upgrading the Cloud Pak for Data platform and services

4. Upgrading the Cloud Pak for Data platform and services

After you prepare your cluster, you can upgrade the Cloud Pak for Data platform and services.

What to do
  1. Complete the appropriate tasks for your environment in Upgrading the IBM Cloud Pak for Data platform and services (Upgrading from Version 3.5 to Version 4.6).
  2. Go to 5. Completing post-upgrade tasks

5. Completing post-upgrade tasks

After you upgrade Cloud Pak for Data, make sure your cluster is secure and complete tasks that will impact how users interact with Cloud Pak for Data, such as configuring SSO or changing the route to the platform.

What to do
Complete the appropriate tasks for your environment in Post-installation setup (Day 1 operations).
Important: If you completed a batch upgrade of the platform and services on your environment, ensure that you complete the appropriate tasks in Setting up services after install or upgrade.

6. Upgrading services

Options What to do
You upgraded the services when you upgraded the platform Your environment is ready to use.
You didn't upgrade the services when you upgraded the platform Instructions for upgrading IBM services are available in Services.