IBM API Connect Version 10 software product compatibility requirements

Ensure that you install the minimum API Connect operating system requirements. Use the IBM® Software Product Compatibility Reports site to generate a requirements report appropriate for your API Connect version and environment.

Generating a Software Product Compatibility Report

To generate an API Connect requirements report, complete the following steps:
  1. Open the Detailed system requirements for a specific product page on the IBM Software Product Compatibility Reports site.
  2. Search for the IBM API Connect product.
  3. In the Search results list, select IBM API Connect.
  4. From the Version list, select the required version.
  5. Use the Filters to refine the contents of the requirements report.
  6. Click Submit to generate your requirements report.

Supported versions of Kubernetes and OpenShift

The following tables provide a quick reference of the supported Kubernetes and OpenShift versions for each API Connect release:

Table 1. API Connect and Kubernetes (K8S) compatibility matrix
API Connect version K8S 1.20 K8S 1.21 K8S 1.22 K8S 1.23 K8S 1.24 K8S 1.25
10.0.1.7   ✅ ✅ ✅    
10.0.1.8     ✅ ✅    
10.0.1.9       ✅ ✅ ✅
10.0.1.11       ✅ ✅ ✅
10.0.4.0-ifix2 or later ✅ ✅ ✅      
10.0.5.0     ✅ ✅    
10.0.5.1     ✅ ✅    
10.0.5.2       ✅ ✅ ✅
10.0.5.3         ✅ ✅
Table 2. API Connect and OpenShift Container Platform (OCP) compatibility matrix
API Connect version OCP 4.6 OCP 4.7 OCP 4.8 OCP 4.9 OCP 4.10 OCP 4.12
10.0.1.7 ✅ ✅     ✅  
10.0.1.8 ✅ ✅     ✅  
10.0.1.9         ✅  
10.0.1.11         ✅  
10.0.4.0-ifix2 or later ✅ ✅ ✅ ✅ ✅  
10.0.5.0         ✅  
10.0.5.1         ✅  
10.0.5.2         ✅ ✅
10.0.5.3         ✅ ✅

Upgrading to an API Connect release that uses a newer version of Kubernetes

When you upgrade API Connect, both your current deployment and your target release must support the same version of Kubernetes. After the API Connect upgrade, you can optionally update Kubernetes to the highest version supported by the new release of API Connect.

It is possible you will need to upgrade both Kubernetes and API Connect more than once to complete the process. For example, suppose that your current deployment is running API Connect 10.0.1.7 on Kubernetes v1.21 and you want to upgrade to API Connect 10.0.5.3. The highest version of Kubernetes supported with API Connect 10.0.1.7 is v1.23, but the lowest version of Kubernetes supported by API Connect 10.0.5.3 is v1.24, so a direct upgrade of API Connect is not possible.

In this scenario, you must make multiple upgrades of both Kubernetes and API Connect. For example, one option is to use API Connect 10.0.1.11 on Kubernetes v1.23 as your interim release by completing the following upgrades:
  1. On your API Connect 10.0.1.7 deployment, upgrade Kubernetes from v1.21 to v1.22, and then to v1.23.
  2. Upgrade API Connect to 10.0.1.11 on Kubernetes v1.23.
  3. On the API Connect 10.0.1.11 deployment, upgrade Kubernetes to v1.24.
  4. Upgrade API Connect to 10.0.5.3 on Kubernetes v1.24.
An alternative path in the same scenario uses API Connect 10.0.5.1 on Kubernetes v1.22 as the interim release with the following upgrades:
  1. On your API Connect 10.0.1.7 deployment, upgrade Kubernetes from v1.21 to v1.22.
  2. Upgrade API Connect to 10.0.5.1 on Kubernetes v1.22.
  3. On the API Connect 10.0.5.1 deployment, upgrade Kubernetes to v1.23, and then to v1.24.
  4. Upgrade API Connect to 10.0.5.3 on Kubernetes v1.24.

Upgrading to an API Connect release that uses a newer version of OpenShift

When you upgrade API Connect, both your current deployment and your target release must support the same version of OpenShift. After the API Connect upgrade, you can optionally update OpenShift to the highest version supported by the new release of API Connect.

During the upgrade process, it is possible that API Connect will be temporarily running on an unsupported version of OpenShift because you must upgrade API Connect before upgrading OpenShift. For example, suppose that your current deployment is running API Connect 10.0.1.7 on OpenShift 4.6 and you want to upgrade to API Connect 10.0.5.3. The highest version of OpenShift supported with API Connect 10.0.1.7 is 4.6, but the lowest version of OpenShift supported by API Connect 10.0.5.3 is 4.10.

In this scenario, you must upgrade API Connect to the target release (10.0.5.3) even though it will temporarily run on OpenShift 4.6. Immediately after that upgrade is complete, you must upgrade OpenShift to at least version 4.10:
  1. On your API Connect 10.0.1.7 deployment, leave OpenShift at version 4.6 and upgrade API Connect to 10.0.5.3.
  2. On the API Connect 10.0.5.3 deployment, upgrade OpenShift to version 4.10 by completing all interim updates: 4.7, 4.8, 4.9, and then 4.10.

    You can optionally upgrade OpenShift to version 4.11 and then 4.12, which is the highest version supported by API Connect 10.0.5.3.