Upgrading Db2 Data Gate to the latest Version 4.6 refresh

A project administrator can upgrade Db2 Data Gate from Cloud Pak for Data Version 4.5 to Version 4.6.

What permissions do you need to complete this task?
The permissions that you need depend on which tasks you must complete:
  • To update the Db2 Data Gate 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 Db2 Data Gate, you must be an administrator of the project where Db2 Data Gate 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 Db2 Data Gate when you upgraded the platform to Version 4.6, you can complete this task to upgrade your existing Db2 Data Gate 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 Db2 Data Gate:

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
Db2 Data Gate 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 Db2 Data Gate what storage you use in your existing installation. You cannot change the storage that is associated with Db2 Data Gate 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 Db2 Data Gate. 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 Db2 Data Gate software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.

Procedure

Complete the following tasks to upgrade Db2 Data Gate:

  1. Logging in to the cluster
  2. Updating the operator
  3. Upgrading the service
  4. Validating the upgrade
  5. Upgrading each Db2 Data Gate deployment
  6. Verifying the deployment upgrade
  7. 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 Db2 Data Gate operator simplifies the process of managing the Db2 Data Gate service on Red Hat® OpenShift® Container Platform.

To upgrade Db2 Data Gate, 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 Db2 Data Gate service.

Upgrading the service

After the Db2 Data Gate operator is updated, you can upgrade Db2 Data Gate.

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

To upgrade the service:

  1. Update the custom resource for Db2 Data Gate.

    The command that you run depends on the storage on your cluster:

    Red Hat OpenShift Data Foundation storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    IBM Storage Fusion storage

    Run the following command to update the custom resource.

    Remember: When you use IBM Storage Fusion storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    IBM Storage Scale Container Native storage

    Run the following command to update the custom resource.

    Remember: When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    Portworx storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--storage_vendor=portworx \
--license_acceptance=true \
--upgrade=true
    NFS storage

    Run the following command to update the custom resource.

    Remember: When you use NFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    AWS with EFS storage only

    Run the following command to update the custom resource.

    Remember: When you use EFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same RWX storage class.
    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    AWS with EFS and EBS storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true
--upgrade=true
    IBM Cloud with IBM Cloud File Storage only

    Run the following command to update the custom resource.

    Remember: When you use IBM Cloud File Storage storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    IBM Cloud with IBM Cloud File Storage and IBM Cloud Block Storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=datagate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

Db2 Data Gate 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=datagate

Upgrading each Db2 Data Gate deployment

Important: To complete this task, you must run Db2® Data Gate Version 2.6.0 or later.
  1. Log in to Red Hat OpenShift Container Platform as a user with sufficient permissions to complete the task:
    
oc login OpenShift_URL:port
  2. For each Db2 Data Gate deployment, follow these steps to check the Db2 Data Gate version:
    1. Run the following command to find the instance identifier (the result will be under "NAME"):
      oc get dginstance
    2. Run the following command, substituting the instance identifier (instance_id), to get the version:
      
oc get dginstance instance_id -o yaml | grep version
  3. Run the oc patch command, specifying 3.2.0 as the dg_version, to upgrade the Db2 Data Gate deployment. Replace instance_id with the deployment identifier that you obtained from the oc get dginstance command: 
    
oc patch dginstance instance_id --type merge 
-p '{"spec":{"version":"dg_version", "metadata":{"version":"dg_version"}}}'

Verifying the deployment upgrade

You can use a command to verify that the deployment was upgraded and is ready to use.

Run the following command and wait for the status to change to Completed:

oc get dginstance instance_id -o jsonpath='{.status.datagateInstanceStatus} {"\n"}'

What to do next

Db2 Data Gate is ready to use. To get started with Db2 Data Gate, see Administering Db2 Data Gate.