Planning your API Connect upgrade on OpenShift

Review the supported upgrade paths and other upgrade considerations on Open Shift. or Cloud Pak for Integration.

Supported upgrade paths for API Connect

Important: API Connect v12.1 does not support upgrading from a 2DCDR environment.

Table 1 lists the supported upgrade paths for API Connect and explains whether you can upgrade directly or an interim upgrade is required.

Table 1. Supported upgrade paths on OpenShift
Upgrade from: How to upgrade to 12.1.1.0
  • 12.1.0.3
  • 10.0.11.0
  • 10.0.8.9
  • 10.0.8.8
 Complete the procedure in Upgrading on Openshift to upgrade to 12.1.1.0 on API Connect.

Supported DataPower Gateway versions

You can use API Connect 12.1.1.0 with DataPower 11.0.0.x, 10.6.0.x.

Before you upgrade, best practice is to review the latest compatibility support for your version of API Connect. To view compatibility support, follow the instructions in IBM API Connect Version 12 software product compatibility requirements to access API Connect information on the Software Product Compatibility Reports website. When you find the information for your version of API Connect, select Supported Software > Integration Middleware, and view the list of compatible DataPower Gateway versions.

Version and platform compatibility

Be sure to review Operator, CASE, and platform requirements for upgrading for the latest information on OpenShift and API Connect requirements.

Important upgrade considerations

Upgrading multiple instances of API Connect
  • If a single operator manages multiple instances, all of those instances must be upgraded, one at a time, as soon as possible.

    The operator should not be managing an operand based on an older version any longer than necessary.

  • Ensure that each instance is fully upgraded before you start the upgrade on the next instance.
OAuth provider resources with api.securityDefintions
If you have native OAuth providers that are configured with the api.securityDefintions field assigned, then upgrade fails. Before upgrade, remove all api.securityDefintions from all native OAuth providers that you configured in the Cloud Manager and API Manager UIs: Switch to the source view and delete any securityDefintions sections that are present.