IBM Software Hub

https://www.ibm.com/docs/en/software-hub
Admin
IBM Software Hub is a central documentation portal providing access to resources, support, fixes,...
Tokens:2,408,651
Snippets:22,765
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Setup IBM Software Hub Instance with cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=hub-installing-software

Initiates the setup process for an IBM Software Hub instance. This command is typically run after initial installation and configuration.

```bash
cpd-cli manage setup-instance
```

--------------------------------

### Install watsonx.data & watsonx.ai with Portworx Storage

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=premium-installing

Installs watsonx.data Premium and watsonx.ai components using the `cpd-cli`. This example specifically configures Portworx as the storage vendor. It requires specifying release version, namespaces, and image pull details.

```bash
cpd-cli manage install-components \
--components=watsonx_data_premium,watsonx_ai \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Installation Parameter File Template

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=services-specifying-installation-options

This template serves as a starting point for configuring installation parameters for various IBM services. It includes sections for overriding component metadata and non-OLM configurations, with commented examples for services like Data Replication, Voice Gateway, watsonx BI, and Analytics Engine powered by Apache Spark. Users need to uncomment and populate the relevant sections.

```yaml
################################################################################
# Installation parameter file
################################################################################

override_components_meta:

# ............................................................................
# Data Replication parameters
# Uncomment "replication:" and specify the required parameter
# ............................................................................
#  replication:

# ............................................................................
# Voice Gateway parameters
# Uncomment "voice_gateway:" and specify the parameters to override
# ............................................................................
#  voice_gateway:

# ............................................................................
# watsonx BI parameters
# Uncomment "watsonx_bi_assistant:" and specify the parameters to override
# ............................................................................
#  watsonx_bi_assistant:


non_olm:

# ............................................................................
# Analytics Engine powered by Apache Spark parameters

```

--------------------------------

### Preview IBM Software Hub Instance Topology Setup

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=manage-setup-instance-topology

This command previews the `oc` commands that would be executed to set up the instance topology for IBM Software Hub. It uses the same parameters as the direct setup command but with an added `--preview=true` flag.

```bash
cpd-cli manage setup-instance-topology \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--additional_ns=${PROJECT_CPD_INSTANCE_TETHERED_LIST} \
--license_acceptance=true \
--preview=true
```

--------------------------------

### View Installed Data Replication Licenses with oc get

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=administering-extending-data-replication-capabilities

This command allows you to view currently installed Data Replication licenses on your OpenShift cluster. It uses the `oc get replicationextensions` command. Short form alternatives like `replextns` can also be used.

```bash
oc get replicationextensions
```

--------------------------------

### Install Watson Studio Components with cpd-cli (Various Storage Options)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=studio-installing

Installs the Watson Studio operator and custom resource using the `cpd-cli manage install-components` command. The specific command varies based on the storage provider (e.g., Red Hat OpenShift Data Foundation, IBM Fusion, Portworx, NFS, AWS EFS, NetApp Trident). Essential parameters include license acceptance, components to install, release version, operator and instance namespaces, and storage class configurations.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

--------------------------------

### Install Specialized User Own Model (SYOM)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=services-specifying-installation-options

Configures the installation of a specialized model tuned for watsonx Orchestrate. This option requires foundation models to be installed on the same cluster and specific installation modes ('agentic_assistant' or 'agentic_skills_assistant'). The example shows installing 'ibm-granite-8b-unified-api-model-v2'.

```yaml
syomModels: [ibm-granite-8b-unified-api-model-v2]
```

--------------------------------

### Set up NFS Provisioner using cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=storage-setting-up-amazon-elastic-file-system

Runs the `cpd-cli manage setup-nfs-provisioner` command to set up dynamic provisioning for EFS. This command uses the previously configured environment variables.

```bash
cpd-cli manage setup-nfs-provisioner \
--nfs_server=${EFS_LOCATION} \
--nfs_path=${EFS_PATH} \
--nfs_provisioner_ns=${PROJECT_NFS_PROVISIONER} \
--nfs_storageclass_name=${EFS_STORAGE_CLASS} \
--nfs_provisioner_image=${NFS_IMAGE}
```

--------------------------------

### Install R Packages

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=image-adding-customizations-images

Installs R packages from CRAN or a tar.gz file into the specified conda environment. This example shows how to install the 'foreign' package.

```bash
#!/bin/bash
set -e -o pipefail
source activate $DSX_KERNEL_CONDENV
# subsequent commands affect the conda environment for user code
# ========================================================
# Install R packages from CRAN or tar.gz file or conda repository
# below example installed foreign test package
# users can add any other additional packages similar way
```

--------------------------------

### Install Software Hub with NFS Storage (Custom Options)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=pipelines-installing

Installs the Software Hub components using NFS storage with custom installation options from a parameter file. This command requires license acceptance and includes details for release, namespaces, storage classes, and image pulling, along with the parameter file path. For NFS, block and file storage classes usually refer to the same storage class.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws_pipelines \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Create PersistentVolumeClaim for OpenSearch

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=install-installing-opensearch

Creates a PersistentVolumeClaim (PVC) for OpenSearch using a YAML definition. This ensures persistent storage for the OpenSearch cluster. Users need to update the namespace and storage class name as applicable. The provided examples create three PVCs for a cluster setup.

```bash
cat <<EOF| oc apply -f -
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: opensearch-cluster-master-opensearch-cluster-master-0
  namespace: ${PROJECT_CPD_INST_OPERANDS}
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 2Gi
  storageClassName: <Any supported storage class>
  volumeMode: Filesystem
