Table of contents

Preparing to upgrade the control plane

If you plan to upgrade control plane on IBM® Cloud Pak for Data, a cluster administrator must update the cluster environment for control plane.

Before you begin

Required role: To complete this task, you must be a cluster administrator.

Before you update the cluster for control plane, ensure that:

Tip: For a list of all available options, enter the following command:
./cpd-cli adm --help

Upgrade the control plane metadata

Before you prepare to upgrade, you must convert the control plane metadata to be compatible with the new version 3.5 model by running the following command:

./cpd-cli operator-upgrade -n Project

where Project is the project where the Cloud Pak for Data control plane to be upgraded is deployed.

Procedure

  1. Prepare the cluster for control plane by completing the appropriate task for your environment:
  2. Complete the tasks listed in What to do next

Preparing clusters connected to the internet

From your installation node:

  1. Change to the directory where you placed the Cloud Pak for Data command-line interface and the repo.yaml file.
  2. Log in to your Red Hat® OpenShift® cluster as an administrator:
    oc login OpenShift_URL:port
  3. Run the following command to see a preview of the list of resources that must be created or updated on the cluster:
    ./cpd-cli adm \
    --repo ./repo.yaml \
    --assembly lite \
    --arch Cluster_architecture \  
    --namespace Project \
    --latest-dependency
    Important: By default, this command gets the latest version of the assembly. If you want to install a specific version of control plane, add the following line to your command after the --assembly flag:
    --version Assembly_version \

    The --latest-dependency flag gets the latest version of the dependent assemblies. If you remove the --latest-dependency flag, the installer will either leave the dependent assemblies at their current version or will update the dependent assemblies to the minimum required version.

    Tell the person who will upgrade control plane whether you used either of these flags. The upgrade command must be run with the same flags.

    Replace the following values:

    Variable Replace with
    Assembly_version
    The version of control plane that you want to install. The assembly versions are listed in System requirements for Cloud Pak for Data.
    Cluster_architecture Specify the architecture of your cluster hardware:
    • For x86-64 hardware, remove this flag or specify x86_64
    • For POWER hardware, specify ppc64le
    • For IBM Z hardware, specify s390x
    Project The project where the Cloud Pak for Data control plane is installed.

    The command returns a list of the changes that you must make to your cluster to ensure that control plane can run on your cluster.

  4. Make the necessary changes to your cluster. You can choose one of the following methods to make the changes:
    To automatically apply the changes to your cluster:
    Re-run the cpd adm command with the --apply flag:
    ./cpd-cli adm \
    --repo repo.yaml \
    --assembly lite \
    --arch Cluster_architecture \
    --namespace Project \
    --latest-dependency \
    --apply

    Replace the variables with the same values that you used the last time you ran the command.

    To manually apply the changes to your cluster:
    Follow the appropriate procedures from the Red Hat OpenShift documentation to complete the required tasks.

Preparing air-gapped clusters

From your installation node:

  1. Change to the directory where you placed the Cloud Pak for Data command-line interface.
  2. Log in to your Red Hat OpenShift cluster as an administrator:
    oc login OpenShift_URL:port
  3. Run the following command to see a preview the list of resources that must be created or updated on the cluster:
    ./cpd-cli adm \
    --assembly lite \
    --arch Cluster_architecture \
    --namespace Project \
    --load-from Image_directory_location \
    --latest-dependency
    Note: If the assembly was downloaded using the delta-images command, remove the --latest-dependency flag from the command. If you don't remove the --latest-dependency flag you will get an error indicating that the flag cannot be used.

    Tell the person who will upgrade control plane whether you used the --latest-dependency flag. If you run this command with the --latest-dependency flag, the upgrade command must also be run with the flag.

    Replace the following values:

    Variable Replace with
    Cluster_architecture Specify the architecture of your cluster hardware:
    • For x86-64 hardware, remove this flag or specify x86_64
    • For POWER hardware, specify ppc64le
    • For IBM Z hardware, specify s390x
    Project The project where the Cloud Pak for Data control plane is installed.
    Image_directory_location The location of the cpd-cli-workspace directory.

    The command returns a list of the changes that you must make to your cluster to ensure that control plane can run on your cluster.

  4. Make the necessary changes to your cluster. You can choose one of the following methods to make the changes:
    To automatically apply the changes to your cluster:
    Re-run the cpd adm command with the --apply flag:
    ./cpd-cli adm \
    --assembly lite \
    --arch Cluster_architecture \
    --namespace Project \
    --load-from Image_directory_location \
    --latest-dependency \
    --apply

    Replace the variables with the same values that you used the last time you ran the command.

    To manually apply the changes to your cluster:
    Follow the appropriate procedures from the Red Hat OpenShift documentation to complete the required tasks.

What to do next