Upgrading watsonx BI from Version 5.2 to Version 5.3

An instance administrator can upgrade watsonx BI from Version 5.2 to Version 5.3.

Who needs to complete this task?

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

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

Information you need to complete this task

Review the following information before you upgrade watsonx BI:

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.3.1, you must upgrade watsonx BI to Version 5.3.1.

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
watsonx BI 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 watsonx BI. 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 watsonx BI.
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 watsonx BI.
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: oc
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 watsonx BI 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.

Prerequisite services

Before you upgrade watsonx BI, ensure that the following services are upgraded and running:

  • IBM Software Hub
    oc patch zenservice lite-cr -n cpd-instance --type=merge -p '{"spec": {"version": "6.2.2", "zen_pak_version": "6.2.2"}}'
  • watsonx.data™ intelligence
    • You must modify the watsonx.data intelligence CR to enable GPU models.

      To enable GPU models, run the following command:
      oc patch watsonxdataintelligence watsonxdataintelligence-cr -n "${PROJECT_CPD_INST_OPERANDS}" --type='json' -p='[{"op": "replace", "path": "/spec/enableModelsOn", "value": "gpu"},{"op": "replace", "path": "/spec/enableSemanticEmbedding", "value":true}]'
  • watsonx.ai™ embedding model ibm-slate-30m-english-rtrvr
    • To install the ibm-slate-30m-english-rtrvr embedding model, run the following command:
      oc patch Watsonxaiifm watsonxaiifm-cr -n "${PROJECT_CPD_INST_OPERANDS}" --type=json -p '[{"op": "add", "path": "/spec/install_model_list/", "value": "ibm-slate-30m-english-rtrvr"}]'

Procedure

Complete the following tasks to upgrade watsonx BI:

  1. Upgrading the service
  2. Validating the upgrade
  3. Upgrading the service instance
  4. What to do next

Upgrading the service

To upgrade watsonx BI:

  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 watsonx BI.
    cpd-cli manage install-components \
    --license_acceptance=true \
    --components=watsonx_bi_assistant \
    --release=${VERSION} \
    --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

watsonx BI 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=watsonx_bi_assistant

Upgrading the service instance

After you upgrade watsonx BI, you must upgrade the service instance that is associated with watsonx BI.

Before you begin

Create a profile on the workstation from which you will upgrade the service instances.

The profile must be associated with a IBM Software Hub user who has either the following permissions:

  • Create service instances (can_provision)
  • Manage service instances (manage_service_instances)

For more information, see Creating a profile to use the cpd-cli management commands.

Procedure

To upgrade the service instance:

  1. Set the INSTANCE_VERSION environment variable to the version that corresponds to the version of IBM Software Hub on your cluster:
    export INSTANCE_VERSION=<version>

    Use the following table to determine the appropriate value:

    IBM Software Hub version Service instance version
    5.3.1 3.4.0
    5.3.0 3.3.0
  2. Upgrade the service instance:
    cpd-cli service-instance upgrade \
    --service-type=watsonx-bi-assistant \
    --instance-name=${INSTANCE_NAME} \
    --profile=${CPD_PROFILE_NAME} \
    --version=${INSTANCE_VERSION}

What to do next

Before you can use watsonx BI version 3.3.0, you must complete the post-upgrade setup for watsonx BI.