Upgrading Synthetic Data Generator from Version 4.8 to Version 5.1

An instance administrator can upgrade Synthetic Data Generator from IBM Cloud Pak® for Data Version 4.8 to IBM® Software Hub Version 5.1.

Who needs to complete this task?

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

Information you need to complete this task

Review the following information before you upgrade Synthetic Data Generator:

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.1.3, you must upgrade Synthetic Data Generator to Version 5.1.3.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

If you do not 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: Synthetic Data Generator 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 Synthetic Data Generator. 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:

Prerequisite	Where to find more information
The cluster meets the minimum requirements for Synthetic Data Generator.	If this task is not complete, see System requirements.
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`	If this task is not complete, see Updating client workstations.
The IBM Software Hub control plane is upgraded.	If this task is not complete, see Upgrading an instance of IBM Software Hub.
For environments that use a private container registry, such as air-gapped environments, the Synthetic Data Generator software images are mirrored to the private container registry.	If this task is not complete, see Mirroring images to a private container registry.
For environments that use a private container registry, such as air-gapped environments, the `cpd-cli` is configured to pull the `olm-utils-v3` image from the private container registry.	If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.

Prerequisite services

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

watsonx.ai™

Procedure

Complete the following tasks to upgrade Synthetic Data Generator:

Upgrading the service
Validating the upgrade
What to do next

Upgrading the service

Important: The Operator Lifecycle Manager (OLM) objects for Synthetic Data Generator 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 Synthetic Data Generator:

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 custom resource for Synthetic Data Generator.

cpd-cli manage apply-cr \
--components=syntheticdata \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

Synthetic Data Generator 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=syntheticdata

What to do next

Synthetic Data Generator is ready to use. To get started with Synthetic Data Generator, see Creating Synthetic data in the IBM watsonx documentation.