Determining which components to install

IBM® Software Hub supports numerous solutions and services. Before you install IBM Software Hub, determine which components you need to install to support your business requirements.

Installation phase
  • You are not here. Setting up a client workstation
  • You are not here. Setting up a cluster
  • You are here icon. Collecting required information
  • You are not here. Preparing to run installs in a restricted network
  • You are not here. Preparing to run installs from a private container registry
  • You are not here. Preparing the cluster for IBM Software Hub
  • You are not here. Preparing to install an instance of IBM Software Hub
  • You are not here. Installing an instance of IBM Software Hub
  • You are not here. Setting up the control plane
  • You are not here. Installing solutions and services
Who needs to complete this task?

Operations team The IBM Software Hub operations team should determine which components will be installed on the cluster.

When do you need to complete this task?

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

  • Mirror images to a private container registry.
  • Prepare your cluster for IBM Software Hub.
  • Install IBM Software Hub on your cluster.

Repeat as needed You might need to repeat this task if you plan to deploy multiple instances of IBM Software Hub, especially if the instances will be installed on different clusters or will include different services.

Before you begin

Before you determine which components you plan to install, review the following guidance:

Guidance for clusters with multiple instances of IBM Software Hub
Some components, such as the scheduling service, are cluster-wide resource that can be installed exactly once per cluster. If you are installing multiple instances of IBM Software Hub on the same cluster, it is strongly recommended that you install these cluster-wide components at the same release as the latest version of IBM Software Hub on the cluster.

For example, if you have one instance of IBM Software Hub at Version 5.2.0 and one instance of IBM Software Hub at Version 5.2.2, install the cluster-wide components at Version 5.2.2.

Version support
Important: All of the components that are associated with an instance of IBM Software Hub must be installed at the same version. You cannot install services from different releases of IBM Software Hub in the same instance.
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 installation process. You must complete more steps to successfully install the software on your environment.

This method also takes longer to complete.
Install multiple components at the same time. You can:
  • Complete the installation in fewer steps.
  • Run parallel installations of some components, which reduces installation time.
 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.

About this task

The components are grouped into the following categories:
Cluster-wide components
These components can be installed exactly once on the cluster and are shared by all instances of IBM Software Hub on the cluster. Some of these components are optional but strongly recommended.
IBM Software Hub Control Center
IBM Software Hub Control Center (Control Center) is an optional component that can be installed exactly once on a cluster. You can install Control Center on the same cluster as IBM Software Hub or on a different cluster.

Control Center is recommended for environments with multiple instances of IBM Software Hub on the same cluster.

Platform components
These components must be installed each time you install an instance of IBM Software Hub:
  • IBM Cloud Pak foundational services
  • IBM Software Hub control plane
Services
Services are the components that enable you to complete specific tasks. Install the services that support your business requirements.

Procedure

To determine which components to install:

  1. Identify which cluster-wide components to install on the cluster:
    Cluster-wide component Notes
    IBM Certificate manager Deprecated The IBM Cloud Pak foundational services Certificate manager is deprecated.

    Install the Red Hat® OpenShift® Container Platform cert-manager Operator instead.

    Important: If the Red Hat OpenShift Container Platform cert-manager Operator (or another certificate manager) is not installed, the IBM Certificate manager is automatically installed or upgraded when you run the apply-cluster-components command.
    License Service The IBM Cloud Pak foundational services License Service is 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 your usage.
    Scheduling service The scheduling service is required if you plan to use:
    • The quota enforcement feature in IBM Software Hub
    • The node scoring feature for pod placement
    • Deep learning experiment builder in the Watson Machine Learning service
    • Priority scheduling and co-scheduling in the Analytics Engine powered by Apache Spark service
    • Remote physical locations

      If you plan to use remote physical locations, you must install the scheduling service on the primary cluster and on the remote cluster where you plan to create the remote physical location.

    If none of these scenarios applies to you, the scheduling service is optional but strongly recommended.
  2. Decide whether you want to install IBM Software Hub Control Center:
    Control Center can be installed on the same cluster as IBM Software Hub or on a different cluster.
  3. Identify which services you plan to install in the IBM Software Hub instance.
    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)

What to do next

Now that you've determined which components to install, you're ready to complete Determining which models and optional images to mirror to your private container registry.