Component IDs

When you run the cpd-cli manage commands, you must specify the components that you want to manage.

For example, You must specify the list of components when you:

Cluster-wide components

Cluster-wide components are installed once on the cluster and are shared by any instances of IBM Software Hub on the cluster. The cluster-wide components are prerequisites for IBM Software Hub.

Software Component ID Notes
IBM Cloud Pak foundational services Certificate manager ibm-cert-manager
A certificate manager is required.

The IBM Certificate manager is required if you upgraded from IBM Cloud Pak® for Data Version 4.8 or Version 5.0 to IBM Software Hub Version 5.2.

If you are installing IBM Software Hub Version 5.2, you must use the Red Hat® OpenShift® Container Platform cert-manager Operator.

IBM Cloud Pak foundational services License Service ibm-licensing
Required.

You are required to keep a record of the size of your deployments to report to IBM as requested. If you are using Container Licensing, you can use the License Service to measure software usage.

Scheduling service scheduler
Required if you plan to:
  • Use deep learning in Watson Machine Learning
  • Use the quota enforcement feature in IBM Software Hub

If neither of these scenarios applies to you, the scheduling service is optional but strongly recommended.

Required components for an instance

You must install the following components each time you install an instance of IBM Software Hub on the cluster.

Software Component ID Notes
IBM Cloud Pak foundational services cpfs This component is a prerequisite for installing IBM Software Hub.
IBM Software Hub cpd_platform This component is a prerequisite for installing services.

The cpd_platform component ensures that the IBM Software Hub control plane is installed and running.

IBM Software Hub control plane zen This component is a prerequisite for installing services.
Important: Do not specify the zen component to install or upgrade the control plane.

The component is automatically installed and upgraded by the cpd_platform component.

When you complete the following actions for the cpd_platform component, the zen component is automatically included:
  • Mirror images
  • Create OLM artifacts
  • Create operands

Services

You can choose which services to install in an instance of IBM Software Hub. Each service can be installed once per instance of IBM Software Hub.

For information about prerequisites, see Software requirements or run the list-prereqs command.

Service Component IDs Notes
AI Factsheets factsheet
Experiences
Cloud Pak for Data watsonx™
Automatically installed
This service is automatically installed if you install one of the following services:
  • watsonx.governance™ (watsonx_governance) with the enableFactsheet option.
Analytics Engine powered by Apache Spark analyticsengine
Experiences
Cloud Pak for Data Data Fabric watsonx watsonx.data™
Automatically installed
This service is automatically installed if you install one of the following services:
  • Data Privacy (dp)
  • Data Product Hub (dataproduct)
  • IBM Knowledge Catalog (wkc)
  • IBM Knowledge Catalog Premium (ikc_premium)
  • IBM Knowledge Catalog Standard(ikc_standard)
  • IBM Manta Data Lineage(datalineage)
  • watsonx BI (watsonx_bi_assistant)
  • watsonx.data (watsonx_data)
  • watsonx.data Premium (watsonx_data_premium)
  • watsonx.data intelligence (watsonx_dataintelligence)
Cognos Analytics cognos_analytics
Experiences
Pop-out
Cognos Dashboards dashboard
Experiences
Cloud Pak for Data
Data Gate datagate
Experiences
Cloud Pak for Data
Prerequisites

To provision an instance of this service, you must install one of the following services:

  • Db2 (db2oltp)
  • Db2 Warehouse (db2wh)
Data Privacy dp
Experiences
Cloud Pak for Data
Prerequisites

To install this service, you must install both of the following services:

  • Analytics Engine powered by Apache Spark (analyticsengine), which is automatically installed by IBM Knowledge Catalog.
  • IBM Knowledge Catalog (wkc) or IBM Knowledge Catalog Premium (ikc-premium)
Data Product Hub dataproduct
Experiences
Data Fabric Data Product Hub watsonx.data
Automatically installed dependencies

When you install Data Product Hub, the following services are automatically installed:

  • Analytics Engine powered by Apache Spark (analyticsengine)
  • Data Refinery (datarefinery)
Automatically installed
This service is automatically installed if you install one of the following services:
  • watsonx BI (watsonx_bi_assistant)
  • watsonx.data Premium (watsonx_data_premium)
  • watsonx.data intelligence (watsonx_dataintelligence) with the enableDataProduct option.
Data Refinery datarefinery
Experiences
Cloud Pak for Data Data Fabric watsonx watsonx.data
Automatically installed

