Upgrading

Upgrade IBM Cloud Pak® for Integration.

  • To perform the upgrade, you must be a Cluster Administrator.

  • Foundational services must be upgraded first, before upgrading the Red Hat® OpenShift® Container Platform.

  • If you plan to use the integration tracing capability (Operations Dashboard), be sure to upgrade it before any instances it will be tracing.

The first step for upgrade is to apply the latest 2021.4 catalog sources and images to the cluster:

  • If you have an online installation and are using the IBM Operator Catalog, you can skip this step, because the IBM Operator Catalog polls every 45 minutes.

  • If you are not using the IBM Operator Catalog (some online installations and all air-gapped installations), follow the procedure in Installing in an air-gapped environment to update the catalog sources and images for the 2020.4 patch release.

Important: Refreshing certificates: When upgrading IBM Cloud Pak foundational services, certificates are recreated. This may require you to refresh the existing certificates manually for each instance. The certificate refresh procedure is documented in the technical note Cloud Pak for Integration - Refreshing Expired Certificates.
Attention: Do not upgrade OpenShift Container Platform unless the currently-installed version of Cloud Pak for Integration supports the new OpenShift version, because this could break your current integrations. To confirm, review the "Operating environment" page in the documentation for the Cloud Pak for Integration version that is currently installed before upgrading OpenShift. If needed, upgrade Cloud Pak for Integration first to a version that supports the desired OpenShift version.

Upgrading from 2020.4

Complete the tasks in this section, in the following order, to upgrade IBM Cloud Pak® for Integration 2020.4 to version 2021.4.

  1. Uninstall all Cloud Pak for Integration operators in the namespace where the operators are installed.

    • Important: Do not delete the operators in the ibm-common-services namespace. Only delete the operators in the namespaces where Cloud Pak for Integration is installed (for example, in openshift-operators or integration).

    • The operator only manages the instances, so the instances won't be changed or deleted during this upgrade process.

  2. Reinstall the operators by following the instructions in Installing the operators using the Openshift console; make sure to select the Update channel corresponding to version 2021.4 of Cloud Pak for Integration. The correct channel versions for the 2021.4 operators can be found in Operator channel versions for IBM Cloud Pak for Integration releases.

  3. Make sure that the version of foundational services is 3.18 or later and on the v3 operator channel. Follow the instructions in Upgrading IBM Cloud Pak foundational services, if needed.

  4. Upgrade the Platform UI (previously the Platform Navigator) instance to the 2021.4 version by completing the steps in the section, "Editing the PlatformNavigator custom resource" in Upgrading the Platform UI.

  5. Upgrade the integration tracing capability (Operations Dashboard), if used. This must be done before upgrading any instances that it is tracing. To do so, follow the instructions in Upgrading Integration tracing.
  6. Upgrade all instances of the API management capability to the 2021.4 version. This must be done before upgrading any instances of the gateway capability (DataPower Gateway). For detailed instructions, see Upgrading API management.

  7. Upgrade the other instances of capabilities to 2021.4 versions. For detailed instructions, see Upgrading capabilities.

After the upgrade has completed fully to the 2021.4 level, you may choose to upgrade Red Hat OpenShift Container Platform to 4.7, 4.8 or 4.10, only.

Cleanup (optional)

After the upgrade is complete, there are a few optional cleanup steps:

  1. You can delete the now-unused catalog source for foundational services by following the procedure in Updating your IBM operator catalog sources.

  2. If you previously installed the metering service, it is still available, but it will not receive future updates. If you confirm this service is no longer needed, uninstall by following the instructions in Uninstalling the metering service.

  3. Monitoring now relies on the OpenShift monitoring stack. If you configured OpenShift monitoring in a previous version of Cloud Pak for Integration, you do not need to upgrade this service to continue using it. However, if you are not already using OpenShift monitoring and would like to do so, follow the instructions in Migrating the logging stack.

Upgrading from 2021.3

Complete the tasks in this section, in the following order, to upgrade IBM Cloud Pak® for Integration 2021.3 to version 2021.4.

  1. Upgrade foundational services to version 3.18 or later. Follow the instructions in Upgrading IBM Cloud Pak foundational services.

  2. If using the Operator for Apache CouchDB, upgrade the operator to version 2.2 or later.

  3. Upgrade the operators to the 2021.4 level by changing the operator channels. The correct channel versions for 2021.4 can be found in Operator channel versions for IBM Cloud Pak for Integration releases.

  4. Upgrade the Platform UI (previously the Platform Navigator) instance to the 2021.4 version by completing the steps in the section, "Editing the PlatformNavigator custom resource" in Upgrading the Platform UI.

  5. Upgrade the integration tracing capability (Operations Dashboard), if used. This must be done before upgrading any instances that it is tracing. To do so, follow the instructions in Upgrading Integration tracing.
  6. Upgrade all instances of the API management capability to the 2021.4 version. This must be done before upgrading any instances of the gateway capability (DataPower Gateway). For detailed instructions, see Upgrading API management.

  7. Upgrade the other instances of capabilities to 2021.4 versions. For detailed instructions, see Upgrading capabilities.

After the upgrade to 2021.4 is complete, you may choose to upgrade Red Hat OpenShift Container Platform to 4.7, 4.8, or 4.10, only.