Upgrading the Platform UI

Upgrade the IBM Cloud Pak® for Integration UI (Platform UI) by upgrading the Cloud Pak for Integration operator and custom resource.

This task must be performed by a cluster administrator. For more information about this role, see Roles and permissions.

Important: Versions 2021.1.1 and 2020.4.1 are deprecated. Version 2020.3.1 is removed. For more information, see the table of supported operator versions in Deploying the Platform UI by using the OpenShift console.

Upgrading the IBM Cloud Pak for Integration instance involves these tasks, in the order provided:

  1. Before you begin

  2. Upgrading the IBM Cloud Pak for Integration operator

  3. Upgrading the Platform UI instance

These operations often require manual steps. For more information, see each of the following sections.

Before you begin

Review the applicable topic linked from Overview - Upgrading before you upgrade the Platform UI. Pay particular attention to the required order of upgrade for Red Hat® OpenShift® Container Platform and IBM Cloud Pak foundational services, as well as tasks that can be performed after the upgrade completes.

Upgrading the IBM Cloud Pak for Integration operator

To upgrade the operator, follow the instructions in Upgrading operators by using the OpenShift web console and upgrade the IBM Cloud Pak for Integration Platform Navigator or IBM Cloud Pak for Integration operator. The name that you get depends on what version is installed.

When the operator is upgraded, you can upgrade the instance.

Upgrading the Platform UI instance

Editing the custom resource (in the OpenShift web console or the CLI) completes the upgrade of the Platform UI instance.

An upgraded Platform UI operator might support new versions of the Platform UI custom resource. You can confirm what versions are available for a specific instance of Platform UI by checking the status.versions.available section of the custom resource. For more information about available versions, see Operator channel versions for this release.

Using the OpenShift web console:

  1. Click to expand Project and select the project in which you deployed the Platform UI.

  2. In the navigation panel, click Operators > Installed Operators.

  3. In the list on the Installed Operators panel, find and click IBM Cloud Pak for Integration.

  4. Click the Platform UI tab.

  5. Click the instance that is listed.

  6. Click YAML. A YAML editor opens.

  7. For spec.version, enter 2022.2.1.

  8. For spec.license.license, enter either L-RJON-CD3JKX or L-RJON-CJR2WN. For more information about specific licenses, see Licensing.

  9. When upgrading from 2020.4.1, the required entry for the storage class (spec.storage.class) does not exist in the YAML, so you must add the syntax and the value. For the value of spec.storage.class, specify a file storage class that supports ReadWriteMany (RWX) volumes and allows read and write access to non-root users. Supported storage providers include ibmc-file-gold-gid, Red Hat OpenShift Data Foundation (formerly Red Hat OpenShift Container Storage), Spectrum, and Portworx. For more information about storage support and configuration, see Storage considerations. The following YAML example contains the spec.storage.class syntax that you need to add:

    apiVersion: integration.ibm.com/v1beta1
    kind: PlatformNavigator
    . . .
    spec:
      license:
        . . .
      storage:
        class: <storage_class>
      version: 2022.2.1
    Tip: For Red Hat OpenShift Data Foundation in a production environment, the optimal minimum deployment is 4 storage nodes, with 3 Object Storage Daemons (OSDs) on each node. This configuration provides much greater data resiliency, mitigating OSD failures.
  10. Save your changes. The Platform UI now begins upgrading.

  11. Click the Details tab.

  12. Scroll to the end of the page, to the Conditions section. Here you can monitor the progress of the upgrade. Some Error conditions are transient and change back to Pending after a few minutes. The length of time for upgrade can be from between 15 minutes to 1 hour, depending on what version you are upgrading from.

Important: Do not proceed until the Conditions status changes to Ready.

When the upgrade of Platform UI is complete, you can proceed to Upgrading capabilities.

Using the CLI:

  1. Log into your cluster with your OpenShift user credentials:

    oc login
  2. Get the list of Platform UI instances running on your cluster:

    oc get pn --all-namespaces
  3. Identify the instance you want to upgrade and edit the custom resource:

    oc edit PlatformNavigator <instance-name>

    This opens the custom resource in your default editor.

    Enter the following values:

    • For spec.version - 2022.2.1.

    • For spec.license.license - either L-RJON-CD3JKX or L-RJON-CJR2WN. For more information about specific licenses, see Licensing.

    • If you are upgrading from 2020.4.1, the required entry for the storage class (spec.storage.class) does not exist in the YAML, so you must add the syntax and the value. For the value of spec.storage.class, specify a file storage class that supports ReadWriteMany (RWX) volumes and allows read and write access to non-root users. Supported storage providers include ibmc-file-gold-gid, Red Hat OpenShift Data Foundation (formerly Red Hat OpenShift Container Storage), Spectrum, and Portworx. For more information about storage support and configuration, see Storage considerations.

      spec:
        storage:
          class: <storage-class-value>

    Save your changes. The Platform UI now begins upgrading.

  4. Get the list of Platform UI instances running on your cluster to track the status of the upgrade.

    oc get pn --all-namespaces

When the upgrade of Platform UI is complete, you can proceed to Upgrading capabilities.