EOF
```

```bash
cat <<EOF| oc apply -f -
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: opensearch-cluster-master-opensearch-cluster-master-1
  namespace: ${PROJECT_CPD_INST_OPERANDS}
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 2Gi
  storageClassName: <Any supported storage class>
  volumeMode: Filesystem
EOF
```

```bash
cat <<EOF| oc apply -f -
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: opensearch-cluster-master-opensearch-cluster-master-2
  namespace: ${PROJECT_CPD_INST_OPERANDS}
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 2Gi
  storageClassName: <Storage class>
  volumeMode: Filesystem
EOF
```

--------------------------------

### Install Watson Discovery with Portworx Storage (Default)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=discovery-installing

Installs Watson Discovery with Portworx storage using default settings. Requires specifying components, release version, namespaces, and image details. Does not use a parameter file.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watson_discovery \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

--------------------------------

### Dockerfile for PVC Monitor Application

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=monitors-example-creating-pvc-custom-monitor

This Dockerfile defines the environment for running the Python PVC monitoring script. It uses a Python base image, sets up a working directory, copies the application files, installs dependencies from requirements.txt, and specifies the command to run the script upon container start.

```dockerfile
# set base image (host OS)
FROM python:3.8
RUN mkdir /pvc-monitor
# set the working directory in the container
WORKDIR /pvc-monitor
ADD . /pvc-monitor
# install dependencies
RUN pip install -r requirements.txt
# command to run on container start
CMD [ "python", "./pvc-monitor.py" ]

```

--------------------------------

### Install Out-of-the-Box (OOTB) Models

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=services-specifying-installation-options

Specifies which out-of-the-box general models to install for watsonx Orchestrate. This is only valid if foundation models are installed on the same cluster. Examples include 'ibm-slate-30m-english-rtrvr', 'granite-3-8b-instruct', and 'llama-3-1-70b-instruct'. Multiple models can be installed by providing a comma-separated list.

```yaml
ootbModels: [ibm-slate-30m-english-rtrvr]

```

```yaml
ootbModels: [granite-3-8b-instruct]

```

```yaml
ootbModels: [llama-3-1-70b-instruct]

```

```yaml
ootbModels: [llama-3-2-90b-vision-instruct]

