Upgrading from IBM Cloud Pak for Data Version 4.0.x
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 previous 4.0 refreshes to Refresh 9 of Version 4.0.
The instructions for upgrading IBM Cloud Pak for Data assume that you already have your entitlement key. If you don't have your entitlement key, see Obtaining your IBM entitlement API key.
Services that don't support upgrade to Version 4.0.x refreshes
If a later version of DataStage is installed, you can upgrade to Version 4.0.9.
Before you begin
- Review the roles that are defined on your Cloud Pak for Data installation:
- Determine whether there are any custom roles. (You can compare the list of roles in the web client against the roles in Predefined roles and permissions.)
- If you have custom roles, determine whether the roles include the Create catalog permission.
- If a custom role includes the Create catalog permission, remove the permission from the role and save your changes.
If you have multiple Cloud Pak for Data installations on the cluster, repeat the preceding steps for each installation.
- Back up your existing installation. Follow the steps in Backing up and restoring your deployment.
- Review the following information before you upgrade Cloud Pak for Data:
- Determine which services you have installed.
It is recommended that you upgrade to the latest refresh of the Cloud Pak for Data control plane (Version Not applicable) before you upgrade the services on your cluster. Some of the upgrade preparation tasks, such as updating your catalog source and operator subscriptions, include steps for the services as well as the Cloud Pak for Data control plane. If you know which services you need to upgrade, you can streamline the upgrade by batching these tasks.
Use the following information to ensure that you complete the appropriate tasks for your environment.
1. Do you need to mirror the updated software images to a private container registry?
If you are using a private container registry, it is strongly recommended that you always use the same workstation and method to mirror images to your private container registry. Reusing the same workstation means that you don't have to complete the steps to set up the workstation each time you need to mirror images. It also means that only changed images are mirrored, which reduces the time it takes to complete the mirroring process.
| Options | What to do |
|---|---|
| You are pulling images from the IBM Entitled Registry | |
| You are mirroring images to a private container registry |
|
2. Updating the catalog source for your software
The catalog source that you use determines the software images that are available on your environment. The catalog source also determines whether the catalog source is automatically updated or whether you need to manually update the catalog source. and determines
| Options | What to do |
|---|---|
| You are pulling images from the IBM Entitled Registry |
Important: Starting with Refresh 3 of Version
4.0, it is strongly recommended that
you create catalog sources that pull a specific versions of images from the IBM Entitled Registry.
|
| You are mirroring images to a private container registry |
3. Do you need to upgrade the IBM Cloud Pak foundational services?
For information about supported versions of IBM Cloud Pak foundational services, see the Cloud Pak for Data platform software requirements.
| Options | What to do |
|---|---|
| IBM Cloud Pak foundational services Version 3.18.0 or later is already installed | |
| An earlier version of IBM Cloud Pak foundational services is installed |
|
4. Updating operator subscriptions and upgrading operators
When you created the operator subscriptions, you chose an installation plan for each operator. The installation plan determines the actions that you typically need to take to update an operator subscription when a new version of the operator is available. However, even if you chose the automatic install plan, you might need to update some of the operator subscriptions on your cluster to ensure that the correct version of the operator is installed.
- Complete the appropriate steps for your environment in Upgrading operator subscriptions.
- Go to 5. Do you need to upgrade the scheduling service?
5. Do you need to upgrade the scheduling service?
If you installed the scheduling service on Cloud Pak for Data Version 4.0.x, upgrade to the latest version of the scheduling service before you upgrade the control plane.
| Options | What to do |
|---|---|
| The scheduling service is not installed on your cluster | |
| The scheduling service is installed on your cluster |
|
6. Upgrading the control plane
If you have multiple installations of Cloud Pak for Data on your cluster, upgrade each instance of the control plane.
7. Upgrading services
You are ready to upgrade the services on your cluster. Instructions for upgrading IBM services are available in Services.
8. Cleaning up catalog sources on your environment
If your installation pulls images from the IBM Entitled Registry, determine whether you need to complete the following tasks to clean up the catalog sources on your environment:
- Migrating from the IBM Operator Catalog
- This task applies only if the following statements are true:
- Your previous installation used the IBM Operator Catalog to automatically pull the latest images from the IBM Entitled Registry
- Your current installation uses catalog sources that pull specific versions of images from the IBM Entitled Registry
Starting with Refresh 3 of Version 4.0, it is strongly recommended that you create catalog sources that pull specific versions of images from the IBM Entitled Registry.
If you adopted this methodology when you upgraded to Refresh 9 of Version 4.0, you must remove all references to the IBM Operator Catalog from your cluster to ensure that your cluster uses the correct images. For details, see Migrating from the IBM Operator Catalog.
- Removing outdated catalog sources
- This task applies only if the following statements are true:
- Your cluster uses the IBM Operator Catalog to automatically pull the latest images from the IBM Entitled Registry
- You installed the initial release of Cloud Pak for Data Version 4.0
If you installed the initial release of Cloud Pak for Data Version 4.0, you might have created some catalog sources that were required for the initial release but are no longer required in subsequent refreshes. Starting in Refresh 1 of Version 4.0, the IBM Operator Catalog was updated and the additional catalogs are no longer required to ensure that dependencies can be installed.
You are not required to complete this task. However, it is a best practice to remove unnecessary configurations from your Red Hat OpenShift Container Platform cluster. For details, see Removing outdated catalogs.