Upgrading Db2 from Version 5.0 to Version 5.2

An instance administrator can upgrade Db2 from IBM Cloud Pak® for Data Version 5.0 to IBM Software Hub Version 5.2.

Who needs to complete this task?

Instance administrator To upgrade Db2, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance

The operators for this instance of Db2 are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The custom resources for the control plane and Db2 are installed in the operands project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to upgrade the IBM Software Hub control plane and one or more services at the same time, follow the process in Upgrading an instance of IBM Software Hub instead.
  • If you didn't upgrade Db2 when you upgraded the IBM Software Hub control plane, complete this task to upgrade Db2.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to upgrade more instances of Db2 on the cluster.

Information you need to complete this task

Review the following information before you upgrade Db2:

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.2.2, you must upgrade Db2 to Version 5.2.2.

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 Db2.
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
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 Db2 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-v3 image from the private container registry.
    Where to find more information
    If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.

Procedure

Complete the following tasks to upgrade Db2:

  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

Important: The Operator Lifecycle Manager (OLM) objects for Db2 were updated when you upgraded the IBM Software Hub platform. The cpd-cli manage apply-olm updates all of the OLM objects in the operators project at the same time.

To upgrade Db2:

  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.
    cpd-cli manage apply-cr \
--components=db2oltp \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