```

```yaml
ootbModels: [ibm-slate-30m-english-rtrvr,llama-3-2-90b-vision-instruct]
```

--------------------------------

### Setup IBM Software Hub Instance Topology (cpd-cli)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=manage-setup-instance-topology

The `setup-instance-topology` command prepares projects for IBM Software Hub by installing foundational services and configuring the `NamespaceScope` operator. It requires specific roles and must be run after `authorize-instance-topology`. This command is deprecated.

```bash
cpd-cli manage setup-instance-topology \
--release=<version> \
--cpd_operator_ns=<project-name> \
--cpd_instance_ns=<project-name> \
--license_acceptance=true|false \
[--block_storage_class=<RWO-storage-class>] \
[--additional_ns=<comma-separated-list-of-project-names>] \
[--case_download=true|false] \
[--from_oci=true|false] \
[--oci_location=<registry-URL>] \
[--catsrc=true|false] \
[--sub=true|false] \
[--skip_components=<comma-separated-list-of-component-names>] \
[--preview=true|false] \
[--print_rbac=true|false] \
[-v][-vv][-vvv]
```

--------------------------------

### Install License Service with cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=cluster-installing-shared-components

Installs the License Service for IBM Software Hub. It accepts the license, specifies the release version, and the namespace for the license service. The --preview=true option can be used to generate a script of the 'oc' commands.

```bash
cpd-cli manage apply-cluster-components \
--release=${VERSION} \
--license_acceptance=true \
--licensing_ns=${PROJECT_LICENSE_SERVICE}
```

--------------------------------

### Install Azure CLI using curl

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=images-accessing-azure-storage-azcopy-cli

Installs the Azure CLI tool by downloading and executing an installation script. This is a prerequisite for interacting with Azure services from the command line.

```bash
curl -L https://aka.ms/InstallAzureCli | bash
```

--------------------------------

### Preview Component Installation for Portworx Storage with cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=manage-install-components

Previews the commands required to install specified components on a cluster configured with Portworx storage. This command uses `cpd-cli manage install-components` with the `--storage_vendor=portworx` and `--preview=true` flags, alongside other necessary installation parameters. It's useful for understanding the installation process without executing it.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=${COMPONENTS} \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--preview=true
```

--------------------------------

### Install Teradata Tools & Utilities in Dockerfile

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=administering-building-custom-images-install-odbc-drivers

This Dockerfile snippet shows the installation of Teradata Tools & Utilities. It downloads a tarball, extracts it, and runs a setup script to install the necessary components. The driver itself is not explicitly enabled in this snippet.

```Dockerfile
FROM <modeler_runtime image> as custom-teradata-runtime
USER root
# Install Teradata Tools & Utilities
ADD TeradataToolsAndUtilitiesBase__linux_x8664.17.20.05.00-1.tar.gz /opt
RUN cd /opt/TeradataToolsAndUtilitiesBase && \
    ./setup.sh a && \
    cd /opt && \
    rm -rf /opt/TeradataToolsAndUtilitiesBase*
```

--------------------------------

### watsonx BI installation options configuration (YAML)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=bi-installing

This YAML snippet shows how to specify installation options for watsonx BI in an `install-options.yml` file. It includes the `override_components_meta` section with `watsonx_bi_assistant` and a placeholder for license information.

```yaml
# ............................................................................
# watsonx BI parameters

```

--------------------------------

### Install and Enable SAP Hana ODBC Driver in Dockerfile

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=administering-building-custom-images-install-odbc-drivers

This Dockerfile example demonstrates how to install the SAP Hana client and enable its ODBC driver. It involves downloading a tarball, running an installation script, and updating the odbcinst.ini file.

```Dockerfile
FROM <modeler_runtime image> as custom-hana-runtime
USER root
# Install SAP Hana driver
RUN mkdir -p /opt/sap
ADD hanaclient-2.7.26-linux-x64.tar.gz /opt/sap
RUN /opt/sap/client/hdbinst --path=/opt/sap/hdbclient
# enable SAP Hana
RUN sed -i '2iSAP HANA Client=Installed' ${SDAPDRIVER_HOME}/odbcinst.ini
USER modeler-user
```

--------------------------------

### Example COMPONENTS Environment Variable Configuration

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=information-setting-up-installation-environment-variables