This service is automatically installed if you install one of the following services:

  • Data Product Hub (dataproduct)
  • IBM Knowledge Catalog (wkc)
  • IBM Knowledge Catalog Premium (ikc_premium)
  • IBM Knowledge Catalog Standard (ikc_standard)
  • Watson Studio (ws)
  • watsonx.ai™ (watsonx_ai)
  • watsonx BI (watsonx_bi_assistant)
  • watsonx.data Premium (watsonx_data_premium)
  • watsonx.data intelligence (watsonx_dataintelligence)
Important: Do not specify the datarefinery component to install or upgrade Data Refinery.

The component is automatically installed and upgraded by the preceding components.

You cannot install or upgrade Data Refinery independently of these services.

If you complete the following actions for the preceding services, the Data Refinery objects are automatically included:
  • Mirror images
  • Create OLM artifacts
  • Create the operands
Data Replication replication
Experiences
Cloud Pak for Data
DataStage Enterprise datastage_ent
Experiences
Cloud Pak for Data Data Fabric watsonx.data
Automatically installed
This service is automatically installed if you install one of the following services:
  • IBM Knowledge Catalog (wkc)
  • IBM Knowledge Catalog Premium (ikc_premium)
  • watsonx BI (watsonx_bi_assistant)
  • watsonx.data Premium (watsonx_data_premium) with the Data Product option.
  • watsonx.data intelligence (watsonx_dataintelligence) with the Data Product option.
DataStage Enterprise Plus datastage_ent_plus
Experiences
Cloud Pak for Data
Data Virtualization dv
Experiences
Cloud Pak for Data
Automatically installed dependencies

When you install Data Virtualization, the following service is automatically installed:

  • Db2 Data Management Console (dmc)
Db2 db2oltp
Experiences
Cloud Pak for Data
Db2 Big SQL bigsql
Experiences
Cloud Pak for Data
Db2 Data Management Console dmc
Experiences
Cloud Pak for Data
Automatically installed

This service is automatically installed if you install Data Virtualization (dv).

However, you can install Db2 Data Management Console without installing Data Virtualization.

Db2 Warehouse db2wh
Experiences
Cloud Pak for Data
Decision Optimization dods
Experiences
Cloud Pak for Data watsonx
Prerequisites

To install this service, you must install both of the following services:

  • Watson Machine Learning (wml)
  • Watson Studio (ws)
EDB Postgres
  • edb_cp4d
  • postgresql
Experiences
Pop-out
Automatically installed dependencies

The postgresql component is automatically installed when you install the edb_cp4d component.

Execution Engine for Apache Hadoop hee
Experiences
Cloud Pak for Data watsonx
Prerequisites

To install this service, you must install both the following services:

  • Watson Studio (ws)
IBM Knowledge Catalog wkc
Experiences
Cloud Pak for Data
Automatically installed dependencies

When you install IBM Knowledge Catalog, the following services are automatically installed:

  • Analytics Engine powered by Apache Spark (analyticsengine)
  • Data Refinery (datarefinery)

If you plan to install the data quality feature, the service automatically installs the following service:

  • DataStage Enterprise (datastage_ent)

    If your cluster pulls images from a private container registry, ensure that you mirror the images for DataStage Enterprise (datastage_ent).

IBM Knowledge Catalog Premium ikc_premium
Experiences
Cloud Pak for Data Data Fabric watsonx.data
Automatically installed dependencies

When you install IBM Knowledge Catalog Premium, the following services are automatically installed:

  • Analytics Engine powered by Apache Spark (analyticsengine)
  • Data Refinery (datarefinery)

If you plan to install the data quality feature, the service automatically installs the following service:

  • DataStage Enterprise (datastage_ent)

    If your cluster pulls images from a private container registry, ensure that you mirror the images for DataStage Enterprise (datastage_ent).

Automatically installed
This service is automatically installed if you install one of the following services:
  • watsonx BI (watsonx_bi_assistant)
  • watsonx.data Premium (watsonx_data_premium)
  • watsonx.data intelligence (watsonx_dataintelligence) with the enableDataGovernanceCatalog option.
IBM Knowledge Catalog Standard ikc_standard
Experiences
Cloud Pak for Data
Automatically installed dependencies

When you install IBM Knowledge Catalog Standard, the following services are automatically installed:

  • Analytics Engine powered by Apache Spark (analyticsengine)
  • Data Refinery (datarefinery)
IBM Manta Data Lineage datalineage
Experiences
Cloud Pak for Data Data Fabric watsonx.data
Prerequisites

