Upgrading EDB Postgres from Version 5.2 to 5.4

Information you need to complete this task

Review the following information before you upgrade EDB Postgres:

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 EDB Postgres 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 EDB Postgres.

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

In addition, if you plan to use features that require GPU, ensure that you have the appropriate type and number of GPU for EDB Postgres.

Where to find more information
If this task is not complete, see GPU 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 EDB Postgres 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.

GPU operators

If you plan to use features that require GPUs, this task assumes that the operators required to use GPUs are installed.

Where to find more information
If this task is not complete, see Installing operators for services that require GPUs.

Cluster-scoped resources

This task assumes that the cluster-scoped resources, such as custom resource definitions, cluster roles, and cluster role bindings, were updated.

Where to find more information
If this task is not complete, see Updating the cluster-scoped resources for the platform and services.

Image pull secrets

This task assumes that the secrets that contain the image pull credentials for the instance exist.

Where to find more information
If this task is not complete, see Creating image pull secrets for an instance of IBM Software Hub.

Procedure

Complete the following tasks to upgrade EDB Postgres:

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

Upgrading the service

To upgrade EDB Postgres:

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 EDB Postgres.

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=edb_cp4d \
   --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=edb_cp4d

Upgrading existing service instances

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

To upgrade the service instances:

1. Log in to Red Hat OpenShift Container Platform as an instance administrator.

   ${OC_LOGIN}

   Remember: OC_LOGIN is an alias for the oc login command.
2. Get the list of EDB Postgres service instances:

   oc get CPDEdbInstance \
   --namespace=${PROJECT_CPD_INST_OPERANDS}

3. Set the INSTANCE_NAME environment variable to the name of the service instance that you want to upgrade:

   export INSTANCE_NAME="<instance-name>"

4. Set the INSTANCE_VERSION environment variable to the version that corresponds to the version of Cloud Pak for Data on your cluster:

   export INSTANCE_VERSION=<version>

   Use the following table to determine the appropriate value:

   IBM Software Hub version	Add-on version	Service instance versions (Pick one)
   5.4.0	5.4.0	14.22, 15.17, 16.13, 17.9, 18.3

   Note: EDB Postgres does not support major version upgrades directly. They only support rolling updates or minor release upgrades for PostgreSQL. For more details, refer to EDB PostgreSQL Rolling Updates.

   Users must perform a side-by-side upgrade for major versions, as outlined in EDB PostgreSQL Database Import.

   If the upgrade is required for a major version, upgrade to the latest version.

5. Update the version in the service instance custom resource:

   oc patch CPDEdbInstance ${INSTANCE_NAME} \
   --namespace=${PROJECT_CPD_INST_OPERANDS} \
   --type=merge \
   --patch='{"spec": {"version": "${INSTANCE_VERSION}"}}'

   Note: Starting from version 5.2.x, the following command is also supported to update the version in the service instance custom resource:

   ./cpd-cli service-instance upgrade \
     --instance-name=${INSTANCE_NAME} \
     --service-type=edb \
     --profile=${CPD_PROFILE_NAME} \
     --version=5.2.0 \
     --merge-override=true \
     --override=parameters.yaml

   Here is the sample of the parameters.yaml file:

   parameters:
    version: '${INSTANCE_VERSION}'

6. Repeat the preceding steps to upgrade each service instance in the operands project.

What to do next

Your existing EDB Postgres database instances are ready to use. You must complete Post-installation setup for the EDB Postgres service before accessing EDB Postgres.