Upgrading all API Management subsystems on Linux x86_64

Upgrade the API Management capability in IBM Cloud Pak® for Integration by upgrading all of the API Connect subsystems on Linux x86_64.

When you upgrade the IBM Cloud Pak for Integration API Management capability to release 2023.2.1, complete the steps in the following sequence:

1. Run the API Connect pre-upgrade health check:
   1. Verify that the apicops utility is installed by running the following command to check the current version of the utility:

      apicops --version

      If the response indicates that apicops is not available, install it now. See The API Connect operations tool: apicops in the API Connect documentation.

   2. Run the following command to set the KUBECONFIG environment.

      export KUBECONFIG=/<path>/kubeconfig

   3. Run the following command to execute the pre-upgrade script:

      apicops version:pre-upgrade -n <APIC_namespace>

      If the system is healthy, the results will not include any errors.

2. Back up your API management deployment.

   For instructions, see Backups on OpenShift in the API Connect documentation.

3. If you previously used the Operations Dashboard with the API management capability, remove the Operations Dashboard paths in the API Connect Cluster CR's spec.gateway.openTracing section of the APIConnectCluster CR.
4. Upgrade the Platform UI as explained in Upgrading the Platform UI.
5. Upgrade the DataPower and API Connect operators.
   1. Use the OpenShift web console to upgrade the DataPower operator channel to v1.7.

      Both the API Connect and DataPower channels must be changed before either operator upgrades. The upgrade of both operators begins when the channel is changed for both operators.

   2. Use the OpenShift web console to upgrade the API Connect operator by changing the subscription channel to the v5.0 version.
6. In the Platform UI dashboard, click Integration instances and verify that the status displays "Ready" for your instance.
   Attention: The operators must be fully upgraded before you proceed to the next step.
7. Enable the upgrade to API Connect 10.0.6.0.
   1. In the Platform UI dashboard, click Integration instances.
   2. Click next to the API Connect instance that you are upgrading, and select Edit.
   3. Click the Advanced Settings toggle to enable it.
   4. Click Allow Upgrade in the Advanced settings navigation list.
   5. Click the Advanced: Allow upgrade (optional) toggle to enable it.
   6. Click Update.
8. Complete the upgrade for API Connect and DataPower operands by updating the channel and selecting a new license..
   1. In the Platform UI dashboard, click Integration instances.
   2. Click next to the API Connect instance that you are upgrading, and select Change version.
   3. In the Select a new channel or version field, look under Channel and select 10.0.6.0 (do not confirm the change until you accept a new license in step 8.e).

      Upgrading the channel (instead of the version) ensures that both DataPower Gateway and API Connect are upgraded.

   4. In the list of licenses, select the license that matches your entitlement.

      To review the available License IDs for API Connect, see API Connect licenses in the API Connect documentation.

   5. Click the License accept toggle to enable it and apply the new license.
   6. Click Change version to save your selections and start the upgrade.

      When the confirmation message displays, click to refresh the Integration instances page. The Status for the instance displays as "Pending" message during the upgrade. The upgrade is complete when the Status is "Ready" and the Version displays the new version number.