To install this service, you must install one the following services:

  • IBM Knowledge Catalog (wkc)
  • IBM Knowledge Catalog Premium (ikc_premium)
  • IBM Knowledge Catalog Standard (ikc_standard)
Automatically installed
This service is automatically installed if you install one of the following services:
  • watsonx BI (watsonx_bi_assistant)
  • watsonx.data Premium (watsonx_data_premium)
  • watsonx.data intelligence (watsonx_dataintelligence)with the enableDataLineage option.
IBM Match 360 match360
Experiences
Cloud Pak for Data
IBM StreamSets streamsets
Experiences
Pop-out
Informix
  • informix_cp4d
  • informix
Experiences
Pop-out
Automatically installed dependencies

The informix component is automatically installed when you install the informix_cp4d component.

MANTA Automated Data Lineage mantaflow
Experiences
Cloud Pak for Data
Prerequisites

To install this service, you must install one of the following services:

  • IBM Knowledge Catalog
  • IBM Knowledge Catalog Premium
  • IBM Knowledge Catalog Standard
MongoDB
  • mongodb
  • mongodb_cp4d
Experiences
Pop-out
Automatically installed dependencies

The mongodb component is automatically installed when you install the mongodb_cp4d component.

OpenPages openpages
Experiences
Cloud Pak for Data watsonx
Automatically installed
This service is automatically installed if you install one of the following services:
  • watsonx.governance (watsonx_governance) with the enableOpenpages option.
Orchestration Pipelines ws_pipelines
Experiences
Cloud Pak for Data watsonx
Planning Analytics planning_analytics
Experiences
Pop-out
Product Master productmaster
Experiences
Pop-out
RStudio® Server Runtimes rstudio
Experiences
Cloud Pak for Data watsonx
Prerequisites

To install this service, you must install the following service:

  • Watson Studio (ws)
SPSS Modeler spss
Experiences
Cloud Pak for Data watsonx
Prerequisites

To install this service, you must install the following service:

  • Watson Studio (ws)
Synthetic Data Generator syntheticdata
Experiences
watsonx
Prerequisites

To install this service, you must install the following service:

  • watsonx.ai (watsonx_ai)
Unstructured Data Integration udp
Experiences
watsonx
Prerequisites

To install this service, you must install the following services:

  • watsonx.ai (watsonx_ai)
  • watsonx.data (watsonx_data)
  • watsonx.data intelligence (watsonx_dataintelligence)
Automatically installed
This service is automatically installed if you install one of the following service:
  • watsonx.data Premium (watsonx_data_premium)
Voice Gateway voice_gateway
Experiences
API
Prerequisites
To install this service, you must install the following services:
  • watsonx Assistant (watson_assistant)
  • Watson Speech to Text (watson_speech)
  • Watson Text to Speech (watson_speech)
Watson Discovery watson_discovery
Experiences
Pop-out
Watson Machine Learning wml
Experiences
Cloud Pak for Data watsonx
Prerequisites

To use the Deep Learning experiments, you must install the following cluster-wide component:

  • Scheduling service (scheduler)

To use the experiment builder for AutoAI, you must install the following service:

  • Watson Studio (ws)
Watson OpenScale openscale
Experiences
Cloud Pak for Data watsonx
Prerequisites

To install this service, you must have an external database or you must install one of the following services:

  • Db2 (db2oltp)
  • Db2 Warehouse (db2wh)
  • EDB Postgres (edb_cp4d)
Automatically installed
This service is automatically installed if you install one of the following services:
  • watsonx.governance (watsonx_governance) with the enableOpenscale option.
Watson Speech services watson_speech
Experiences
API
Watson Studio ws
Experiences
Cloud Pak for Data watsonx watsonx.data
Automatically installed dependencies

When you install Watson Studio, the following services are automatically installed:

  • Data Refinery (datarefinery)
  • Watson Studio Runtimes (ws_runtimes)
If you complete the following actions for Watson Studio, the Data Refinery objects and Watson Studio Runtimes objects are automatically included:
  • Mirror images
  • Create OLM artifacts
  • Create the operands
Watson Studio Runtimes ws_runtimes
Experiences
Cloud Pak for Data watsonx watsonx.data
Automatically installed

The default runtime is automatically installed or upgraded when you install or upgrade Watson Studio.

Fresh installations
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.

Upgrades
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, only the default runtime is upgraded. You must upgrade the non-default runtimes manually.

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 OLM artifacts
watsonx.ai watsonx_ai
Experiences
watsonx
Automatically installed dependencies

