Installing watsonx Orchestrate

Information you need to complete this task

Review the following information before you install watsonx Orchestrate:

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.2.2, you must install watsonx Orchestrate at Version 5.2.2.

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 Orchestrate 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 Orchestrate. 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 the same storage class for both 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	Not supported.	Not applicable.
Portworx	When you install the service, the --storage_vendor=portworx option ensures that the service uses the correct storage classes.	File storage: portworx-shared-gp3 Block storage: portworx-db-gp3-sc
NFS	Not supported.	Not applicable.
Amazon Elastic storage	Not supported.	Not applicable.
NetApp Trident	When you install the service, specify the same storage class for both 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 Orchestrate.

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

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 Orchestrate 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-v3 image from the private container registry.

   Where to find more information
   If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.

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

If you plan to use features that require 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.

Multicloud Object Gateway

This task assumes that the following tasks are complete:

1. Multicloud Object Gateway is installed and configured.

   Where to find more information
   If this task is not complete, see Installing Multicloud Object Gateway.

2. The secrets that enable watsonx Orchestrate to connect to Multicloud Object Gateway exist.

   Where to find more information
   If this task is not complete, see Creating secrets for services that use Multicloud Object Gateway.

Red Hat OpenShift Serverless Knative Eventing

This task assumes that Red Hat OpenShift Serverless Knative Eventing is installed.

Where to find more information
If this task is not complete, see Installing Red Hat OpenShift Serverless Knative Eventing.

Preparing to install

Procedure

Complete the following tasks to install watsonx Orchestrate:

1. Specifying installation options
2. Starting the IBM Events Operator in the operators project
3. Installing the service
4. Validating the installation
5. What to do next

Specifying installation options

Starting the IBM Events Operator in the operators project

If you installed only the agentic features of watsonx Orchestrate by setting watson_orchestrate_install_mode: lite , you must create an operand request in the operands project to start the IBM Events Operator(ibm-events-operator) in the operators project.

cat <<EOF |oc apply -f -
apiVersion: operator.ibm.com/v1alpha1
kind: OperandRequest
metadata:
  name: wo-operand-request
  namespace: ${PROJECT_CPD_INST_OPERANDS}
spec:
  requests:
  - operands:
    - name: ibm-events-operator-v5.1
    registry: common-service
EOF

Installing the service

To install watsonx Orchestrate:

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. Run the following command to create the required OLM objects for watsonx Orchestrate in the operators project for the instance:

   cpd-cli manage apply-olm \
   --release=${VERSION} \
   --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --components=watsonx_orchestrate

   Wait for the cpd-cli to return the following message before you proceed to the next step:

   [SUCCESS]... The apply-olm command ran successfully

   If the apply-olm fails, see Troubleshooting the apply-olm command during installation or upgrade.

3. Create the custom resource for watsonx Orchestrate.

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

   ---

   Red Hat OpenShift Data Foundation storage

   Run the appropriate command to create the custom resource.

   Default installation (without installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --block_storage_class=${STG_CLASS_BLOCK} \
   --file_storage_class=${STG_CLASS_FILE} \
   --license_acceptance=true

   Custom installation (with installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --block_storage_class=${STG_CLASS_BLOCK} \
   --file_storage_class=${STG_CLASS_FILE} \
   --param-file=/tmp/work/install-options.yml \
   --license_acceptance=true

   ---

   IBM Fusion Data Foundation storage

   Run the appropriate command to create the custom resource.

   Default installation (without installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --block_storage_class=${STG_CLASS_BLOCK} \
   --file_storage_class=${STG_CLASS_FILE} \
   --license_acceptance=true

   Custom installation (with installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --block_storage_class=${STG_CLASS_BLOCK} \
   --file_storage_class=${STG_CLASS_FILE} \
   --param-file=/tmp/work/install-options.yml \
   --license_acceptance=true

   ---

   Portworx storage

   Run the appropriate command to create the custom resource.

   Default installation (without installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --storage_vendor=portworx \
   --license_acceptance=true

   Custom installation (with installation options)

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

   ---

   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 to create the custom resource.

   Default installation (without installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --block_storage_class=${STG_CLASS_BLOCK} \
   --file_storage_class=${STG_CLASS_FILE} \
   --license_acceptance=true

   Custom installation (with installation options)

   cpd-cli manage apply-cr \
   --components=watsonx_orchestrate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --block_storage_class=${STG_CLASS_BLOCK} \
   --file_storage_class=${STG_CLASS_FILE} \
   --param-file=/tmp/work/install-options.yml \
   --license_acceptance=true

   ---

Validating the installation

[SUCCESS]... The apply-cr 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_orchestrate

What to do next