Installing watsonx.data intelligence
An instance administrator can install watsonx.data intelligence on IBM Software Hub Version 5.4.
- Who needs to complete this task?
-
Instance administrator To install watsonx.data intelligence, 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 intelligence 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 intelligence 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
intelligence as part of a batch installation, complete this task
to add watsonx.data
intelligence 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 intelligence on the cluster.
Information you need to complete this task
Review the following information before you install watsonx.data intelligence:
- 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 intelligence 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 intelligence works with the default Red Hat® OpenShift® Container Platform security context constraint,
restricted-v2.
- Common core services
-
watsonx.data intelligence 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 intelligence. 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 intelligence. 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.
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
intelligence.
Where to find more information If this task is not complete, see System requirements. In addition, if you plan to use features that require GPU, ensure that you have the appropriate type and number of GPU for watsonx.data intelligence.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. - IBM Software
Hub CLI:
- 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
intelligence 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-cliis configured to pull theolm-utils-v4image 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.
- The watsonx.data
intelligence software images are mirrored to the private container
registry.
- Load balancer
- The load balancer timeout settings are adjusted for watsonx.data
intelligence.
Where to find more information If this task is not complete, see Changing load balancer settings. - GPU operators
- If you plan to use
features that require GPUs, 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 intelligence:
Specifying installation options
If you plan to install
watsonx.data™ intelligence,
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 intelligence parameters
# ............................................................................
non_olm:
watsonxDataintelligence:
enableAISearch: false
enableDataGovernanceCatalog: true
enableKnowledgeGraph: true
enableDataQuality: false
enableDataLineage: true
enableDataProduct: true
enableUnstructuredDataIntegration: false
enableGenerativeAICapabilities: true
enableSemanticEnrichment: true
enableSemanticEmbedding: false
enableTextToSql: false
enableModelsOn: cpu
| Property | Description |
|---|---|
enableAISearch |
Specify whether to enable LLM-based semantic search for assets and artifacts across all workspaces.
|
enableDataGovernanceCatalog |
Specify whether to enable data governance and catalog features.
|
enableKnowledgeGraph |
Specify whether to enable the knowledge graph feature. The knowledge graph provides the
following capabilities:
|
enableDataQuality |
Specify whether to enable data quality features in projects so that you can measure,
monitor, and maintain the quality of your data to ensure the data meets your expectations and
standards for specific use cases. Important: When you enable the data quality feature,
DataStage Enterprise is automatically
installed.
If you did not purchase a separate DataStage license, use of DataStage Enterprise is limited to creating, managing, and running data quality rules. For examples of accepted use, see Enabling additional features after installation or upgrade for watsonx.data intelligence.
|
enableDataLineage |
Specify whether to enable data lineage features. Data lineage is the process of tracking data as it is moved and used by different software tools. Lineage tracks where data came from, how it was transformed, and where the data was moved to.
|
enableDataProduct |
Specify whether to enable data sharing features. When you enable data sharing, data producers can package data and data-related assets into data products so that data consumers have access to secure, high quality data
|
enableUnstructuredDataIntegration |
Specify whether to enable unstructured data processing. Install Unstructured Data Integration to ingest, transform, and enrich unstructured data from diverse sources. If you enable unstructured data processing and the data governance and catalog features
(
|
enableGenerativeAICapabilities |
Specify whether to enable gen AI capabilities. Enable the gen AI capabilities if you plan
to use the following features:
|
|
Specify whether to enable gen AI metadata expansion. Metadata expansion includes:
|
enableSemanticEmbedding |
Specify whether to enable semantic embedding. You must enable semantic embedding if you plan to use the following features:
|
enableTextToSql |
Specify whether to generate SQL queries from natural language input. Text-to-SQL capabilities can be used to create query-based data assets, which can be use for data products or in searches.
|
enableModelsOn |
Specify where you want the models that are used with the gen AI capabilities to run.
|
customModelTextToSql |
.Deprecated This option is
deprecated and will be removed in a future release. Specify a custom model for Text-To-SQL conversions.
|
Installing the service
To install watsonx.data intelligence:
-
Log the
cpd-cliin to the Red Hat OpenShift Container Platform cluster:${CPDM_OC_LOGIN}Remember:CPDM_OC_LOGINis an alias for thecpd-cli manage login-to-ocpcommand. - Install the operator and custom
resource for watsonx.data
intelligence.
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_dataintelligence \ --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_dataintelligence \ --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_dataintelligence \ --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_dataintelligence \ --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, typicallyibm-spectrum-scale-scoribm-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_dataintelligence \ --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_dataintelligence \ --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, typicallyibm-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_dataintelligence \ --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_dataintelligence \ --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_dataintelligence \ --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_dataintelligence \ --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, typicallymanaged-nfs-storage.Run the appropriate command for your environment:
- Default installation (without installation options)
-
cpd-cli manage install-components \ --license_acceptance=true \ --components=watsonx_dataintelligence \ --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_dataintelligence \ --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, typicallyefs-nfs-client.Run the appropriate command for your environment:
- Default installation (without installation options)
-
cpd-cli manage install-components \ --license_acceptance=true \ --components=watsonx_dataintelligence \ --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_dataintelligence \ --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_dataintelligence \ --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_dataintelligence \ --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, typicallyontap-nas.Run the appropriate command for your environment:
- Default installation (without installation options)
-
cpd-cli manage install-components \ --license_acceptance=true \ --components=watsonx_dataintelligence \ --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_dataintelligence \ --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
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_dataintelligence
What to do next
After you complete the preceding steps, watsonx.data intelligence is ready to use.