Upgrading Watson Discovery from Version 5.2 to Version 5.4

An instance administrator can upgrade Watson Discovery from Version 5.2 to Version 5.4.

Who needs to complete this task?

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

    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 Discovery on the cluster.

Information you need to complete this task

Review the following information before you upgrade Watson Discovery:

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 Watson Discovery 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

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 Discovery.
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 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 Discovery 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.
Multicloud Object Gateway
This task assumes that Multicloud Object Gateway is upgraded, if needed.
Where to find more information
If this task is not complete, see Upgrading Multicloud Object Gateway.
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 Watson Discovery:

  1. Specifying configuration options
  2. Upgrading the service
  3. Validating the upgrade
  4. Upgrading existing service instances
  5. What to do next

Specifying installation options

If you plan to install Watson Discovery, you can specify the following installation option in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameter is optional. If you do not set this installation parameter, the default value is used.

The sample YAML content uses the default values.

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

---
# ............................................................................
# Watson Discovery parameters
# ............................................................................
non_olm:
  watsonDiscovery:
    discovery_deployment_type: Production
Property Description
discovery_deployment_type The deployment type for Watson Discovery.

The deployment type determines the number of resources allocated to Watson Discovery.

Default value
Production
Valid values
Production
A production deployment has at least two replicas of each pod to support production-scale workloads. For the production deployment, the deployment size is the small scaleConfig setting.
Starter
A starter deployment has fewer resources and less computing power than a production deployment. For the starter deployment, the deployment size is the xsmall scaleConfig setting.

In previous releases, this deployment type was called the development deployment type.

Upgrading the service

To upgrade Watson Discovery:

  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 Discovery.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=watson_discovery \
--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

Validating the upgrade

Watson Discovery 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=watson_discovery

Upgrading existing service instances

The service instances are automatically upgraded when you upgrade Watson Discovery.

What to do next

Watson Discovery is ready to use. For information about how to give people access to your instance, see Administering Watson Discovery.