Determining which components to upgrade (Upgrading from Version 4.6.x to a later 4.6 refresh)

Before you upgrade from Version 4.6.x to a later 4.6 refresh, determine which components are installed on your cluster. In addition, determine whether you want to install any additional services on your cluster.

Upgrade phase

Setting up a client workstation

Collecting required information

Preparing your cluster

Upgrading the Cloud Pak for Data platform and services

Who needs to complete this task?

Everyone involved in upgrading Cloud Pak for Data should agree on the components that will be installed on the cluster.

When do you need to complete this task?

Complete this task before you complete either of the following tasks:

Mirror images to a private container registry
Upgrade the Cloud Pak for Data software on your cluster

Procedure

Complete the following tasks:

Choosing a method for upgrading components
Identifying the components that are deployed on the cluster

The information in the following sections is provided for reference:

Required components
Service component IDs

Choosing a method for upgrading components

You have two options for upgrading the components:

Option	Benefits	Drawbacks
Upgrade each component individually	If you feel more comfortable running upgrades one at a time, this option gives you more granular control over the upgrade process. Note: All of the services must be installed at the same release. You cannot install the services at different releases.	You must complete more steps to successfully install the software on your environment. The order in which you upgrade components is important.
Upgrade all of the components at the same time.	You can complete the upgrade in fewer steps. The `cpd-cli` is designed to upgrade the components in the correct order, which reduces the likelihood of errors.	If you encounter an issue when upgrading a component, you can follow the instructions to upgrade the service separately. Restriction: This option is not recommended if you are planning to upgrade the following services: Analytics Engine Powered by Apache Spark Data Privacy Watson™ Knowledge Catalog If you are planning to upgrade any of these services, you should upgrade the platform before you upgrade these services.

Identifying the components that are deployed on the cluster

All of the OLM objects on the cluster must be at the same version. To ensure that you update all of the existing OLM objects on your cluster, you must know which components are deployed on the cluster.

The cpd-cli manage list-deployed-components command scans the contents of the openshift-marketplace project to compile a list of the components that are deployed on the cluster, regardless of the project where the software is deployed.

Who needs to complete this task?: To complete this task, you must be a cluster administrator or an administrator of the openshift-marketplace project.

To identify the components that are deployed on the cluster:

Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
```
cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
```
Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.
Get the list of deployed components:
```
cpd-cli manage list-deployed-components
```
The command returns a comma-separated list of the components on the cluster.

Important: If you use the ${COMPONENTS} environment variable to mirror images or download CASE packages, ensure that the environment variable includes all of the components returned by the list-deployed-components command.
If you mirror images or download CASE packages individually, ensure that you run the appropriate command for all of the components that are returned by the list-deployed-components command.

Required components

At a minimum, you must install the following components:

Software Component ID Notes

Software	Component ID	Notes
IBM Cloud Pak® foundational services	`cpfs`	Required. This component is a prerequisite for IBM Cloud Pak for Data. The component is installed once on the cluster and is shared by any instances of Cloud Pak for Data on the cluster. If the `cpd-cli` detects the minimum required version of the `cpfs` component on the cluster, it does not attempt to install it again.
Scheduling service	`scheduler`	Required if you plan to: Install Watson Machine Learning Accelerator Use the quota enforcement feature in Cloud Pak for Data The component is installed once on the cluster and is shared by any instances of Cloud Pak for Data on the cluster. If the `cpd-cli` detects the minimum required version of `scheduler` component on the cluster, it does not attempt to install it again.
IBM Cloud Pak for Data	`cpd_platform`	Required. This component is a prerequisite for installing any services. The component ensures that the Cloud Pak for Data control plane is installed and running. The component is installed once in each project (namespace) where you want to install the platform. If the `cpd-cli` detects the minimum required version of `cpd_platform` in the project, it does not attempt to install it again.

IBM Cloud Pak® foundational services

cpfs

Required.

This component is a prerequisite for IBM Cloud Pak for Data.

The component is installed once on the cluster and is shared by any instances of Cloud Pak for Data on the cluster.

If the cpd-cli detects the minimum required version of the cpfs component on the cluster, it does not attempt to install it again.

Scheduling service

scheduler

Required if you plan to:

Install Watson Machine Learning Accelerator
Use the quota enforcement feature in Cloud Pak for Data

The component is installed once on the cluster and is shared by any instances of Cloud Pak for Data on the cluster.

If the cpd-cli detects the minimum required version of scheduler component on the cluster, it does not attempt to install it again.

IBM Cloud Pak for Data

cpd_platform

Required.

This component is a prerequisite for installing any services.

The component ensures that the Cloud Pak for Data control plane is installed and running.

The component is installed once in each project (namespace) where you want to install the platform.

If the cpd-cli detects the minimum required version of cpd_platform in the project, it does not attempt to install it again.