Db2 is upgraded when the apply-cr command returns:
[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=db2oltp

Upgrading existing service instances

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

Before you begin

If you have previously upgraded your license, see Upgrading the license before you deploy Db2 to upgrade to Db2 12.1.

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

The profile must be associated with a IBM Software Hub 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.

Remove custom patches and override scripts, if applicable:
  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. Run the following command to remove custom patches and override scripts:
    oc set volume statefulset/c-${DB2U_ID}-db2u -n ${PROJECT_CPD_INST_OPERANDS} --remove --name=<volume_name>
Procedure

To upgrade the service instance:

  1. Get the list of Db2 service instances:
    cpd-cli service-instance list \
--service-type=db2oltp \
--profile=${CPD_PROFILE_NAME}
  2. Set the INSTANCE_NAME environment variable to the name of the service instance that you want to upgrade:
    export INSTANCE_NAME=<instance-name>
  3. Check whether your Db2 service instance is in running state:
    cpd-cli service-instance status ${INSTANCE_NAME} \ 
--profile=${CPD_PROFILE_NAME} \ 
--service-type=db2oltp
  4. Upgrade the service instance:
    cpd-cli service-instance upgrade \
--service-type=db2oltp \
--instance-name=${INSTANCE_NAME} \
--profile=${CPD_PROFILE_NAME}
  5. Monitor your Db2uCluster or Db2uInstance status to check if the custom resource state changes to Not Ready and then to Ready state:
    • For Db2uCluster custom resource, run the following command:
      oc get db2ucluster <instance_id> -o jsonpath='{.status.state} {"\n"}'
    • For Db2uInstance custom resource, run the following command:
      oc get db2uinstance <instance_id> -o jsonpath='{.status.state} {"\n"}'
    If the custom resource state returns as UpgradeCheckFailed, see troubleshooting db2ckupgrade issues.
  6. Verify that the service instance is upgraded and is ready to use.
  7. Repeat the preceding steps to upgrade each service instance associated with this instance of IBM Software Hub.

Verifying the service instance upgrade

You can use a command or the web console to verify that the service instance was upgraded and is ready to use.

Command
  1. Get your Db2uCluster or Db2uInstance status. Wait for the status to change to Ready:
    • For Db2uCluster custom resource, run the following command:
      oc get db2ucluster <instance_id> -o jsonpath='{.status.state} {"\n"}'
    • For Db2uInstance custom resource, run the following command:
      oc get db2uinstance <instance_id> -o jsonpath='{.status.state} {"\n"}'
  2. Check the status of your Db2 service instance: 
    cpd-cli service-instance status ${INSTANCE_NAME} \
--profile=${CPD_PROFILE_NAME} \
--service-type=db2oltp
  3. Check if the service instances is updated:
    cpd-cli service-instance list \
--profile=${CPD_PROFILE_NAME}\
--service-type=db2oltp
  4. If you are upgrading to IBM Software Hub Version 5.2.0, Update the service instance configmap or go to step 7.
Web console
From the Database details page, wait for the database version to change.

Updating the service instance configmap

5.2.0Complete this step only if you are upgrading to Version 5.2.0. If you are upgrading to 5.2.1 or later, skip this step.

After upgrading, you need to update the configmap. Run the following commands to patch the instance.json configmap.

  1. Retrieve the values for CM_NAME, NAMESPACE, and NEW_VERSION variables by running the following command:
    cpd-cli service-instance list \
--profile=${CPD_PROFILE_NAME}\
--service-type=db2oltp
    The sample output of the previous command is as follows:
    Namespace      Service type           Version                ID                           Name                  Provision status       Upgrade version option
---------     -------------       ---------------        ---------------         ------------------------      -------------------     -----------------------
cpd-instance    db2oltp           11.5.9.0-cn5-amd64      1689782702423826             Db2-Instance            UPGRADE_IN_PROGRESS              []
  2. Set the values for the environment variables to run the bash script in step 3.
    1. Set the CM_NAME environment variable to the Db2u instance configmap name:
      CM_NAME=""  #The instance.json configmap name, example db2oltp-1689782702423826-db2oltp-cm
      CM_NAME is Db2u instance configmap name and is obtained like this: <service_type>-<instance_id>-<service_type>-cm, for example, db2oltp-1689782702423826-db2oltp-cm.
    2. Set the NAMESPACE environment variable:
      NAMESPACE="zen" #default is zen
      NAMESPACE is Cluster namespace where Db2 instance and the configmap are installed, for example, cpd-instance.
    3. Set the NEW_VERSION environment variable:
      NEW_VERSION="" #addon_version, example: 11.5.9.0-cn5-amd64
      NEW_VERSION is upgraded Db2 instance version, for example, 11.5.9.0-cn5-amd64.
  3. Run the bash script after updating the environment variables.
    #!/bin/bash
set -e

CM_NAME=""
NAMESPACE="zen"
NEW_VERSION=""

# Step 0: Get the backup of the configmap 
oc get configmap "$CM_NAME" -n "$NAMESPACE" -oyaml > "$CM_NAME".yaml

# Step 1: Get the current instance.json value
raw_json=$(oc get configmap "$CM_NAME" -n "$NAMESPACE" -o jsonpath='{.data.instance\.json}')

# Step 2: Update the addon_version, create_arguments.metadata.version and provision_status field using jq:
updated_json=$(echo "$raw_json" | jq \
  --arg ver "$NEW_VERSION" \
  '.addon_version = $ver
   | .create_arguments.metadata.version = $ver
   | .provision_status = "UPGRADED"
   | .create_arguments.metadata["status-info"].status = "RUNNING"
   | .create_arguments.metadata.status = "RUNNING"')

# Step 3: Format as pretty-printed multiline
formatted_json=$(echo "$updated_json" | jq '.')

escaped_json=""
first_line=true
while IFS= read -r line; do
  line=${line//\"/\\\"}  # escape quotes
  if [ "$first_line" = true ]; then
    escaped_json="$line"
    first_line=false
  else
    escaped_json="${escaped_json}\\n${line}"
  fi
done <<< "$formatted_json"

escaped_json="\"${escaped_json}\""

# Step 4: Build patch payload
patch_payload=$(cat <<EOF
[
  {
    "op": "replace",
    "path": "/metadata/labels/icpdata_addon_version",
    "value": "$NEW_VERSION"
  },
  {
    "op": "replace",
    "path": "/data/instance.json",
    "value": $escaped_json
  }
]
EOF
)

# Step 5: Apply the patch
oc patch configmap "$CM_NAME" -n "$NAMESPACE" --type=json -p "$patch_payload"
echo -e "\nPatch command executed for ConfigMap '${CM_NAME}' in namespace '${NAMESPACE}' with version '${NEW_VERSION}'."
oc get cm -n ${NAMESPACE} ${CM_NAME} -o yaml
    Note: The script always creates a backup of the configmap before patching it. The copy of the configmap is saved to a YAML file with the same name as the configmap.

What to do next

Important: If you have a Q Replication deployment, you need to exchange TLS certificates after upgrading. For more information, see Trusting targets and exchanging Db2 TLS certificates.

You must complete Post-installation setup for the Db2 service before users can access Db2.