Upgrading Data Replication from Version 5.3.x to a later Version 5.3 refresh

An instance administrator can upgrade Data Replication from Version 5.3.x to a later Version 5.3 refresh.

Who needs to complete this task?

Instance administrator To upgrade Data Replication, 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 Data Replication 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 Data Replication 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 Data Replication when you upgraded the IBM Software Hub control plane, complete this task to upgrade Data Replication.

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

Information you need to complete this task

Review the following information before you upgrade Data Replication:

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.3.1, you must upgrade Data Replication to Version 5.3.1.

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
Common core services
Data Replication requires the IBM Software Hub common core services.

If the common core services are not at the correct version in the operands project for the instance, the common core services are automatically upgraded when you upgrade Data Replication. The common core services upgrade increases the amount of time the upgrade takes to complete.

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 Replication.
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: 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 Data Replication 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.
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.

Procedure

Complete the following tasks to upgrade Data Replication:

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

Specifying installation options

If you plan to install Data Replication, you must specify the following installation option in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameter is required.

Follow the appropriate guidance for the version of IBM Software Hub that you installed:

Version 5.3.1

5.3.1 and later The formatting applies only to IBM Software Hub Version 5.3.1.

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

---
# ............................................................................
# Data Replication parameters
# ............................................................................
non_olm:
  replication:
    licenseType: {{license_type}}
Version 5.3.0

Add the parameter to the override_components_meta: section of the install-options.yml file under the replication: entry.

Replace <license> with the appropriate value for your environment. 

# ............................................................................
# Data Replication parameters
# ............................................................................
  replication:
    replication_license_type: <license>
Parameter Description
replication_license_type Specify the license that you purchased.
Valid values:
IDRC
Specify this option if you purchased the IBM Data Replication Cartridge for IBM Software Hub.
IIDRC
Specify this option if you purchased the IBM InfoSphere® Data Replication Cartridge for IBM Software Hub.
IDRM
Specify this option if you purchased IBM Data Replication Modernization.
IIDRM
Specify this option if you purchased IBM InfoSphere Data Replication Modernization.
IDRZOS
Specify this option if you purchased IBM Data Replication for Db2® z/OS® Cartridge.
IIDRWXTO
Specify this option if you purchased IBM InfoSphere Data Replication for watsonx.data™ Cartridge.

Upgrading the service

To upgrade Data Replication:

  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 Replication.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=replication \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET} \
--param-file=/tmp/work/install-options.yml \
--upgrade=true

Validating the upgrade

Data Replication is upgraded when the install-components command returns:
[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:

Upgrading existing service instances

The service instances are automatically upgraded when you upgrade Data Replication.

What to do next

Data Replication is ready to use.

For information about how to give users access to Data Replication instances, see Administering Data Replication.