Upgrading all API Management subsystems on Linux x86_64

Upgrade the API management instance in IBM Cloud Pak® for Integration.

When you upgrade API Management instances to version 16.1, complete the steps in the following sequence:

1. Review the following topics in the API Connect documentation to ensure your environment meets the requirements for upgrading API Connect:
   • Planning your API Connect upgrade on OpenShift
   • Operator, CASE, and platform requirements for upgrading
   • Pre-upgrade preparation and checks on OpenShift
   • Two data center deployment:
     • Upgrading a 2DCDR deployment on Cloud Pak for Integration from V10.0.7
     • Upgrading a 2DCDR deployment on Cloud Pak for Integration from V10.0.5
2. Back up your API management deployment.

   For instructions, see Backing up your Cloud Pak for Integration API Connect deployment in the API Connect documentation.

3. On the Platform UI home page, verify that the status for your instance is Ready.
4. Optionally configure API Connect to retain the existing Cloud Pak endpoints.

   Beginning with version 10.0.7.0, API Connect no longer uses the Cloud Pak cpd routes for endpoints when deployed as a component of Cloud Pak for Integration. Instead, the API Management component uses the typical default API Connect routes (or the custom endpoints configured in the CR).

   Attention: If you choose to accept the new endpoints (without the Cloud Pak cpd routes), skip this step. However, if you previously configured your own OIDC user registry, be sure to update the redirect_uri to reflect the new API Connect endpoint.

   If you want to retain the existing Cloud Pak endpoints during the upgrade, complete the following steps:

   1. Log in to the Platform UI.
   2. Click next to the API Connect instance that you are upgrading, and select Edit.
   3. Click the YAML tab to manually edit the CR.
   4. Insert the deprecatedCloudPakRoute object into the spec.management section as shown in the following example:

      apiVersion: apiconnect.ibm.com/v1beta1
      kind: APIConnectCluster
      metadata:
        name: <name_of_your_instance> 
        namespace: <APIC-namespace> 
      spec:
        license:
          accept: true
          license: L-DZZQ-MGVN8V
          metric: PROCESSOR_VALUE_UNIT
          use: nonproduction
        profile: n1xc17.m48
        version: 10.0.8.0
        storageClassName: <default-storage-class>
        management:
          deprecatedCloudPakRoute:
            enabled: true
            cloudPakEndpoint:
              hosts:
              - name: cpd-apic.apps.admin-<domain>.com

   5. Optional: If you want to add a custom certificate for the Cloud Pak route, complete the following steps:
      1. Create a Cloud Pak certificate that was signed by a Cloud Pak CA as in the following example:

         ---
         apiVersion: cert-manager.io/v1
         kind: Issuer
         metadata:
          name: custom-cpd-ca
          namespace: apic
         spec:
          selfSigned: {}
         ---
         apiVersion: cert-manager.io/v1
         kind: Certificate
         metadata:
           name: custom-cpd
           namespace: apic
         spec:
           commonName: small-mgmt-cpd
           dnsNames:
           - cpd-apic.apps.admin-apickeycloak.cp.fyre.ibm.com
           duration: 17520h0m0s
           issuerRef:
             kind: Issuer
             name: custom-cpd-ca
           privateKey:
             algorithm: RSA
             rotationPolicy: Always
             size: 2048
           renewBefore: 720h0m0s
           secretName: custom-cpd
           usages:
           - key encipherment
           - digital signature
           - server auth

      2. In the CR, provide the secret name within the cloudPakEndpoint property of the new deprecatedCloudPakRoute object; for example:

         
         spec:
           deprecatedCloudPakRoute:
             enabled: true
             cloudPakEndpoint:
               hosts:
               - name: cpd-apic.apps.admin-<domain>.com
                 secretName: custom-cpd

5. Complete the upgrade for API Connect and DataPower instances 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.8.0 (do not confirm the change until you accept a new license in step 5.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.