Demonstrates how to configure the `COMPONENTS` environment variable, which is a comma-separated list of components to install or upgrade. The example shows the default components and how they are formatted.

```shell
ibm-licensing,scheduler,cpd_platform
```

--------------------------------

### Create IBM Knowledge Catalog Premium custom resource (custom options) using cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=upgrading-knowledge-catalog-premium

This command creates the custom resource for IBM Knowledge Catalog Premium with custom installation options specified in a parameter file. It uses the `cpd-cli manage apply-cr` command with the `--components=ikc_premium` flag, including the `--param-file` argument for installation options, release version, operand namespace, and license acceptance.

```bash
cpd-cli manage apply-cr \
--components=ikc_premium \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true
```

--------------------------------

### Get Spark Job Details using cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=sparkjob-wx-data-get

This command retrieves detailed information about a specific Spark job running on IBM Cloud Pak for Data. It requires the application ID, engine ID, and instance ID of the job. Ensure the cpd-cli is installed and configured to connect to your Cloud Pak for Data instance.

```bash
cpd-cli wx-data sparkjob
get \
--application-id 45627-9387-04c8 \
--engine-id spark01 \
--instance-id 1735472262311515
```

--------------------------------

### Install Software Hub with Portworx Storage (Custom Options)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=pipelines-installing

Installs the Software Hub components using Portworx storage with custom installation options specified in a parameter file. This command requires license acceptance and includes details for release, namespaces, storage, and image pulling, along with the path to the parameter file.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=ws_pipelines \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Set up NFS Dynamic Provisioning

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=storage-setting-up-dynamic-provisioning

Runs the cpd-cli command to set up dynamic NFS provisioning using the previously configured environment variables. This command deploys the NFS provisioner.

```bash
cpd-cli manage setup-nfs-provisioner \
--nfs_server=${NFS_SERVER_LOCATION} \
--nfs_path=${NFS_PATH} \
--nfs_provisioner_ns=${PROJECT_NFS_PROVISIONER} \
--nfs_storageclass_name=${NFS_STORAGE_CLASS} \
--nfs_provisioner_image=${NFS_IMAGE}
```

--------------------------------

### Example Export Status Message (JSON)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=data-exporting-from-information-server-system

An example of the JSON output from the export status file. It includes the final status, start and completion times, a success message, and the percentage of completion.

```json
{"status":"succeeded","startTime":1700040848,"completionTime":1700041206,"message":"export is successfully completed.","percentageCompleted":100}
```

--------------------------------

### Get Runtime Definitions GUID (curl)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=administering-updating-deleting-custom-runtime-definitions

Retrieves a list of available runtime definitions and their GUIDs. This command requires an authorization token and the CPD_URL environment variable to be set. It outputs the name and GUID for each runtime definition.

```shell
curl -k -X GET -H "Authorization: ZenApiKey ${TOKEN}" "${CPD_URL}/v2/runtime_definitions" | jq -r '.resources[] | "\(.entity.name) -- \(.metadata.guid)"'
```

--------------------------------

### Install Product Master with Portworx Storage (cpd-cli)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=master-installing

Installs Product Master components using cpd-cli with Portworx as the storage vendor. Requires license acceptance and component details. Image pull details are also specified.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

--------------------------------

### Install and Enable Exasol ODBC Driver in Dockerfile

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=administering-building-custom-images-install-odbc-drivers

This Dockerfile snippet illustrates the installation of the Exasol ODBC driver. It downloads a tarball, extracts it, and then configures the odbcinst.ini file to enable the driver. It starts from a base modeler runtime image.

```Dockerfile
FROM <modeler_runtime image> as custom-exasol-runtime
USER root
# Install Exasol driver
RUN mkdir -p /opt/exasol
ADD EXASOL_ODBC-7.1.4.tar.gz /opt/exasol
RUN mv /opt/exasol/EXASOL_ODBC-7.1.4/* /opt/exasol && \
    rm -rf /opt/exasol/EXASOL_ODBC-7.1.4
# enable Exasol
RUN sed -i '2iEXASolution Driver=Installed' ${SDAPDRIVER_HOME}/odbcinst.ini
USER modeler-user
```

