Upgrading Db2 Data Gate from Version 4.8.x to a later 4.8 refresh

Information you need to complete this task

Review the following information before you upgrade Db2 Data Gate:

Version requirements

All the components that are associated with an instance of Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is at Version 4.8.9, you must upgrade Db2 Data Gate to Version 4.8.9.

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

Storage requirements

Specify the storage that 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 services

Before you upgrade Db2 Data Gate, ensure that the following services are upgraded and running:

• Db2

  or

• Db2 Warehouse

See Required steps before upgrading the Db2 Data Gate instance for more information.

Procedure

Complete the following tasks to upgrade Db2 Data Gate:

1. Upgrading the service
2. Validating the upgrade
3. Upgrading existing service instances
4. Verifying the service instance upgrade
5. What to do next

Upgrading the service

To upgrade Db2 Data Gate:

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 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 create the custom resource.

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

   ---

   IBM Storage Fusion Data Foundation storage

   Run the following command to create the custom resource.

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

   ---

   IBM Storage Fusion Global Data Platform storage

   Remember: When you use IBM Storage Fusion storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc or ibm-storage-fusion-cp-sc.

   Run the following command to create the custom resource.

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

   ---

   IBM Storage Scale Container Native storage

   Remember: When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc.

   Run the following command to create the custom resource.

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

   ---

   Portworx storage

   Run the following command to create the custom resource.

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

   ---

   NFS storage

   Remember: When you use NFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically managed-nfs-storage.

   Run the following command to create the custom resource.

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

   ---

   AWS with EFS storage only

   Remember: When you use EFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically efs-nfs-client.

   Run the following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=datagate \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --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 create the custom resource.

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

   ---

   NetApp Trident

   Remember: When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.

   Run the following command to create the custom resource.

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

   ---

Validating the upgrade

[SUCCESS]... The apply-cr 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=datagate

Upgrading existing service instances

After you upgrade Db2 Data Gate, you must upgrade any service instances that are associated with Db2 Data Gate.

Before you begin

Create a profile on the workstation from which you will upgrade the service instances.

The profile must be associated with a Cloud Pak for Data user who has either the following permissions:

• Create service instances (can_provision)
• Manage service instances (manage_service_instances)

For more information, see Creating a profile to use the cpd-cli management commands.

1. To set your profile, run the following command:

   export CPD_PROFILE_NAME=<my_profile_name>
   

   where <my_profile_name> is the name of your profile.

2. Choose one of the following options to upgrade your service instances:

   Upgrade a specific service instance in a Cloud Pak for Data instance

   
   cpd-cli service-instance upgrade --instance-name=<dg_service_instance_name> \
   --service-type=dg \
   --profile=${CPD_PROFILE_NAME} --watch

   where:

   <dg_service_instance_name>

   Is the name (display name) of your service instance.

   --watch

   Is an optional parameter. If you specify it, upgrade status information is added to the screen output. See this example:

   Service instance DG-xxyyy 1699321926126046 upgrade is still running
   Service instance DG-xxyyy 1699321926126046 upgrade is still running
   Service instance DG-xxyyy 1699321926126046 upgrade is still running
   .
   .
   .

   Upgrade all service instances of the same service type

   cpd-cli service-instance upgrade \
   --all \
   --service-type=dg \
   --profile=${CPD_PROFILE_NAME} --watch

Verifying the service instance upgrade

You can use one of the following commands 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"}'

• Check the status information about the service instance upgrade in the output of step 2. Db2 Data Gate instance has been upgraded if the service-instance upgrade command contains the following line:

  [SUCCESS] ... Service instance DG-xxyyy, 1699324826126046 upgrade is
          complete.

• Run the following command and see if the Provision status has changed to UPGRADED:

  cpd-cli service-instance list --profile=${CPD_PROFILE_NAME} --service-type dg

  Example:

   Namespace           Service type        Version             ID                  Name                Provision status    Upgrade version option
   ---------           ------------        -------             --                  ----                ----------------    ----------------------
   zen1                dg                  5.1.0               1699321926126046    DG-xxyyy            UPGRADED            []

What to do next

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