Upgrading Watson Knowledge Studio from Version 4.6.x to a later 4.6 refresh
A project administrator can upgrade Watson Knowledge Studio from one Cloud Pak for Data Version 4.6 refresh to a later 4.6 refresh.
service-instance
upgrade
command from the Cloud Pak for Data
command-line interface. - 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.
- 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
- When do you need to complete this task?
- If you didn't upgrade Watson Knowledge
Studio when you upgraded the platform to Version 4.6, 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
the cpd-cli has the latest version of the
olm-utils-play image. |
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 step
Complete the following prerequisite task before you upgrade Watson Knowledge Studio:
- Make a backup of your data.
Preserve the backup in a safe location. For more information about backing up your Watson Knowledge Studio service data, see Backing up and restoring data in the product documentation on the IBM® Cloud Docs site. That topic also includes information about restoring your data if that becomes necessary.
Procedure
Complete the following tasks to 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: Thelogin-to-ocp
command takes the same input as theoc login
command. Runoc login --help
for details.
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.
Validating the upgrade
- 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)'