Installing watsonx.data integration

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

Who needs to complete this task?

Instance administrator To install watsonx.data integration, 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 integration 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 integration 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 integration as part of a batch installation, complete this task to add watsonx.data integration 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 integration on the cluster.

Information you need to complete this task

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

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 integration 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 integration works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Common core services

watsonx.data integration requires the IBM Software Hub common core services.

If the common core services are not installed in the operands project for the instance, the common core services are automatically installed when you install watsonx.data integration. The common core services installation increases the amount of time the installation takes to complete.

Storage requirements

You must specify storage classes when you install watsonx.data integration. 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	When you install the service, specify file storage and block storage.	File storage: `ontap-nas` Block storage: `ontap-nas`
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 integration.

Where to find more information
If this task is not complete, see System 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:

The watsonx.data integration 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.
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.

Load balancer

Where to find more information
If this task is not complete, see Mirroring images to a 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.

The load balancer timeout settings are adjusted for watsonx.data integration.

Where to find more information
If this task is not complete, see Changing load balancer settings.

Process IDs limit

The process IDs limit setting is adjusted for watsonx.data integration.

Where to find more information
If this task is not complete, see Changing the process IDs limit.

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.

Prerequisite services

If you plan to install IBM Unstructured Data Integration as part of watsonx.data™ integration, ensure that the following services are installed and running:

Procedure

Complete the following tasks to install watsonx.data integration:

Specifying installation options
Installing the service
Validating the installation
What to do next

Specifying installation options

If you plan to install watsonx.data integration, you can 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 optional. If you do not set these installation parameters, the default values are used.

The sample YAML content uses the default values.

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

---
# ............................................................................
# watsonx.data integration parameters
# ............................................................................
non_olm:
  watsonxDataintegration:
    enableBatchBulkETL: true
    enableRealtimeStreaming: true
    enableDataObservability: true
    enableUnstructuredDataIntegration: true
    enableReplication: true

Property	Description
`enableBatchBulkETL`	Specify whether to install DataStage to perform bulk extract, transform, and load (ETL) operations on your data. Default value `true` Valid values `false` Do not install DataStage. `true` Install DataStage.
`enableRealtimeStreaming`	Specify whether to install StreamSets to enable real-time streaming so that you can act on time-sensitive data. Default value `true` Valid values `false` Do not install StreamSets. `true` Install StreamSets.
`enableDataObservability`	Specify whether to install Data Observability to receive alerts when there's a problem with your end-to-end integration process. Default value `true` Valid values `false` Do not install Data Observability. `true` Install Data Observability.
`enableUnstructuredDataIntegration`	Specify whether to install Unstructured Data Integration to ingest, transform, and enrich unstructured data from diverse sources. Default value `true` Valid values `false` Do not install Unstructured Data Integration. `true` Install Unstructured Data Integration.
`enableReplication`	Specify whether to install Data Replication to synchronize data between source and target data stores. Default value `true` Valid values `false` Do not install Data Replication. `true` Install Data Replication.

If you set enableBatchBulkETL: true specify the DataStage installation options, see Specifying your DataStage.

If you set enableReplication: true specify the Data Replication installation options, see Specifying installation options for Data Replication.

Note: For Data Replication installation options, only the replication_license_type: IDRC is applicable to watsonx.data integration.

Installing the service

To install watsonx.data integration:

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.

Install the operator and custom resource for watsonx.data integration.

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

Red Hat OpenShift Data Foundation storage

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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.

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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.

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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.

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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 storage only

Remember: When you use EFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically efs-nfs-client.

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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.

Run the appropriate command for your environment:

Default installation (without installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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}

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=watsonx_dataintegration \
--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 integration 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_dataintegration

What to do next

watsonx.data integration is ready to use.

To get started with watsonx.data integration, see Getting started with watsonx.data integration.