Service component IDs

Identify the services that you want to upgrade or install:

Software	Component IDs	Notes
AI Factsheets	`factsheet`	Before you install this service, you must have one of the following services installed: Watson Knowledge Catalog (`wkc`) Watson Studio (`ws`)
Analytics Engine Powered by Apache Spark	`analyticsengine`	This service is automatically installed or upgraded if you install Watson Knowledge Catalog (`wkc`)
Cognos® Analytics	`cognos_analytics`
Cognos Dashboards	`cde`
Data Privacy	`dp`	Before you install or upgrade this service, you must have the following services installed or upgraded: Analytics Engine Powered by Apache Spark (`analyticsengine`), which is automatically installed by Watson Knowledge Catalog. Watson Knowledge Catalog (`wkc`) If you plan to run a batch installation or upgrade, specify the components in the following order: `wkc,dp`
Data Refinery	`datarefinery`	You do not need to specify the `datarefinery` component to install or upgrade Data Refinery. This service is automatically installed or upgraded if you install either of the following services: Watson Knowledge Catalog Watson Studio If you complete the following actions for either of these services, the Data Refinery objects are automatically included: Mirror images Create catalog sources or operator subscriptions
Data Replication	`replication`
DataStage® Enterprise	`datastage_ent`
DataStage Enterprise Plus	`datastage_ent_plus`
Db2®	`db2oltp`
Db2 Big SQL	`bigsql`
Db2 Data Gate	`datagate`
Db2 Data Management Console	`dmc`
Db2 Warehouse	`db2wh`
Decision Optimization	`dods`
EDB Postgres	`edb_cp4d` `postgresql`	The `postgresql` component is automatically installed when you install the `edb_cp4d` component.
Execution Engine for Apache Hadoop	`hee`
IBM® Match 360 with Watson	`match360`
Informix®	`informix_cp4d` `informix`	The `informix` component is automatically installed when you install the `informix_cp4d` component.
MongoDB	`mongodb` `mongodb_cp4d`	You must specify both components to install MongoDB. Specify the components in the following order: `mongodb,mongodb_cp4d`
OpenPages®	`openpages`
Planning Analytics	`planning_analytics`
Product Master	`productmaster`
RStudio® Server Runtimes	`rstudio`
SPSS® Modeler	`spss`
Voice Gateway	`voice_gateway`	You can install the Voice Gateway operator using the `apply-olm` command. However, Voice Gateway does not support the `apply-cr` command. You must use the `oc` command-line interface to create the Voice Gateway custom resource.
Watson Assistant	`watson_assistant`
Watson Discovery	`watson_discovery`
Watson Knowledge Catalog	`wkc`	When you install Watson Knowledge Catalog, the following services are automatically installed: Analytics Engine Powered by Apache Spark (`analyticsengine`) Data Refinery (`datarefinery`)
Watson Knowledge Studio	`watson_ks`	You can install the Watson Knowledge Studio operator using the `apply-olm` command. However, Watson Knowledge Studio does not support the `apply-cr` command. You must use the `oc` command-line interface to create the Watson Knowledge Studio custom resource.
Watson Machine Learning	`wml`	When you install Watson Machine Learning, the following features are automatically installed: AutoAI Federated Learning To use the experiment builder AIs for AutoAI and Federated Learning, you must have Watson Studio installed.
Watson Machine Learning Accelerator	`wml_accelerator`
Watson OpenScale	`openscale`
Watson Pipelines	`ws_pipelines`
Watson Query	`dv`
Watson Speech services	`watson_speech`
Watson Studio	`ws`	When you install Watson Studio, the following services are automatically installed: Data Refinery (`datarefinery`) Watson Studio Runtimes (`ws_runtimes`)
Watson Studio Runtimes	`ws_runtimes`	The default runtime is automatically installed or upgraded when you install or upgrade Watson Studio. Upgrades from Version 3.5 Do not specify the `ws_runtimes` component to upgrade existing runtimes. The existing runtimes are upgraded or replaced when you upgrade Watson Studio. If you want to use other runtimes on your environment, you must install them individually. Upgrades from Version 4.0, 4.5, or 4.6 If you want to upgrade all existing runtimes automatically when you upgrade Watson Studio, specify the `ws_runtimes` component when you upgrade Watson Studio. If you do not specify the `ws_runtimes` component when you upgrade Watson Studio, you must upgrade the non-default runtimes manually. Fresh installations on 4.6 Do not specify the `ws_runtimes` component when you install Watson Studio. The default runtime is automatically installed when you install Watson Studio. If you want to use non-default runtimes on your environment, you must install them individually. For details on how to install or upgrade non-default runtimes, see Watson Studio Runtimes. If you complete the following actions for Watson Studio, the Watson Studio Runtimes objects are automatically included: Mirror images Create catalog sources or operator subscriptions