Upgrading IBM watsonx.ai from Version 5.2 to Version 5.4

An instance administrator can upgrade IBM watsonx.ai from Version 5.2 to Version 5.4.

Who needs to complete this task?

Instance administrator To upgrade IBM watsonx.ai, 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 watsonx.ai 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 custom resources for the control plane and IBM watsonx.ai 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 IBM Software Hub 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 IBM watsonx.ai when you upgraded the IBM Software Hub control plane, complete this task to upgrade IBM watsonx.ai.

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

Information you need to complete this task

Review the following information before you upgrade IBM watsonx.ai:

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 IBM Software Hub control plane is at Version 5.4.0, you must upgrade IBM watsonx.ai 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
Common core services
IBM watsonx.ai requires the IBM Software Hub common core services.

If the common core services are not at the correct version in the operands project for the instance, the common core services are automatically upgraded when you upgrade IBM watsonx.ai. The common core services upgrade increases the amount of time the upgrade takes to complete.

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 IBM watsonx.ai.
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 IBM watsonx.ai.
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 IBM watsonx.ai 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.
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, were updated.
Where to find more information
If this task is not complete, see Updating the cluster-scoped resources for the 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 upgrade IBM watsonx.ai:

  1. Removing deployment models before upgrading to Version 5.4
  2. Specifying components to upgrade
  3. Upgrading to a different installation mode
  4. Upgrading the service
  5. Validating the upgrade
  6. What to do next

Removing deployment models before upgrading to Version 5.4

If you are running models using caikit-1.0 (watsonx-cfm-caikit-1.0), these models will not work after you upgrade to Version 5.4.

You need to remove any deployments using caikit1.0, and create new deployments using caikit1.1 (watsonx-cfm-caikit-1.1) before upgrading. This ensure that your models work when you upgrade to Version 5.4.

Upgrading to a different installation mode

If you are upgrading your mode of IBM watsonx.ai to a different mode, you can only do so on the same version.

If you are upgrading from the IBM watsonx.ai lightweight engine to the full IBM watsonx.ai service, you can only do so within the same version.

To upgrade your installation mode, access the custom resource (CR) and remove the lite_install: true flag from both the IBM watsonx.ai and the IBM watsonx.ai IFM CR.

For more information about installation modes, see Choosing an IBM watsonx.ai installation mode.

Specifying components to upgrade

Set the XAI_COMPONENT_TYPE environment variable to the watsonx_ai component to upgrade the watsonx.ai service.

The watsonx_ai component installs the core watsonx.ai functionality that lets you work with foundation models installed in your cluster and use tools such as the Prompt Lab and Tuning Studio.

Set the XAI_COMPONENT_TYPE as follows to upgrade the watsonx.ai service:
export XAI_COMPONENT_TYPE=watsonx_ai

Upgrading the service

To upgrade IBM watsonx.ai:

  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 IBM watsonx.ai.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=${XAI_COMPONENT_TYPE} \
--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} \
--upgrade=true

Validating the upgrade

IBM watsonx.ai 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=${XAI_COMPONENT_TYPE}

What to do next

After you upgrade IBM watsonx.ai, you can install new models. For more information, see Adding foundation models to IBM watsonx.ai.