--------------------------------

### Setup IBM Software Hub Instance Topology

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=manage-setup-instance-topology

This command sets up the instance topology for installing IBM Software Hub. It requires release version, operator namespace, operand namespace, and optional additional namespaces. It also accepts a license acceptance flag.

```bash
cpd-cli manage setup-instance-topology \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--additional_ns=${PROJECT_CPD_INSTANCE_TETHERED_LIST} \
--license_acceptance=true
```

--------------------------------

### Install watsonx.data integration with Portworx storage (custom)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=integration-installing

Installs watsonx.data integration components using Portworx storage with custom settings. Includes all parameters from the default installation plus a parameter file for custom options.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Set Channel Version for Red Hat OpenShift AI Installation

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=software-installing-red-hat-openshift-ai

Sets the CHANNEL_VERSION environment variable to specify the desired version of Red Hat OpenShift AI to install. Example provided for version 2.25.

```bash
export CHANNEL_VERSION=stable-2.25
```

--------------------------------

### Install Watson Discovery with Portworx Storage (Custom)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=discovery-installing

Installs Watson Discovery with Portworx storage using custom settings defined in a parameter file. Requires specifying components, release version, namespaces, image details, and the path to the parameter file.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watson_discovery \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Check Scheduling Service Installation using oc get scheduling

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=cluster-upgrading-shared-components

This command verifies if the scheduling service is installed on your cluster and retrieves its project and version information. If no output is returned, the service is not installed. Ensure the 'scheduler' component is included in your environment variables.

```bash
oc get scheduling -A
```

--------------------------------

### Install Watsonx.data (Default)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=watsonxdata-installing

Installs Watsonx.data with default settings, requiring license acceptance and specifying component, release, namespaces, storage classes, and image details. This command is used when no custom installation options file is provided.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_data \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

--------------------------------

### Install watsonx.data integration with Portworx storage (default)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=integration-installing

Installs watsonx.data integration components using Portworx storage with default settings. Requires specifying license acceptance, components, release version, operator and instance namespaces, and image pull details.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

--------------------------------

### Configure Voice Gateway Installation Options (YAML)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=services-specifying-installation-options

This snippet illustrates the structure for configuring Voice Gateway installation options. While the provided example is a placeholder, it indicates that parameters for Voice Gateway should be added under the 'voice_gateway' entry within the 'override_components_meta' section of the install-options.yml file.

```yaml
# ............................................................................
# Voice Gateway parameters
# ............................................................................
  voice_gateway:
```

--------------------------------

### Install jq for ppc64le

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=software-installing-configuring-oadp-utility

Downloads, makes executable, and installs the jq JSON command-line utility for ppc64le architecture. This utility is required by some OADP scripts and commands.

```bash
wget -O jq https://github.com/jqlang/jq/releases/download/jq-1.7.1/jq-linux-ppc64el
```

```bash
chmod +x ./jq
```

```bash
cp jq /usr/local/bin
```

--------------------------------

### Get watsonx Orchestrate Component Status (Shell)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=issues-watsonx-orchestrate

Retrieves the status of the watsonx Orchestrate components. This command is used to validate that the upgrade or installation process has completed successfully after applying fixes.

```shell
cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=watsonx_orchestrate
```

--------------------------------

### Example Anaconda Repository Upgrade Command

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=data-upgrading

An example of the default upgrade command, demonstrating how to replace placeholders with actual domain names and previous installation paths. This helps in understanding the command's practical application.

```bash
./install.sh -d team-edition.example.com --upgrade-from /home/user/installers/ate-installer-6.1.3-xxx

```

--------------------------------

### Preview IBM Software Hub Service Monitor Installation (Shell)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=manage-apply-service-monitor

Previews the `oc` commands that would be executed to install service monitors for a specified IBM Software Hub instance on an x86_64 cluster. This is useful for reviewing the intended actions before applying them. It uses the `cpd-cli manage apply-service-monitor` command with the `--preview=true` flag.

