Installing Watson Studio Runtimes

Information you need to complete this task

Review the following information before you install Watson Studio Runtimes:

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 Watson Studio Runtimes 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

Watson Studio Runtimes works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Storage requirements

You don't need to specify storage information when you install Watson Studio Runtimes.

The Watson Studio Runtimes leverage the storage that is provisioned when you install Watson Studio.

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 Watson Studio Runtimes.

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 Watson Studio Runtimes.

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 Watson Studio Runtimes 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.

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

Before you install Watson Studio Runtimes, ensure that the following services are installed and running:

• Common core services
• Watson Studio

Procedure

Complete the following tasks to install Watson Studio Runtimes:

1. Specifying installation options
2. Installing the service
3. Installing pre-trained NLP models
4. Validating the installation
5. What to do next

Specifying installation options

---
# ............................................................................
# Watson Studio Runtimes parameters
# ............................................................................
non_olm:
  wsRuntimes:
    kinds: []

Installing the service

To install Watson Studio Runtimes:

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 Watson Studio Runtimes.

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=ws_runtimes \
   --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} \
   --skip_components=platform-config,opencontent_opensearch,ccs \
   --param-file=/path/to/override.yaml

   Important: If additional runtimes are to be installed, or were already installed previously, the install command needs to list all the additional runtimes in the override.yaml file for the kinds key. Otherwise, the missing runtimes will be uninstalled.

Installing pre-trained NLP models

You can optionally install the pre-trained NLP models for the Watson Natural Language Processing library. Install the models based on the Runtimes you have installed:

oc patch -n ${PROJECT_CPD_INST_OPERANDS} NotebookRuntime ibm-cpd-ws-runtime-251-pygpu --type=merge --patch '{"spec":{"install_nlp_models":true}}'

oc patch -n ${PROJECT_CPD_INST_OPERANDS} NotebookRuntime ibm-cpd-ws-runtime-241-pygpu --type=merge --patch '{"spec":{"install_nlp_models":true}}'

oc patch -n ${PROJECT_CPD_INST_OPERANDS} NotebookRuntime ibm-cpd-ws-runtime-251-py --type=merge --patch '{"spec":{"install_nlp_models":true}}'

oc patch -n ${PROJECT_CPD_INST_OPERANDS} NotebookRuntime ibm-cpd-ws-runtime-241-py --type=merge --patch '{"spec":{"install_nlp_models":true}}'

oc get -n ${PROJECT_CPD_INST_OPERANDS} NotebookRuntime

The pre-trained NLP models are available only when the status column for the notebook runtimes changes to Completed.

Validating the installation

[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=ws_runtimes

What to do next

Watson Studio Runtimes is ready to use. To get started with Watson Studio Runtimes, see Notebook environments.