Determining which components to install

IBM Cloud Pak® for Data is comprised of numerous components so that you can install the specific services that support your needs. Before you install Cloud Pak for Data, determine which components you need to install.

You can use this information to complete Setting up installation environment variables.

Installation phase
You are not here. Setting up a client workstation
You are here icon. Collecting required information
You are not here. Preparing your cluster
You are not here. Installing the Cloud Pak for Data platform and services
Who needs to complete this task?
Everyone involved in installing 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:
  • Mirroring images to a private container registry
  • Installing the Cloud Pak for Data software on your cluster

Options for installing components

You have two options for installing the components:

Option Benefits Drawbacks
Install each component individually If you feel more comfortable running installs one at a time, this option gives you more granular control over the install process.
Note: All of the services that you install 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.
Install multiple components at the same time You can complete the installation in fewer steps. There are no known drawbacks associated with this option.

If you encounter an issue when installing a specific component, the cpd-cli gives you the option to resume your install from the point of failure.

Required components

At a minimum, you must install the following components:

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.
Important: The sequence in which you install the components is important.
Batch installs
If you plan to install all of the components at the same time, ensure that the components are specified in the following order:
--components=cpfs,scheduler,cpd_platform,<component-ID>...

If you don't plan to install the scheduling service, you can remove it from the list of components.

Individual component installs
If you plan to install each component individually, ensure that you install the components in the following order:
  1. cpfs
  2. scheduler

    If you don't plan to install the scheduling service, you can skip this step.

  3. cpd_platform

The other components that you install depend on your use case. If you are installing the services required to support a particular solution, see the appropriate section for the solution.

If you are designing your own solution, see All services.

Components for the Business Analytics solution

The Business Analytics solution supports several use cases. The services that you install depend on the use cases that you want to implement:

Business Intelligence
Software Component ID
Cognos® Analytics cognos_analytics
Planning, Budgeting, and Forecasting
Software Component ID
Planning Analytics planning_analytics

Components for the Customer Care solution

The Customer Care solution supports several use cases. The services that you install depend on the use cases that you want to implement:

Content Intelligence
Software Component ID
Watson Discovery watson_discovery
Conversational AI
Software Component ID
Watson Assistant watson_assistant
Speech
Software Component ID
Watson Speech services watson_speech

Components for the Data Fabric solution

The Data Fabric supports several use cases. The services that you install depend on the use cases that you want to implement:
Customer 360
Software Component ID Notes
IBM® Match 360 with Watson match360  
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 Query dv  
Optional components
If you want to use dashboards to share analytics results, you can optionally install the Cognos Dashboards component:
Software Component ID
Cognos Dashboards cde
Data Governance and Privacy
Software Component ID Notes
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
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 Query dv  
MLOps and Trustworthy AI
Software Component ID 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)
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 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 OpenScale openscale  
Watson Pipelines ws_pipelines  
Watson Studio ws When you install Watson Studio, the following services are automatically installed:
  • Data Refinery (datarefinery)
  • Watson Studio Runtimes (ws_runtimes)
Multicloud Data Integration
Software Component ID Notes
DataStage® Enterprise datastage_ent  
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 Query dv  
Optional components
If you want to use QualityStages, such as the Address Verification stage, you can optionally upgrade from DataStage Enterprise to DataStage Enterprise Plus:
Software Component ID
DataStage Enterprise Plus datastage_ent_plus

Components for the Data Management solution

The Data Management solution includes a variety of data storage options. Choose the components that support your business needs:

Analytics data sources
Software Component ID
Db2® Warehouse db2wh
Watson Query dv
Transactional data sources
Software Component ID
Db2 db2oltp
Informix® informix_cp4d
OEM data sources
Software Component ID
EDB Postgres edb_cp4d
MongoDB mongodb_cp4d

All services

You can install a custom set of services based on your business needs.

Recommendation: If you install Watson Assistant, Watson Discovery, or Watson Speech services, install these services in a separate Cloud Pak for Data instance from other services. With two separate Cloud Pak for Data instances, you can create backups of each instance independently of each other.
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