Upgrading from IBM Cloud Pak for Data Version 4.0 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 4.0 to Version 4.6.
Your Cloud Pak for Data deployment will be unavailable during the upgrade.
Restrictions
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 4.0. 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 4.0. 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 4.0. 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 4.0. You must upgrade to 4.6.2 before you upgrade to 4.6.6. |
Before you begin
- Ensure that you are running Red Hat OpenShift Container Platform Version 4.8, which is supported by Cloud Pak for Data Version 4.0 and Cloud Pak for Data Version 4.6.0 - 4.6.2.
- Review the information in the Planning section.
Specifically, ensure that you review the System requirements. Your cluster must have sufficient resources.
- If your cluster pulls images from the IBM® Entitled
Registry, ensure that your cluster uses catalog sources that pull specific versions of images from the
IBM Entitled
Registry.Important: If your cluster uses the IBM Operator Catalog, you must migrate from the IBM Operator Catalog. You cannot upgrade to Cloud Pak for Data Version 4.6 if you want to continue using the IBM Operator Catalog.
- Determine which install plan the IBM
Cloud Pak foundational services operators and Cloud Pak for Data operators are using:
oc get installplan
- If the install plan approval is
Automatic
, you can proceed to the next step. - If the install plan approval is
Manual
, review the following options:Option Details Change the install plan to Automatic
(recommended)It is strongly recommended that you change the install plan for the IBM Cloud Pak foundational services operators and Cloud Pak for Data operators to Automatic
. This enables thecpd-cli manage
commands to seamlessly update the operators.To update the install plan for the operators:
- For the IBM
Cloud Pak foundational services
operators, see the Changing approval strategy from
Manual
toAutomatic
in the IBM Cloud Pak foundational services documentation. - For the Cloud Pak for Data operators, update the install plans for each operator through the Red Hat OpenShift Container Platform console. Open each subscription, view the subscription details, and edit the Update approval setting. For a list of the Cloud Pak for Data operators, see Creating operator subscriptions in the IBM Cloud Pak for Data Version 4.0 documentation.
Important: Ensure that the install plan of all the operators in the${PROJECT_CPFS_OPS}
project and${PROJECT_CPD_OPS}
project are set toAutomatic
. If any of the install plans are set toManual
, Operator Lifecycle Manager (OLM) will automatically update the install plans toManual
when you run thecpd-cli manage apply-olm
command.Leave the install plan as Manual
You can optionally leave the install plan for the IBM Cloud Pak foundational services operators and Cloud Pak for Data operators Manual
.Important: If you choose this option, you must watch the install plans and manually approve them during the upgrade to ensure that thecpd-cli manage apply-olm
commands complete successfully.Additionally, you must repeat this process each time that you upgrade the operators to a newer release.
Run the appropriate commands based on where your operators are installed:
- The IBM Cloud Pak foundational services operators and Cloud Pak for Data operators are installed in the same project (express installation)
-
- After you run the
cpd-cli manage apply-olm
command, open a new terminal window. - Run the following command to watch the project where the operators are
installed:
watch oc get installplan -n ${PROJECT_CPFS_OPS}
- Manually approve each install plan as it is created.
- After you run the
- The IBM Cloud Pak foundational services operators and Cloud Pak for Data operators are installed in different projects (specialized installation)
-
- After you run the
cpd-cli manage apply-olm
command, open two new terminal windows. - In the first terminal window, run the following command to watch the project where the IBM
Cloud Pak foundational services operators are
installed:
watch oc get installplan -n ${PROJECT_CPFS_OPS}
- In the second terminal window, run the following command to watch the project where the Cloud Pak for Data operators are
installed:
watch oc get installplan -n ${PROJECT_CPD_OPS}
- Manually approve each install plan as it is created by setting
spec.approved
totrue
.
- After you run the
- For the IBM
Cloud Pak foundational services
operators, see the Changing approval strategy from
- If the install plan approval is
- Ensure that the Cloud Pak for Data control
plane is
pinned at a specific version:
oc get ZenService lite-cr \ -n ${PROJECT_CPD_INSTANCE} \ -o jsonpath="{.spec.version}{'\n'}"
- If the installation is pinned, the response includes the version at which the installation is pinned.
- If the installation is not pinned, the response is empty.Run the following command to pin the Cloud Pak for Data control plane at a specific version:
oc patch ZenService lite-cr \ --namespace ${PROJECT_CPD_INSTANCE} \ --type=merge \ --patch '{"spec": {"version":"N.N.N"}}'
Replace
N.N.N
with the version to pin the control plane at based on the release of Cloud Pak for Data that you are running:Release Recommended version Refresh 2 4.2.0 Refresh 3 4.3.1 Refresh 4 4.3.2 Refresh 5 4.3.2 Refresh 6 4.4.0 Refresh 7 4.4.2 Refresh 8 4.4.3 Refresh 9 4.4.4
- 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, including the scheduling service operator.Remember: When you upgrade to Cloud Pak for Data Version 4.6, specify thescheduler
component.The scheduling service will be installed in the project where IBM Cloud Pak foundational services is installed.
-
If you have any of the following services on your cluster, check for expired or expiring SSL certificates:
Db2
Repeat the following steps for each Db2 database instance associated with this installation of Cloud Pak for Data:
- Get the name of each instance of Db2U that is associated with this installation of
Cloud Pak for Data:
oc get db2u -n=${PROJECT_CPD_INSTANCE}
- Set the
DB2U_NAME
environment variable to the name of the Db2 database instance to check:export
DB2U_NAME
=<db2oltp-id> - Run the following command to determine when the certificate
expires:
oc -n=${PROJECT_CPD_INSTANCE} exec -it c-${
DB2U_NAME
}-db2u-0 -- /bin/su - db2inst1 -c 'cd /mnt/blumeta0/db2/ssl_keystore;gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert | grep "Not After"'The command returns output with the following format:
Not After : September 12, 2023 7:44:34 AM GMT+00:00
- If the date is in the past or in the near future, update the certificate by following the guidance in Updating the Db2 SSL certificate.
Db2 Big SQL
Repeat the following steps for each Db2 Big SQL service instance associated with this installation of Cloud Pak for Data:
- Run the following command to get the IDs of the Db2 Big
SQL service instances associated with this
installation of Cloud Pak for Data:
oc get -A cm \ -n=${PROJECT_CPD_INSTANCE} \ -l component=db2bigsql \ -o custom-columns="Instance Id:{.data.instance_id},Instance Name:{.data.instance_name},Created:{.metadata.creationTimestamp}"
- Set the
BIG_SQL_ID
environment variable to the name of the Db2 Big SQL service instance to check:export
BIG_SQL_ID
=<bigsql-id> - Get the name of the head pod for the Db2 Big
SQL service
instance:
HEAD_POD=$(oc get pod -n=${PROJECT_CPD_INSTANCE} -l app=bigsql-${
BIG_SQL_ID
},name=dashmpp-head-0 --no-headers=true -o=custom-columns=NAME:.metadata.name) - Run the following command to determine when the certificate
expires:
oc -n=${PROJECT_CPD_INSTANCE} exec -it ${HEAD_POD} -- /bin/su - db2inst1 -c 'cd /mnt/blumeta0/db2/ssl_keystore;gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert | grep "Not After"'
The command returns output with the following format:
Not After : September 12, 2023 7:44:34 AM GMT+00:00
- If the date is in the past or in the near future, update the certificate by following the guidance in Refreshing the SSL certificate used by Db2 Big SQL.
Db2 Warehouse
Repeat the following steps for each Db2 Warehouse database instance associated with this installation of Cloud Pak for Data:
- Get the name of each instance of Db2U that is associated with this installation of
Cloud Pak for Data:
oc get db2u -n=${PROJECT_CPD_INSTANCE}
- Set the
DB2U_NAME
environment variable to the name of the Db2 Warehouse database instance to check:export
DB2U_NAME
=<db2wh-id> - Run the following command to determine when the certificate
expires:
oc -n=${PROJECT_CPD_INSTANCE} exec -it c-${
DB2U_NAME
}-db2u-0 -- /bin/su - db2inst1 -c 'cd /mnt/blumeta0/db2/ssl_keystore;gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert | grep "Not After"'The command returns output with the following format:
Not After : September 12, 2023 7:44:34 AM GMT+00:00
- If the date is in the past or in the near future, update the certificate by following the guidance in Updating the Db2 SSL certificate.
Watson Knowledge Catalog
- Run the following command to determine when the certificate expires:
- For the full version of Watson Knowledge
Catalog, run
the following commands:
-
oc -n=${PROJECT_CPD_INSTANCE} exec c-db2oltp-wkc-db2u-0 -- ksh -lc "cd /mnt/blumeta0/db2/ssl_keystore; gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert" 2>&1
-
oc -n=${PROJECT_CPD_INSTANCE} exec c-db2oltp-iis-db2u-0 -- ksh -lc "cd /mnt/blumeta0/db2/ssl_keystore; gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert" 2>&1
-
- For the core version of Watson Knowledge
Catalog, run
the following
command:
oc -n=${PROJECT_CPD_INSTANCE} exec c-db2oltp-wkc-db2u-0 -- ksh -lc "cd /mnt/blumeta0/db2/ssl_keystore; gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert" 2>&1
- For the full version of Watson Knowledge
Catalog, run
the following commands:
- If the date is in the past or in the near future, update the certificate by following the guidance in Renewing the Db2 SSL certificate.
Watson Query (previously Data Virtualization)
- Run the following command to determine when the certificate
expires:
oc -n=${PROJECT_CPD_INSTANCE} exec -it c-db2u-dv-db2u-0 -- /bin/su - db2inst1 -c 'cd /mnt/blumeta0/db2/ssl_keystore;gsk8capicmd_64 -cert -details -db bludb_ssl.kdb -stashed -label CN=zen-ca-cert | grep "Not After"'
The command returns output with the following format:
Not After : September 12, 2023 7:44:34 AM GMT+00:00
- If the date is in the past or in the near future, update the certificate by following the guidance in Refreshing the SSL certificate used by Data Virtualization.
- Get the name of each instance of Db2U that is associated with this installation of
Cloud Pak for Data:
- 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.
Tip: If you decide to use the Cloud Pak for Data OADP backup and restore utility to perform the backup, see Creating an offline backup of a Cloud Pak for Data deployment, which includes guidance excluding services that do not support the OADP backup and restore utility from your backup.
Services that are not available on Version 4.6
The following services are not available on 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 must be migrated from Version 4.0
The following services do not support upgrade from Cloud Pak for Data Version 4.0 to Version 4.6. However, you can migrate the data and objects from your existing installation on Version 4.0 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:
You can re-install Cognos Analytics when you upgrade to Cloud Pak for Data Version 4.6. After you install Cognos
Analytics, you can either:
|
Minimum required version
Some software must be at a specific version before you can upgrade from Cloud Pak for Data Version 4.0.
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 4.0 to Version 4.6.6.
- Minimum versions of required components
-
Software Minimum version Cloud Pak for Data control plane Refresh 2 of Cloud Pak for Data, specifically: - IBM Cloud Pak for Data platform operator Version 2.0.4 or later
Zen
operator Version 1.3.0 or laterZen
operand Version 4.2.0 or later
Scheduling service Version 1.2.3 or later. Version 1.2.3 was released with Refresh 2 of Version 4.0
- Minimum versions of services
-
Software Minimum version Analytics Engine Powered by Apache Spark Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Cognos Dashboards Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Data Privacy Version 4.0.3 or later. Version 4.0.3 was released with Refresh 3 of Version 4.0.
Data Refinery 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.7.2 or later. Version 1.7.2 was released with Refresh 2 of Version 4.0.
DataStage® Version 4.0.2 or later Version 4.0.2 was released with Refresh 2 of Version 4.0.
Db2 Version 4.0.3 or later. Version 4.0.3 was released with Refresh 2 of Version 4.0.
The service instance is running Version 11.5.6.0-cn3 or later.
Db2 Big SQL Version 7.2.2 or later. Version 7.2.2 was released with Refresh 2 of Version 4.0.
Db2 Data Gate Version 2.0.8 or later. Db2 Data Management Console Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Db2 Warehouse Version 4.0.3 or later. Version 4.0.3 was released with Refresh 2 of Version 4.0.
The service instance is running Version 11.5.6.0-cn3 or later.
Decision Optimization Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
EDB Postgres You must be running Refresh 2 or later of Cloud Pak for Data Version 4.0. (EDB Postgres operator Version 4.0.2 or later). Execution Engine for Apache Hadoop Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Jupyter Notebooks
(Renamed to Watson Studio
Runtimes in Version 4.5.)Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
IBM Match 360 with Watson Version 1.1.188 or later. Version 1.1.188 was released with Refresh 6 of Version 4.0.
If you are running an older version of IBM Match 360 with Watson, contact IBM Support.
Informix® Version 4.0.0 or later. Version 4.0.0 was released with Refresh 2 of Version 4.0.
MongoDB You must be running Refresh 2 or later of Cloud Pak for Data Version 4.0. (MongoDB operator Version 4.0.2 or later). OpenPages® Version 8.204.2 or later. Version 8.204.2 was released with Refresh 5 of Version 4.0
Planning Analytics Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Product Master Version 1.0.0 or later RStudio Server with R3.6
(Renamed to RStudio® Server
Runtimes in Version 4.6)Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
SPSS® Modeler Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Voice Gateway Version 1.0.7 or later. Version 1.0.7 was released with Refresh 2 of Version 4.0.
Watson Assistant Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Watson Discovery Version 4.0.2 or later. If you are running a Starter or Development deployment, you must specify the
discovery_deployment_type: Starter
configuration option. For details, see Specifying configuration options.Important: If you are upgrading from Version 4.0.2 through 4.0.5, you must quiesce the service before you upgrade to Cloud Pak for Data Version 4.6. For details, see Enabling quiesce.Watson Knowledge Catalog Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Watson Machine Learning Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Watson Machine Learning Accelerator Version 2.3.5 or later. Version 2.3.5 was released with Refresh 5 of Version 4.0.
Watson OpenScale Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
Watson Speech services Version 4.0.5 or later. Version 4.0.5 was released with Refresh 5 of Version 4.0.
Watson Studio Version 4.0.2 or later. Version 4.0.2 was released with Refresh 2 of Version 4.0.
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.
- 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 | |
You don't have a client workstation set up |
|
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 You don't have your API key - b. Determining the list of components that you plan to install
- Before you upgrade from Version 4.0, 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 - You must review the list of components to ensure that you upgrade all the required
components.
Complete Determining which components to upgrade (Upgrading from Version 4.0 to Version 4.6).
- Go to c. Collecting information about your cluster that can be used to set up environment variables.
- You must review the list of components to ensure that you upgrade all the required
components.
- 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
3. Preparing your cluster
Before you upgrade Cloud Pak for Data, you must prepare your cluster.
- a. Do you need to run the installation in a restricted environment?
- If you need to run
cpd-cli manage
commands against a cluster in a restricted network, you must make theolm-utils
image available inside the cluster network.Options What to do Your cluster is not in a restricted network Your cluster is in a restricted network - Review the guidance in Running cpd-cli manage commands in a restricted network (Upgrading from Version 4.0 to Version 4.6) to determine which method to use to make the required image available to one or more workstations in the cluster.
- Go to b. Do you have supported persistent storage on your cluster?
- b. 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 Fusion - Version 2.4.0 or later fixes
- Version 2.5.2 or later fixes (Recommended)
Available in IBM Storage Fusion. 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 You don't have supported storage - Version 4.8 or later fixes
- c. Do you plan to upgrade any services that require custom SCCs?
-
Services that require custom SCCs
If you had any of the following services installed on IBM Cloud Pak for Data Version 4.0, you can use the SCCs that you created as part of your Version 4.0 installation or upgrade:- Db2
- Db2 Big SQL
- Db2 Warehouse
- OpenPages
- Watson Knowledge Catalog
- Watson Query
If you have any of the following services on IBM Cloud Pak for Data Version 4.0, you might need to create custom SCCs before you upgrade to IBM Cloud Pak for Data Version 4.6:- Informix
Informix requires a custom SCC.
You must create this SCC manually.
For details, see: Creating the custom security context constraint for Informix (Upgrading from Version 4.0 to Version 4.6)
Options What to do You plan to upgrade one or more of these services - Create the appropriate SCCs for your environment. For details, see Creating custom security context constraints for services (Upgrading from Version 4.0 to Version 4.6).
- Go to d. Do you need to mirror the updated software images to a private container registry?
You don't plan to upgrade any of these services - d. Do you need to mirror the updated software images to a private container registry?
- If you are using a private container registry, you must mirror the updated images to the private
container registry before you upgrade your environment.
Options What to do You are pulling images from the IBM Entitled Registry You are pulling images from a private container registry
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 |
---|
|
5. 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.
What to do |
---|
Complete the appropriate tasks for your environment in Post-installation setup (Day 1 operations). |
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. |