```shell
cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_name=olm-utils-v4:${VERSION}.amd64 \
--preview=true
```

--------------------------------

### Install watsonx.data Premium with Red Hat ODF Storage using cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=premium-installing

Installs the watsonx.data Premium and watsonx.ai components using `cpd-cli` for clusters with Red Hat OpenShift Data Foundation storage. It requires specifying storage classes for block and file storage, image registry details, and operator/operand namespaces.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_data_premium,watsonx_ai \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_data_premium,watsonx_ai \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Install Speech to Text and Text to Speech Runtimes

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=setup-advanced-configuration

This example demonstrates how to configure the installation of Speech microservices, specifically enabling the Speech to Text and Text to Speech runtimes. This is achieved by setting the appropriate properties within the Speech custom resource.

```yaml
################################
# Example for installing Speech to Text and Text to Speech runtimes
################################
```

--------------------------------

### Install watsonx.data Premium with Portworx Storage using cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=premium-installing

Installs watsonx.data Premium and watsonx.ai components for Portworx storage. This command specifies `portworx` as the storage vendor and requires image registry details and namespaces. It supports both direct configuration and using a parameter file.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_data_premium,watsonx_ai \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
```

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_data_premium,watsonx_ai \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### GaianDB Import Job Status Output Example

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=data-troubleshooting-migration-errors-in-virtualization

This is an example output of the `cpd-cli export-import import status` command, detailing the import job's name, status (Active, Succeeded, Failed), start time, completion time, and duration.

```text
Name:        	import-20251117183308          
Job Name:    	cpd-im                         
Active:      	0                              
Succeeded:   	1                              
Failed:      	0                              
Start Time:  	Mon, 17 Nov 2025 10:33:09 -0800
Completed At:	Mon, 17 Nov 2025 10:33:37 -0800
Duration:    	28s

```

--------------------------------

### Install Services with cpd-cli using install-options.yml

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=services-running-batch-installation-solutions

Installs services using `cpd-cli manage install-components` with an `install-options.yml` file. This command is used for various storage configurations including Red Hat OpenShift Data Foundation, IBM Fusion Data Foundation, IBM Fusion Global Data Platform, and IBM Storage Scale Container Native. It requires parameters like license acceptance, components, release version, namespaces, storage classes, and image registry details.

```bash
cpd-cli manage install-components \
--license_acceptance=true \
--components=${COMPONENTS} \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml
```

--------------------------------

### Example: Get Modules with Specific Labels

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=manage-get-k8s-details

This example demonstrates how to retrieve modules that include specific labels, such as `icpdsupport/addOnId=zen-lite`, `icpdsupport/app=framework`, and `icpdsupport/module=zen-framework`. This is useful for identifying related objects within the Kubernetes environment.

```bash
cpd-cli manage get-k8s-details \
--addonID=zen-lite \
--app=framework \
--module=zen-framework
```

--------------------------------

### Example Export Status Output (JSON)

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=mfadlmdl-running-mdi-lineage-migration-toolkit

This is an example of the JSON output from the export status file. It provides details about the export process, including its status (succeeded/failed), start and completion times, and a descriptive message.

```json
{
  "status": "succeeded",
  "startTime": 1748506989,
  "completionTime": 1748507015,
  "message": "The current export phase finished at 20250529-082335-233UTC with status: succeeded.",
  "percentageCompleted": 100
}
```

--------------------------------

### Setup MCG for Watson Discovery using cpd-cli

Source: https://www.ibm.com/docs/en/software-hub/5.3_topic=piish-creating-secrets-services-that-use-multicloud-object-gateway

Runs the `setup-mcg` command to create secrets required by Watson Discovery to connect to Multicloud Object Gateway. It requires the component to be `watson_discovery`, the CPD instance namespace, and the NooBaa account secret. The command output should indicate successful completion.

```shell
cpd-cli manage setup-mcg \
--components=watson_discovery \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--noobaa_account_secret=${NOOBAA_ACCOUNT_CREDENTIALS_SECRET}
```
Tokens:
Raw