Upgrading IBM Cloud Pak for Data (Upgrading from Version 4.8.x to a later 4.8 refresh)

After you upgrade the IBM Cloud Pak foundational services for the instance, you can upgrade the IBM Cloud Pak for Data control plane and services.

Upgrade phase
You are not here. Updating your client workstation
You are not here. Collecting required information
You are not here. Preparing to run an upgrade in a restricted network
You are not here. Preparing to run an upgrade from a private container registry
You are not here. Upgrading shared cluster components
You are here icon. Upgrading an instance of Cloud Pak for Data
You are not here. Updating your cluster
Who needs to complete this task?

Instance administrator An instance administrator can complete this task.

When do you need to complete this task?

Repeat as needed If you have multiple instances of Cloud Pak for Data on the cluster, this task for each instance that you want to upgrade.

Before you begin

Best practice: You can run the commands in this task exactly as written using the installation environment variables. Ensure that you added the new environment variables from Updating your environment variables script.

In addition, ensure that you source the environment variables before you run the commands in this task.

About this task

You can choose whether you want to:
  • Upgrade the Cloud Pak for Data control plane before you upgrade the services in the instance
  • Upgrade the Cloud Pak for Data control plane and the services at the same time.
Remember: All of the software in the instance must be installed at the same version.

When you run the cpd-cli manage apply-olm command, all of the operators in the instance are upgraded to the same version.

Procedure

  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. Review the license terms for Cloud Pak for Data.
    The Cloud Pak for Data licenses are available online. Run the appropriate command to get the URL for your license:
    Enterprise Edition
    cpd-cli manage get-license \
    --release=${VERSION} \
    --license-type=EE

    Standard Edition
    cpd-cli manage get-license \
    --release=${VERSION} \
    --license-type=SE

  3. Upgrade the operators in the operators project for the instance.
    Tip: Before you run this command against your cluster, you can preview the oc commands that this command will issue on your behalf by running the command with the --preview=true option.

    The oc commands are saved to the preview.sh file in the work directory.

    The following command upgrades all of the operators in the operators project.

    cpd-cli manage apply-olm \
    --release=${VERSION} \
    --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
    --upgrade=true
    Wait for the cpd-cli to return the following message before proceeding to the next step:
    [SUCCESS]... The apply-olm command ran successfully.

    If the apply-olm command fails, see Troubleshooting the apply-olm command during installation or upgrade.

  4. Confirm that the operator pods are Running or Completed:
    oc get pods --namespace=${PROJECT_CPD_INST_OPERATORS}
  5. Upgrade the operands in the operands project for the instance.
    Tip: Before you run this command against your cluster, you can preview the oc commands that this command will issue on your behalf by running the command with the --preview=true option.

    The oc commands are saved to the preview.sh file in the work directory.

    The command that you run depends on the storage on your cluster:


    Red Hat OpenShift Data Foundation storage

    Create the custom resources for the specified components.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    IBM Storage Fusion Data Foundation storage

    Create the custom resources for the specified components.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    IBM Storage Fusion Global Data Platform storage

    Create the custom resources for the specified components.

    When you use IBM Storage Fusion storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc or ibm-storage-fusion-cp-sc.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    IBM Storage Scale Container Native storage

    Create the custom resources for the specified components.

    When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    Portworx storage

    Create the custom resources for the specified components.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --storage_vendor=portworx \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --storage_vendor=portworx \
    --license_acceptance=true \
    --upgrade=true|false

    NFS storage

    When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically managed-nfs-storage.

    Create the custom resources for the specified components.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    AWS EFS storage only

    Create the custom resources for the specified components.

    When you use only EFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically efs-nfs-client.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    AWS EFS and EBS storage

    Create the custom resources for the specified components.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    NetApp Trident

    Create the custom resources for the specified components.

    When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ontap-nas.

    Cloud Pak for Data control plane and services

    By default, the apply-cr upgrades up to 4 components at the same time. You can adjust this setting by specifying the --parallel_num option.

    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=${COMPONENTS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Cloud Pak for Data control plane only
    cpd-cli manage apply-cr \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --components=cpd_platform \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true

    Wait for the cpd-cli to return the following message before proceeding to the next step:
    [SUCCESS]... The apply-cr command ran successfully.
  6. Confirm that the status of the operands is Completed:
    cpd-cli manage get-cr-status \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

What to do next

If you use the cpdbr service to back up Cloud Pak for Data, see Updating the cpdbr service (Upgrading from Version 4.8.x to a later 4.8 refresh).

If you don't use the cpdbr service to back up Cloud Pak for Data, your next steps depend on which components you upgraded:

Cloud Pak for Data control plane and services
If you upgraded the Cloud Pak for Data control plane and the services in the instance, see Setting up services after install or upgrade.
Cloud Pak for Data control plane only
If you upgraded only the Cloud Pak for Data control plane, you must upgrade the services in the instance. For more information, see Services.