Upgrade considerations on native Kubernetes
Review the supported versions, requirements, and limitations for upgrading API Connect on Kubernetes.
Supported upgrade paths
Table 1 lists the releases of IBM® API Connect v10 that can be upgraded to the newest version.
Upgrade from: | How to upgrade to 10.0.5.8 |
---|---|
|
Complete the procedure in Upgrading subsystems on native Kubernetes in this 10.0.5 documentation.. |
Older versions of 10.0.x:
|
Complete 2 upgrades:
|
Older versions of 10.0.1.x:
|
Complete 2 upgrades:
|
|
Complete 3 upgrades:
|
2018 FP24 | Complete 2 upgrades:
|
For upgrades to older fix packs, see Upgrading to older fix packs on Kubernetes.
Supported DataPower Gateway versions
You can use any combination of API Connect 10.0.5.x with DataPower Gateway 10.5.0.x or DataPower API Gateway 10.5.0.x.
However, before you install, 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 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.
OAuth provider resources with api.securityDefintions
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:- 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.Ensuring compatibility with Drupal 10 for Developer Portal customizations
Review the Guidelines on upgrading your Developer Portal from Drupal 9 to Drupal 10 to ensure that any customizations to the Developer Portal are compatible with Drupal 10.
In API Connect 10.0.5.3, the Developer Portal moved from Drupal 9 to Drupal 10 (this upgrade also requires PHP 8.1). The upgrade tooling will update your Developer Portal sites; however, if you have any custom modules or themes, it is your responsibility to ensure their compatibility with Drupal 10 and PHP 8.1 before starting the upgrade.
Exporting analytics data before upgrading from a version prior to 10.0.5.0
If upgrading from v10.0.4-ifix3, or upgrading from v10.0.1.7-eus (or higher): Upgrading to 10.0.5.x from an earlier version will result in the deletion of existing analytics data. If you want to retain your analytics data then you must export it before starting the upgrade. For instructions on exporting data, see Additional considerations for upgrading analytics from a version prior to 10.0.5.0
Validating an API definition file with the API Dev Tools Swagger Parser
From IBM API Connect Version 10.0.3.0 or later, SwaggerDoc (OpenAPI 2.0) and OpenAPI 3.0 documents that form API definition files are now validated at stage or publish time by the API Dev Tools Swagger Parser. Before upgrading, you should ensure that your existing API definition files can be parsed and are considered valid by the Swagger Parser tool. Note that any API definitions that are already staged or published are not impacted, but would undergo Swagger Parser validation again should they be re-staged or re-published in the future.
- Download and install the
swagger-parser-cli
tool (see https://www.npmjs.com/package/swagger-cli). This tool includes avalidate
command that can validate local API definition files against the SwaggerDoc (OpenAPI 2.0) and OpenAPI 3.0 schemas, in both JSON and YAML formats. - Use the browser-based Swagger Parser Validator available at https://apitools.dev/swagger-parser/online/; this accepts a URL to existing files available online, or can accept text copied and pasted into the tool, in both JSON and YAML formats. It can likewise validate against the SwaggerDoc (OpenAPI 2.0) and OpenAPI 3.0 schemas.
apic validate
toolkit CLI command.info
or paths
, the following error is
reported:[object Object] is not a valid Swagger API definition
info
section is missing the required version
property, the
following error is reported:Swagger schema validation failed.
Missing required property: version at #/info
JSON_OBJECT_VALIDATION_FAILED
$ref
properties) that do not resolve to an existing
reference within the document (known as de-referencing), this is also be flagged as an error. For
example, if a document contains the following as a reference:schema:
$ref: '#/definitions/Pet'
Pet
(that is,
#/definitions/Pet
) must exist in the same document, at the given path
(definitions
section in this example), similar to the
following:definitions:
Pet:
type: object
required:
- name
properties:
id:
type: integer
format: int64
If the local reference is not found within the document, the
following de-referencing error is
reported:Token "Pet" does not exist.
Upgrading to v10.0.5.3 (or later) from an earlier 10.05.x release.
Additional features related to inter-subsystem communication were added in v10.0.5.3. To enable and configure these features see: Optional post-upgrade steps for upgrade to 10.0.5.3 (or later) from earlier 10.0.5 release.