In Cloud Pak for Integration, the API management capability is provided by API
Connect.
About this task
Cloud Pak for Integration 2022 uses API Connect 10.0.5.x, which requires Red Hat OpenShift 4.10
and IBM Cloud Pak common services 3.19 (or higher). Before you can upgrade to API Connect 10.0.5.x
in Cloud Pak for Integration, you must upgrade to a version of API Connect that supports the newer
versions of OpenShift and common services.
Tip: After upgrade, clear your browser cache, and open a new browser
window. This action avoids stale cache issues in your browser, that can result in unexpected
behavior in the Cloud Manager and
API Manager UIs.
Procedure
- Required: Upgrade the API management capability to the following version of
API Connect:
To ensure a successful upgrade to Cloud Pak for Integration 2022.2 with API Connect 10.0.5.x,
upgrade your current version of API Connect:
- 2020.4: If you will upgrade to Cloud Pak for Integration 2022 from 2020.4, your 2020.4
deployment must be at the latest version (API Connect 10.0.1.7-eus).
For upgrade instructions, see
Upgrading API management in the 2020.4 version of the Cloud
Pak for Integration documentation.
- 2021: If you will upgrade to Cloud Pak for Integration 2022 from 2021.x, your 2021 deployment
must be at the latest version of 2021.4 (API Connect 10.0.4-ifix3).
For upgrade instructions, see
Upgrading API management in the 2021.4 version of the Cloud
Pak for Integration documentation.
Attention: If you previously upgraded to API
Connect 10.0.4-ifix3 in 2021.4, you might not have upgraded to OpenShift 4.10 because it was not
required. Be sure to upgrade your deployment to OpenShift 4.10 before attempting to upgrade to API
Connect 10.0.5.x in Cloud Pak for Integration 2022. For upgrade instructions, see the
Red Hat
OpenShift documentation.
- Upgrading from 10.0.1.x only: If you don't want to have Zen endpoints in Cloud Pak
for Integration 2022.2.1 or 2022.4.1, add the following annotation to your CR before
upgrading:
metadata:
annotations:
apiconnect-operator/cp4i: "false"
Notes:
- Beginning with API Connect 10.0.5.6 (Cloud Pak for Integration 2022.2.1), this annotation is
added automatically to the stand-alone Management CR. You must still add it manually if you are
upgrading to an older version of 10.0.5.x, or if you are upgrading with the top-level API Connect
Cluster CR.
- You can only use this annotation to disable Zen features in Cloud Pak for Integration; you
cannot set it to
true to enable Zen features on a deployment that was installed
without them.
- Complete this step before upgrading the
ibm-apiconnect operator.
- If you installed using a top-level CR, add the annotation to the
metadata.annotations section at the beginning of the CR -- do not add it to the
subsystem sections.
- If you installing using individual subsystem CRs, add the annotation to the
metadata.annotations section of the Management subsystem CR.
Attention: If you upgraded from API Connect 10.0.1.x using individual subsystem CRs,
your upgraded deployment does not fully constitute an "API Connect on Cloud Pack for Integration"
deployment.
Starting with API Connect v10.0.3.x, the additional API Connect features available in
Cloud Pak for Integration require the use of the "API Connect Cluster" CR. When using individual API
Connect subsystem CRs in a Cloud Pak for Integration deployment, the features specific to Cloud Pak
for Integration might not be available to your API Connect deployment.
You can migrate the
upgraded deployment to Cloud Pak for Integration using API Connect form-factor migration as
explained in Migrating from v10 to v10 on a different form factor.
-
Upgrade the API management capability to API Connect 10.0.5.x in Cloud Pak for Integration
2022.