Installing watsonx.data Premium

An instance administrator can install watsonx.data Premium on IBM Software Hub Version 5.4.

Who needs to complete this task?

Instance administrator To install watsonx.data Premium, you must be an instance administrator. An instance administrator has permission to install software in the following projects:

The operators project for the instance

The operators for this instance of watsonx.data Premium are installed in the operators project.

In the installation commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The custom resources for the control plane and watsonx.data Premium are installed in the operands project.

In the installation commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to install multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
  • If you didn't install watsonx.data Premium as part of a batch installation, complete this task to add watsonx.data Premium to your environment.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to install more instances of watsonx.data Premium on the cluster.

Information you need to complete this task

Review the following information before you install watsonx.data Premium:

Version requirements

All of the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is installed at Version 5.4.0, you must install watsonx.data Premium at Version 5.4.0.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

  • If you don't have the script that defines the environment variables, see Setting up installation environment variables.
  • To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:
    source ./cpd_vars.sh
Security context constraint

watsonx.data Premium works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Storage requirements
You must specify storage classes when you install watsonx.data Premium. The following storage classes are recommended. However, if you don't use these storage classes on your cluster, ensure that you specify a storage class with an equivalent definition.
Storage Notes Storage classes
OpenShift Data Foundation When you install the service, specify file storage and block storage.
  • File storage: ocs-storagecluster-cephfs
  • Block storage: ocs-storagecluster-ceph-rbd
IBM Fusion Data Foundation When you install the service, specify file storage and block storage.
  • File storage: ocs-storagecluster-cephfs
  • Block storage: ocs-storagecluster-ceph-rbd
IBM Fusion Global Data Platform When you install the service, specify file storage and block storage.
  • File storage:

    Either of the following storage classes:

    • ibm-spectrum-scale-sc
    • ibm-storage-fusion-cp-sc
  • Block storage:

    Either of the following storage classes:

    • ibm-spectrum-scale-sc
    • ibm-storage-fusion-cp-sc
IBM Storage Scale Container Native When you install the service, specify file storage and block storage.
  • File storage: ibm-spectrum-scale-sc
  • Block storage: ibm-spectrum-scale-sc
Portworx When you install the service, the --storage_vendor=portworx option ensures that the service uses the correct storage classes.
  • File storage: portworx-rwx-gp3-sc

    (Equivalent to portworx-shared-gp3 in older installations)

  • Block storage:
    • portworx-couchdb-sc
    • portworx-elastic-sc
    • portworx-gp3-sc
NFS When you install the service, specify file storage and block storage.
  • File storage: managed-nfs-storage
  • Block storage: managed-nfs-storage
Amazon Elastic storage When you install the service, specify file storage and block storage.

File storage is provided by Amazon Elastic File System. Block storage is provided by Amazon Elastic Block Store.
  • File storage: efs-nfs-client
  • Block storage:

    Either of the following storage classes:

    • gp2-csi
    • gp3-csi
NetApp Trident Not supported. Not applicable.
Nutanix Not supported. Not applicable.

Before you begin

This task assumes that the following prerequisites are met:

System requirements
This task assumes that the cluster meets the minimum requirements for watsonx.data Premium.
Where to find more information
If this task is not complete, see System requirements.
In addition, ensure that you have the appropriate type and number of GPU for watsonx.data Premium.
Where to find more information
If this task is not complete, see GPU requirements.
Workstation
This task assumes that the workstation from which you will run the installation is set up as a client workstation and has the following command-line interfaces:
  • IBM Software Hub CLI: cpd-cli
  • OpenShift CLI: oc
  • Helm CLI: helm
Where to find more information
If this task is not complete, see Setting up a client workstation.
Control plane
This task assumes that the IBM Software Hub control plane is installed.
Where to find more information
If this task is not complete, see Installing an instance of IBM Software Hub.
Private container registry
If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:
  1. The watsonx.data Premium software images are mirrored to the private container registry.
    Where to find more information
    If this task is not complete, see Mirroring images to a private container registry.
  2. The cpd-cli is configured to pull the olm-utils-v4 image from the private container registry.
    Where to find more information
    If this task is not complete, see Pulling the olm-utils-v4 image from the private container registry.
GPU operators
This task assumes that the operators required to use GPUs are installed.
Where to find more information
If this task is not complete, see Installing operators for services that require GPUs.
Red Hat OpenShift AI
This task assumes that Red Hat OpenShift AI is installed.
Where to find more information
If this task is not complete, see Installing Red Hat OpenShift AI.
Cluster-scoped resources
This task assumes that the cluster-scoped resources, such as custom resource definitions, cluster roles, and cluster role bindings, exist.
Where to find more information
If this task is not complete, see Creating cluster-scoped resources for the IBM Software Hub platform and services.
Image pull secrets
This task assumes that the secrets that contain the image pull credentials for the instance exist.
Where to find more information
If this task is not complete, see Creating image pull secrets for an instance of IBM Software Hub.