When you install watsonx.ai, the following services are automatically installed:

  • Watson Studio (ws)
  • Watson Machine Learning (wml)
Automatically installed
This service is automatically installed if you install one of the following service:
  • watsonx Code Assistant™ for Red Hat Ansible® Lightspeed (wca_ansible)
watsonx Assistant watson_assistant
Experiences
Pop-out
watsonx BI watsonx_bi_assistant
Experiences
Business Intelligence
Prerequisite services
To install this service, you must install the following service:
  • watsonx.data intelligence (watsonx_dataintelligence)
watsonx Code Assistant wca
Experiences
Code Assistant™
watsonx Code Assistant for Red Hat Ansible Lightspeed wca_ansible
Experiences
Code Assistant
Automatically installed dependencies

When you install watsonx Code Assistant for Red Hat Ansible Lightspeed, the following services are automatically installed:

  • watsonx.ai (watsonx_ai)
watsonx Code Assistant for Z wca_z
Experiences
Code Assistant
watsonx Code Assistant for Z Agentic wca_z_agentic
Experiences
Code Assistant
Prerequisite services
To install this service, you must install the following service:
  • watsonx Code Assistant for Z (wca_z)
Automatically installed dependencies

When you install watsonx Code Assistant for Z Agentic, the following services are automatically installed:

  • watsonx Code Assistant for Z Code Explanation (wca_z_ce)
  • watsonx Code Assistant for Z Code Generation (wca_z_cg)
watsonx Code Assistant for Z Code Explanation wca_z_ce
Experiences
Code Assistant
watsonx Code Assistant for Z Code Generation wca_z_cg
Experiences
Code Assistant
watsonx.data watsonx_data
Experiences
Pop-out
Automatically installed dependencies

When you install watsonx.data, the following services are automatically installed:

  • Analytics Engine powered by Apache Spark (analyticsengine)
watsonx.data Premium watsonx_data_premium
Experiences
watsonx.data
Automatically installed dependencies

When you install watsonx.data Premium, the following services are automatically installed:

  • Unstructured Data Integration
  • watsonx.data intelligence (watsonx_dataintelligence) including:
    • Data Product Hub (dataproduct)
    • DataStage Enterprise (datastage_ent)
    • IBM Knowledge Catalog Premium (ikc_premium)
    • IBM Manta Data Lineage (datalineage)
watsonx.data intelligence watsonx_dataintelligence
Experiences
Data Fabric watsonx.data
Automatically installed dependencies
When you install watsonx.data intelligence, the following services are automatically installed:
  • Data Product Hub (dataproduct) with the enableDataProduct option.
  • DataStage Enterprise (datastage_ent) with the enableDataQuality option.
  • IBM Knowledge Catalog Premium (ikc_premium) with the enableDataGovernanceCatalog option.
  • IBM Manta Data Lineage (datalineage) with the enableDataLineage option.
watsonx.governance watsonx_governance
Experiences
watsonx
Automatically installed dependencies

When you install watsonx.governance, the following services are automatically installed:

  • AI Factsheets (factsheet) with the enableFactsheet option.
  • OpenPages (openpages) with the enableOpenpages option.
  • Watson Machine Learning (wml)
  • Watson OpenScale (openscale) with the enableOpenscale option.
watsonx Orchestrate watsonx_orchestrate
Experiences
Pop-out
Automatically installed dependencies

When you install watsonx Orchestrate, the following services are automatically installed:

  • watsonx Assistant (watson_assistant)
  • watsonx.data (watsonx_data)

Shared components (automatically installed dependencies)

If required, the following components are automatically installed once per project (Kubernetes namespace). The shared components are installed if you install a service that requires them.

For information about which services require each component, see Software requirements or run the list-dependents command.

Software Component ID Notes
Canvas canvasbase Several services require:
  • An interface for creating flows
  • An API to manage the flows
  • An API to manage jobs generated by the flows
These features are provided by the Canvas component.
Common core services ccs Several services require similar features and interfaces. To streamline the platform, these features are provided by the common core services.
The common core services provide:
  • Data source connections
  • Deployment management
  • Job management
  • Notifications
  • Projects
  • Search
Db2 as a service db2aaservice Several services use Db2 as a service to create an embedded datastore within the service. The datastore is a secured and restricted. Only the service that creates the datastore can access it.
Db2U db2u The Db2U operator is a prerequisite for Db2, Db2 Warehouse, and Db2 as a service.

The operator can watch Db2-based service instances in multiple projects (namespaces).

watsonx Code Assistant base wca_base