Upgrading Watson Knowledge Studio from Version 4.0 to Version 4.6

A project administrator can upgrade Watson Knowledge Studio.

Important: To complete this task, you must be running Watson Knowledge Studio Version 4.0.2 or later. (Version 4.0.2 was released with Cloud Pak for Data Version 4.0 Refresh 2.)

Supported upgrade paths: If you are running Watson Knowledge Studio Version 4.0.2 or later, you can upgrade to Versions 4.6.0 - 4.6.2.
Unsupported upgrade paths: You cannot upgrade from Version 4.0 to Version 4.6.3 or later. You must upgrade to 4.6.2 before you upgrade to 4.6.3 or later.

What permissions do you need to complete this task?

The permissions that you need depend on which tasks you must complete:

To update the Watson Knowledge Studio operators, you must have the appropriate permissions to create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
To upgrade Watson Knowledge Studio, you must be an administrator of the project where Watson Knowledge Studio is installed. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

When do you need to complete this task?: If you didn't upgrade Watson Knowledge Studio when you upgraded the platform, you can complete this task to upgrade your existing Watson Knowledge Studio installation.
If you want to upgrade all of the Cloud Pak for Data components at the same time, follow the process in Upgrading the platform and services instead.

Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.

Information you need to complete this task

Review the following information before you upgrade Watson Knowledge Studio:

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:
```
source ./cpd_vars.sh
```

Installation location: Watson Knowledge Studio is installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

Storage requirements: You must tell Watson Knowledge Studio what storage you use in your existing installation. You cannot change the storage that is associated with Watson Knowledge Studio during an upgrade. Ensure that the environment variables point to the correct storage classes for your environment.

Before you begin

This task assumes that the following prerequisites are met:

Prerequisite	Where to find more information
The cluster meets the minimum requirements for Watson Knowledge Studio.	If this task is not complete, see System requirements.
The workstation from which you will run the upgrade is set up as a client workstation and includes the following command-line interfaces: Cloud Pak for Data CLI: `cpd-cli` OpenShift® CLI: `oc`	If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is upgraded.	If this task is not complete, see Upgrading the platform and services.
For environments that use a private container registry, such as air-gapped environments, the Watson Knowledge Studio software images are mirrored to the private container registry.	If this task is not complete, see Mirroring images to a private container registry.

Prerequisite steps

Complete the following prerequisite tasks before you upgrade Watson Knowledge Studio:

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
```
cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
```
Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.

Setting up storage

Set up the storage class that will be used in 4.6.

Create a patch file named wks_storage_patch.yaml with the following YAML snippet.

cat <<EOF > wks_storage_patch.yaml
spec:
  global:
    blockStorageClass: "${STG_CLASS_BLOCK}"
    fileStorageClass: "${STG_CLASS_FILE}"
EOF

Patch the custom resource with the Watson Knowledge Studio YAML file by using the following command:

oc -n ${PROJECT_CPD_INSTANCE} patch KnowledgeStudio wks \
--type=merge --patch="$(cat wks_storage_patch.yaml)"

Quiescing the MinIO component

Scale down the MinIOMinIO pods by running the following commands:

oc -n ${PROJECT_CPD_INSTANCE} patch --type=merge MinioCluster wks-minio \
-p '{"spec":{"replicasForDev":0,"replicasForProd":0}}'
oc -n ${PROJECT_CPD_INSTANCE} patch --type=merge KnowledgeStudio wks \
-p '{"spec":{"minio":{"replicas":0}}}'

Procedure

Complete the following tasks to upgrade Watson Knowledge Studio:

If you are not logged in, log in.
Updating the operator
Upgrading the service
Validating the upgrade
What to do next

Updating the operator

The Watson Knowledge Studio operator simplifies the process of managing the Watson Knowledge Studio service on Red Hat® OpenShift Container Platform.

To upgrade Watson Knowledge Studio, ensure that all of the Operator Lifecycle Manager (OLM) objects in the ${PROJECT_CPD_OPS} project, such as the catalog sources and subscriptions, are upgraded to the appropriate release. All of the OLM objects must be at the same release.

Who needs to complete this task?: You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.

When do you need to complete this task?: Complete this task only if the OLM artifacts have not been updated for the current release using the cpd-cli manage apply-olm command with the --upgrade=true option.
It is not necessary to run this command multiple times for each service that you plan to upgrade. If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli will recreate the OLM objects for all of the existing components in the ${PROJECT_CPD_OPS} project.

To update the operator:

Update the OLM objects:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--upgrade=true
```
- If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
- If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Upgrade the Watson Knowledge Studio service.

Upgrading the service

After you update the operator, the upgrade of Watson Knowledge Studio starts automatically.

Scale up the MinIO pods that you scaled down previously.

Check the status of the upgrade to find out when MinIO returns the new product version.

oc get StatefulSet wks-minio-ibm-minio \
-o jsonpath='{.spec.template.metadata.annotations.productVersion}'

When version 4.6.0 or later is returned, run the following commands to scale up the MinIO pods:

oc -n ${PROJECT_CPD_INSTANCE} patch --type=json MinioCluster wks-minio \
-p '[{"op":"remove","path":"/spec/replicasForDev"}]'
oc -n ${PROJECT_CPD_INSTANCE} patch --type=json MinioCluster wks-minio \
-p '[{"op":"remove","path":"/spec/replicasForProd"}]'
oc -n ${PROJECT_CPD_INSTANCE} patch --type=json KnowledgeStudio wks \
-p '[{"op":"remove","path":"/spec/minio/replicas"}]'

Recreate the MinIO cluster.
For the upgrade to finish successfully, you must delete the MinIO cluster and allow the operator to re-create it. Wait for the upgrade to attempt to create the MinIO backup pod, and fail. Then, you can clean up the cluster.
- Wait for the MinIO backup job to run and return an error. The error is expected. To check the status, use the following command:
```
oc -n ${PROJECT_CPD_INSTANCE} get pod | grep wks-minio-ibm-minio-backup
```
- Use the following command to delete the MinIO cluster:
```
oc -n ${PROJECT_CPD_INSTANCE} delete miniocluster wks-minio
```
The Watson Knowledge Studio operator re-creates the MinIO cluster and completes the upgrade.

Validating the upgrade

To verify that the upgrade was successful, complete the following steps:

Check the status of the deployment by using the following command:

oc get KnowledgeStudio wks \
-o jsonpath='{.status.conditions[?(@.type=="Deployed")].status}'

Verify that all of the pods that are listed by the following command are in a Ready state:
```
oc get pods -l 'release in (wks,wks-minio,wks-ibm-watson-ks)'
```

What to do next

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