Procedure

Complete the following tasks to install watsonx.data Premium:

  1. Choosing your watsonx.data Premium feature set
  2. Specifying installation options
  3. Installing the service
  4. Validating the installation
  5. What to do next

Choosing your watsonx.data Premium feature set

watsonx.data™ Premium offers two feature sets.

Set the WATSONX_DATA_PREMIUM_TYPE environment variable to specify the feature set that you want to install.
  • For watsonx.data Premium with limited features, run
    export WATSONXDATA_PREMIUM_TYPE=watsonx_data_premium
  • For watsonx.data Premium with all features, run
    export WATSONXDATA_PREMIUM_TYPE=watsonx_data_premium,watsonx_data_premium_dependencies

Specifying installation options

If you plan to install watsonx.data Premium, you must specify installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are required and depend on whether you already installed watsonx.ai™ on this instance of IBM Software Hub.

watsonx.ai is not installed

watsonx.data Premium requires the full version of watsonx.ai, but does not include entitlement to Tuning Studio.

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

The sample YAML content uses the required values, where appropriate. You must replace <license> with the appropriate value for your environment.

---
# ............................................................................
# watsonx.data premium parameters
# ............................................................................
non_olm:
  watsonxDataPremium:
    wxd_premium_enable_models_on: gpu
    licenseType: <license>
  watsonxAi:
    tuning_disabled: true
watsonx.ai lightweight engine is installed

watsonx.data Premium requires the full version of watsonx.ai, but does not include entitlement to Tuning Studio.

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

The sample YAML content uses the required values, where appropriate. You must replace <license> with the appropriate value for your environment.

---
# ............................................................................
# watsonx.data premium parameters
# ............................................................................
non_olm:
  watsonxDataPremium:
    wxd_premium_enable_models_on: gpu
    licenseType: <license>
  watsonxAi:
    liteInstall: false
    tuning_disabled: true
watsonx.ai is installed

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

The sample YAML content uses the required values, where appropriate. You must replace <license> with the appropriate value for your environment.

---
# ............................................................................
# watsonx.data premium parameters
# ............................................................................
non_olm:
  watsonxDataPremium:
    wxd_premium_enable_models_on: gpu
    licenseType: <license>
Property Description
wxd_premium_enable_models_on Install watsonx.data Premium on GPU.
Required value
gpu
licenseType Specify the watsonx.data Premium license you purchased.
Valid values
premium
Specify this option if you purchased IBM watsonx.data Premium Edition.
premium_non_prod
Specify this option if you purchased IBM watsonx.data Premium Edition Non-Production.
premium_reserved
Specify this option if you purchased IBM watsonx.data Premium Edition Reserved.
premium_reserved_non_prod
Specify this option if you purchased IBM watsonx.data Premium Edition Reserved Non-Production.
premium_dg
Specify this option if you purchased IBM watsonx.data Premium with Data Gate for IBM Z®.

This license is applicable only if you want to integrate Data Gate and watsonx.data Premium.

premium_non_prod_dg
Specify this option if you purchased IBM watsonx.data Premium with Data Gate for IBM Z Non-Production.

This license is applicable only if you want to integrate Data Gate and watsonx.data Premium.

premium_reserved_dg
Specify this option if you purchased IBM watsonx.data Premium with Data Gate for IBM Z Reserved.

This license is applicable only if you want to integrate Data Gate and watsonx.data Premium.

premium_reserved_non_prod_dg
Specify this option if you purchased IBM watsonx.data Premium with Data Gate for IBM Z Reserved Non-Production.

This license is applicable only if you want to integrate Data Gate and watsonx.data Premium.
liteInstall watsonx.data Premium requires the full version of watsonx.ai.

If you previously installed the full watsonx.ai service, omit this option.

Required value
false

Installing the service

To install watsonx.data Premium:

  1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Install the operator and custom resource for watsonx.data Premium.

    The command that you run depends on the storage on your cluster.

    Red Hat OpenShift Data Foundation storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    IBM Fusion Data Foundation storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    IBM Fusion Global Data Platform storage
    Remember: When you use IBM Fusion Global Data Platform storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc or ibm-storage-fusion-cp-sc.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    IBM Storage Scale Container Native storage
    Remember: When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    Portworx storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    NFS storage
    Remember: When you use NFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically managed-nfs-storage.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    AWS with EFS and EBS storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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
    NetApp Trident
    Remember: When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ontap-nas.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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}
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${WATSONX_DATA_PREMIUM_TYPE} \
--release=${VERSION} \
--patch_id=${PATCH_ID} \
--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

Validating the installation

watsonx.data Premium is installed when the install-components command returns:
[SUCCESS]... The install-components command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=${WATSONX_DATA_PREMIUM_TYPE}

What to do next

watsonx.data Premium is ready to use. For more information, see Getting started with watsonx.data Premium.