Planning your API Connect upgrade on VMware
Before you upgrade API Connect on VMware, check that your deployment meets all the upgrade requirements.
Supported upgrade paths
Upgrade from: | How to upgrade to 10.0.7.0 |
---|---|
|
Complete the procedure in Upgrading to the latest release on VMware. |
10.0.5.2 or earlier | Complete two upgrades:
|
Supported DataPower Gateway versions
You can use any combination of API Connect CD releases (10.0.7.x) with DataPower CD releases (DataPower Gateway 10.5.3.x or DataPower API Gateway 10.5.3.x).
However, before you install, it is recommended to review the compatibility support for your version of API Connect. To view compatibility support, follow the instructions in IBM API Connect Version 10 software product compatibility requirements to access API Connect information on the Software Product Compatibility Reports website. Once you access information for your version of API Connect, select , and view the list of compatible DataPower Gateway versions.
Control planes for upgrading to 10.0.7
Installs with appliance-control-plane-1.27.x.tgz
Upgrading from API Connect version | Control Plane files needed |
---|---|
|
No Control Plane needed. |
Upgrade requirements
- API Connect is not supported on a FIPS-enabled environment.
- The instructions for upgrading apply to the latest version of API Connect.
- The upgrade order for subsystems is important. Upgrade the subsystems in the following order:
- Management
- Portal
- Analytics
- Gateway
Gateway must be upgraded after management so that any new policies and capabilities are available to any previously registered gateway services.
- Do not use
kubectl exec
commands to access API Connect pods unless advised by IBM.Do not make any changes on the deployed VMs unless documented here or otherwise advised by IBM. Attempting to manually update packages, adding new users, or installing new software will likely cause problems. Operating system updates are handled by API Connect fix packs.
Important upgrade considerations
Carefully review the following items, to plan and prepare for your upgrade.
- 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 allapi.securityDefintions
from all native OAuth providers that you configured in the Cloud Manager and API Manager UIs:- Configuring a native OAuth provider in the Cloud Manager UI
- Configuring a native OAuth provider in the API Manager UI
securityDefintions
sections that are present. - SFTP management backups (V10.0.6.0 to V10.0.7.0 upgrade)
-
API Connect V10.0.7.0 supports only backups to an S3 object-store for the management database. If your V10.0.6.0 deployment uses SFTP or local backups, then you must reconfigure your management backup settings to use an S3 object-store.
Upgrade to V10.0.7.0 is blocked if management database backups are not configured to use an S3 object-store.
If you do not require management database backups, you can enable an opt-out parameter to override the upgrade block. Support for SFTP and local backups will be provided in a future V10.0.x release.
- Extra backup folder appended to management database backup path
-
When you upgrade to V10.0.7.0 or later with S3 backups configured, an extra backup path folder /edb is appended to your backup path. The /edb path is to distinguish new EDB backups from your previous management backups.