Upgrading Data Gate from Version 5.2 to Version 5.4

Information you need to complete this task

Review the following information before you upgrade Data Gate:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is at Version 5.4.0, you must upgrade Data Gate to Version 5.4.0.

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

Before you begin

This task assumes that the following prerequisites are met:

System requirements

This task assumes that the cluster meets the minimum requirements for Data Gate.

Where to find more information
If this task is not complete, see System requirements.

Workstation

This task assumes that the workstation from which you will run the upgrade is set up as a client workstation and has the following command-line interfaces:

• IBM Software Hub CLI: cpd-cli
• OpenShift® CLI: oc
• Helm CLI: helm

Where to find more information
If this task is not complete, see Updating client workstations.

Control plane

This task assumes that the IBM Software Hub control plane is upgraded.

Where to find more information
If this task is not complete, see Upgrading an instance of IBM Software Hub.

Private container registry

If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:

1. The Data Gate software images are mirrored to the private container registry.

   Where to find more information
   If this task is not complete, see Mirroring images to a private container registry.

2. The cpd-cli is configured to pull the olm-utils-v4 image from the private container registry.

   Where to find more information
   If this task is not complete, see Pulling the olm-utils-v4 image from the private container registry.

Prerequisite services

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

1. Db2

   or

2. Db2 Warehouse

Procedure

Complete the following tasks to upgrade 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 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 operator and custom resource for Data Gate.

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=datagate \
   --release=${VERSION} \
   --patch_id=${PATCH_ID} \
   --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --image_pull_prefix=${IMAGE_PULL_PREFIX} \
   --image_pull_secret=${IMAGE_PULL_SECRET} \
   --upgrade=true

Validating the upgrade

[SUCCESS]... The install-components 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 Data Gate, you must upgrade any service instances that are associated with Data Gate.

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. 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 whether 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                  9.0.0               1699321926126046    DG-xxyyy            UPGRADED            []

What to do next

Upgrading to Version 5.2.1

You might have to include your Db2/Db2 Warehouse configuration changes in the newly created Data Gate configmap. For more information, see Updating the necessary target Db2 configuration changes.

Upgrading to a version lower than 5.2.1

You might have to adjust incorrect settings for your Db2 target database. For more information, see Fixing incorrect Db2 configuration settings after an upgrade.

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