Upgrading Watson Query from Version 4.0 to Version 4.6

A project administrator can upgrade Watson Query from Cloud Pak for Data Version 4.0 to Version 4.6.

Important: To complete this task, you must be running Watson Query Version 1.7.2 or later. (Version 1.7.2 was released with Cloud Pak for Data Version 4.0 Refresh 2.)
Supported upgrade paths
If you are running Watson Query Version 1.7.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.
Remember:

The Data Virtualization service was renamed to Watson Query in Cloud Pak for Data Version 4.6.0.

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 Query 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 Query, you must be an administrator of the project where Watson Query 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 Query when you upgraded the platform, you can complete this task to upgrade your existing Watson Query 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 Query:

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 Query 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.
Common core services
Watson Query requires the Cloud Pak for Data common core services.

If the common core services are not at the required version for the release, the common core services will be automatically upgraded when you upgrade Watson Query. This increases the amount of time the upgrade takes to complete.

Storage requirements
You don't need to specify storage when you upgrade Watson Query.

Before you begin

Watson Query version numbers and upgrade paths
Verify the Watson Query version numbers that you are upgrading from and to. See Supported upgrade paths in Watson Query.

This task assumes that the following prerequisites are met:

Prerequisite Where to find more information
The cluster meets the minimum requirements for Watson Query. 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 Query software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.

Prerequisite services

Before you upgrade Watson Query, ensure that the following services are upgraded and running:

  • Db2® Data Management Console: Make sure that a Db2 Data Management Console instance has been upgraded and provisioned. For more information, see Upgrading Db2 Data Management Console.
  • Cloud Pak for Data common core services: Watson Query installs Common core services on your Cloud Pak for Data cluster if you do not have it installed. Watson Query upgrades Common core services if you have it installed.

Procedure

To upgrade Watson Query, complete the following steps.

  1. Log in to the cluster.
  2. Update the operator.
  3. Upgrade the service.
  4. Validate the upgrade.
  5. Complete additional steps in specialized installations.
  6. Upgrade the service instance.
  7. Upgrading remote connectors.
  8. Find out what to do next.

Logging in to the cluster

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

To log in to the cluster:

  1. 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.

Updating the operator

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

To upgrade Watson Query, 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:

  1. 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 Query service.

Upgrading the service

After the Watson Query operator is updated, you can upgrade Watson Query.

Who needs to complete this task?
You must be an administrator of the project where Watson Query is installed.
When do you need to complete this task?
Complete this task for each instance of Watson Query that is associated with an instance of Cloud Pak for Data Version 4.6.

To upgrade the service:

  1. Update the custom resource for Watson Query.
    cpd-cli manage apply-cr \
    --components=dv \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
    --license_acceptance=true \
    --upgrade=true

Validating the upgrade

Watson Query is upgraded when the apply-cr command returns [SUCCESS]... The apply-cr command ran successfully.

However, you can optionally run the cpd-cli manage get-cr-status command if you want to confirm that the custom resource status is Completed:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--components=dv
Note:

4.6.0 4.6.2 If you have a Watson Query connection in one of your deployment spaces and you are upgrading to Cloud Pak for Data versions 4.6.0 or 4.6.2, the upgrade might fail with an ERROR Upgrade DV Security and Governance Failed message.

4.6.4 or later This issue does not occur when you upgrade to Cloud Pak for Data versions 4.6.4 or later.

For more information, see Watson Query upgrade to Cloud Pak for Data version 4.6.0 or 4.6.2 fails with "ERROR Upgrade DV Security and Governance Failed" message.

Completing additional steps in specialized installations

If the Watson Query operators are installed in a different project from the IBM Cloud Pak® foundational services operators, you must complete the following steps:

  1. Download and extract the Watson Query migration .tar file.
    1. In your browser, log in to the Cloud Pak for Data web client.

      By logging in to the web client, the download step does not require a login.

    2. Download the .tar file by copying the following URL in a browser:
      https://<Cloud Pak for Data web client URL>/icp4data-addon/dv/add-ons/upgrade.tgz
    3. Copy the .tar file to your OpenShift infrastructure node.
    4. Extract the .tar file:
      tar -xzf upgrade.tgz
  2. Run the clean_old_db2uoperator_artifacts.sh script to delete old Db2U operator artifacts.

Upgrading the service instance

After you upgrade Watson Query, the service instance that is associated with the installation must also be upgraded. This task must be completed by a Cloud Pak for Data administrator or a service instance administrator.

  1. Log in to the cluster as a user with sufficient permissions to complete the task.
    oc login ${OCP_URL}
  2. Change to the project where Watson Query pods are installed.
    oc project ${PROJECT_CPD_INSTANCE}
  3. Upgrade the instance by updating its version field:
    oc patch bigsql db2u-dv --patch '{"spec": {"version": "2.0.4"}}' --type=merge

    This step triggers the instance upgrade, which will take some time to complete. First, the upgrade runs a backup. If this backup fails, the version in .spec.version is reset to the previous version. This process can be monitored in the logs of the Db2U operator manager pod. The value in .status.version is not updated to match .spec.version until the upgrade process has completed successfully.

  4. Run the following command to verify that the version now reads 2.0.4.
    oc get bigsql db2u-dv -o jsonpath='{.status.version}{"\n"}'

    You must wait until the instance upgrade completes before you proceed to the next step.

Upgrading remote connectors

You can upgrade remote connectors by using the UPDATEREMOTECONNECTOR stored procedure. You can run this procedure by using the SQL editor or the Db2 console on the cluster.

  • To update all remote connectors, run the following stored procedure.
    call dvsys.updateremoteconnector('',?,?)
  • If you need to upgrade a set of remote connectors, pass in a comma-separated list.
    call dvsys.updateremoteconnector('<REMOTE_CONNECTOR_NODES>',?,?)

    You can obtain the <REMOTE_CONNECTOR_NODES> by running the following command.

    select node_name from dvsys.listnodes where AGENT_CLASS='R'
  • If you notice that remote connectors do not appear in the user interface after the upgrade, run the following stored procedure on the head pod.
    CALL DVSYS.DEFINEGATEWAYS('<hostname>:<port>')

    Where <hostname> is the hostname of the remote connector and <port> is the port number used by the remote connector to connect to Watson Query. After you run this stored procedure, the remote connector appears in the user interface and when you run dvsys.listnodes.

    See also Defining gateway configuration to access isolated remote connectors.

  • To troubleshoot issues, see Updating remote connectors might fail with a Java™ exception after you upgrade Watson Query.

What to do next

  1. After you upgrade, all active or inactive caches with refresh schedules are reset. You must edit the active caches and set the refresh rate again. For more information, see Adding data caches in Watson Query.

Watson Query is ready to use. For more information, see Virtualizing data with Watson Query.