Upgrading Watson Studio Runtimes from Version 5.3 to Version 5.4

An instance administrator can upgrade Watson Studio Runtimes from Version 5.3 to Version 5.4.

Who needs to complete this task?

Instance administrator To upgrade Watson Studio Runtimes, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance

The operators for this instance of IBM Software Hub are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The control plane and the services for this instance of IBM Software Hub are installed in the operands project. In the upgrade 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 upgrade the control plane and one or more services at the same time, follow the process in Upgrading an instance of IBM Software Hub instead.
  • If you didn't upgrade Watson Studio Runtimes when you upgraded the control plane, complete this task to upgrade Watson Studio Runtimes.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to upgrade more instances of Watson Studio Runtimes on the cluster.

Information you need to complete this task

Review the following information before you upgrade Watson Studio Runtimes:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the control plane is at Version 5.4.0, you must upgrade Watson Studio Runtimes to 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
Storage requirements
You don't need to specify storage when you upgrade Watson Studio Runtimes.

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 upgrade 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 Updating client workstations.
Control plane
This task assumes that the IBM Software Hub control plane is upgraded.
Where to find more information
If this task is not complete, see Upgrading 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, were updated.
Where to find more information
If this task is not complete, see Updating the cluster-scoped resources for the platform and services.

Prerequisite services

Before you upgrade Watson Studio Runtimes, ensure that the following services are upgraded and running:

Procedure

Complete the following tasks to upgrade Watson Studio Runtimes:

  1. Specifying installation options
  2. Upgrading the service
  3. Validating the upgrade
  4. What to do next

Specifying installation options

When you upgrade Watson Studio Runtimes, specify the runtimes you want installed and kept in the install-options.yml file in the work directory.
Important: If you want to upgrade all existing runtimes automatically when you upgrade Watson Studio, specify the ws_runtimes component when you upgrade Watson Studio.

If you do not specify the ws_runtimes component when you upgrade Watson Studio, only the default runtime is upgraded. You must upgrade the non-default runtimes manually.

Follow the appropriate guidance for the version of IBM Software Hub that you installed:
Version 5.4.0

The formatting applies only to IBM Software Hub Version 5.4.0.

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

---
# ............................................................................
# Watson Studio Runtimes parameters
# ............................................................................
non_olm:
  wsRuntimes:
    kinds: []
Property Description
kinds Specify whether you want to install optional Watson Studio Runtimes for GPU and R.
Default value
[]
Valid values
ibm-cpd-ws-runtime-251-pygpu
Install Runtime 25.1 on Python 3.12 for GPU.
ibm-cpd-ws-runtime-251-r
Install Runtime 25.1 on R 4.4.
Including this parameter
Specify the runtime name as a list item on a new line.
Install Runtime 25.1 on Python 3.12 for GPU
  wsRuntimes:
    kinds:
      - ibm-cpd-ws-runtime-251-pygpu
Install Runtime 25.1 on R 4.4
  wsRuntimes:
    kinds:
      - ibm-cpd-ws-runtime-251-r
Install all runtimes
  wsRuntimes:
    kinds:
      - ibm-cpd-ws-runtime-251-pygpu
      - ibm-cpd-ws-runtime-251-r

Upgrading the service

To upgrade 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. Update the operator and custom resource for Watson Studio Runtimes.
    cpd-cli manage install-components \
    --license_acceptance=true \
    --components=ws_runtimes \
    --release=${VERSION} \
    --patch_id=${PATCH_ID} \
    --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
    --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --image_pull_prefix=${IMAGE_PULL_PREFIX} \
    --image_pull_secret=${IMAGE_PULL_SECRET} \
    --param-file=/tmp/work/install-options.yml \
    --upgrade=true
Important: If you want to upgrade all existing runtimes automatically when you upgrade Watson Studio, specify the ws_runtimes component when you upgrade Watson Studio.

If you do not specify the ws_runtimes component when you upgrade Watson Studio, only the default runtime is upgraded. You must upgrade the non-default runtimes manually.

Validating the upgrade

Watson Studio Runtimes is upgraded 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=ws_runtimes

What to do next

  1. If you use custom runtime images in Watson Studio, you must create and register the custom images to rebase the image with the latest IBM Software Hub runtime image. See Building custom runtime images.

After you complete the preceding steps, Watson Studio Runtimes is ready to use. For details, see Notebook environments.