Upgrading IBM Master Data Management from Version 5.2 to Version 5.4

An instance administrator can upgrade IBM Master Data Management from Version 5.2 to Version 5.4.

Who needs to complete this task?

Instance administrator To upgrade IBM Master Data Management, 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 IBM Master Data Management 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 IBM Master Data Management 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 IBM Master Data Management when you upgraded the IBM Software Hub control plane, complete this task to upgrade IBM Master Data Management.
Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to upgrade more instances of IBM Master Data Management on the cluster.

Information you need to complete this task

Review the following information before you upgrade IBM Master Data Management:

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 IBM Master Data Management 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
```

Common core services: IBM Master Data Management 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 IBM Master Data Management. 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 IBM Master Data Management.

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:

The IBM Master Data Management 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.
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

Where to find more information
If this task is not complete, see Mirroring images to a 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.

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.

Prerequisite services

To enable the full capabilities of IBM Master Data Management, ensure that the following supplemental service is upgraded and running:

IBM Knowledge Catalog

IBM Knowledge Catalog is not a strict installation prerequisite, but if it is not installed, key IBM Master Data Management capabilities such as profiling, automapping, data quality workflows, and data governance will not work. Other features of the IBM Master Data Management service will function normally.

Procedure

Complete the following tasks to upgrade IBM Master Data Management:

Specifying installation options
Upgrading the service
Validating the upgrade
What to do next

Specifying installation options

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

The parameter is optional. If you do not set the installation parameter, the default value is used.

The sample YAML content uses the default value.

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

---
# ............................................................................
# IBM Master Data Management parameters
# ............................................................................
non_olm:
  match360:
    scaleConfig: x-small

Parameter	Description
`scaleConfig`	Specify the size of the service. Default value `small` Valid values `x-small` Restriction: This size is valid only for proof of concept and demonstration installations. `small_mincpureq` `small` `medium` `large` For detailed information about each size, refer to the component scaling guidance PDF.

Upgrading the service

To upgrade IBM Master Data Management:

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.

Update the operator and custom resource for IBM Master Data Management.

Run the appropriate command to create the custom resource.

Default installation (without installation options)

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

Custom installation (with installation options)

cpd-cli manage install-components \
--license_acceptance=true \
--components=match360 \
--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} \
--param-file=/tmp/work/install-options.yml \
--upgrade=true

Validating the upgrade

IBM Master Data Management 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:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=match360

What to do next

Review the list of limitations and known issues and ensure that you complete any necessary steps to work around known problems. For details, see Known issues and limitations for IBM Master Data Management and Known issues and limitations for IBM Software Hub.

Optionally, customize your IBM Master Data Management deployment by changing configuration parameters in the custom resource. For more information, see Modifying the CR to customize your IBM Master Data Management installation.

After you complete the preceding steps, IBM Master Data Management is ready to use.