Upgrading Operator releases

Use these instructions to upgrade to the latest version of the IBM® App Connect Operator. After the Operator is upgraded, it controls the upgrade of existing instances of the App Connect Dashboard, App Connect Designer Authoring, Switch Server, and Integration Server custom resources.


Operator channels and versions

New versions of the IBM App Connect Operator are delivered through the following subscription channels. (For a summary of the features in each custom resource version, see IBM App Connect operand versions and features.)

Operator channel Operator versions delivered on channel Supported fully qualified versions of custom resources (instances)
v5.1 5.1.0

12.0.5.0-r2

12.0.4.0-r2

12.0.4.0-r1

12.0.3.0-r2

12.0.3.0-r1

12.0.5.0-r1-lts

11.0.0.18-r1-eus

For deprecations, see spec.version values.

v5.0-lts 5.0.0

12.0.5.0-r1-lts

12.0.4.0-r2

12.0.4.0-r1

12.0.3.0-r2

12.0.3.0-r1

11.0.0.18-r1-eus

For deprecations, see spec.version values.

v4.2 4.2.0

12.0.4.0-r2

12.0.4.0-r1

12.0.3.0-r2

12.0.3.0-r1

12.0.2.0-r2

12.0.2.0-r1

12.0.1.0-r4

11.0.0.17-r2-eus

For deprecations, see spec.version values.

v4.1 4.1.0

12.0.4.0-r1

12.0.3.0-r2

12.0.3.0-r1

12.0.2.0-r2

12.0.2.0-r1

12.0.1.0-r4

11.0.0.17-r1-eus

For deprecations, see spec.version values.

v4.0 4.0.0

12.0.3.0-r2

12.0.3.0-r1

12.0.2.0-r2

12.0.2.0-r1

12.0.1.0-r4

11.0.0.16-r1-eus

For deprecations, see spec.version values.

v3.1 3.1.0

12.0.3.0-r1

12.0.2.0-r2

12.0.2.0-r1

12.0.1.0-r4

12.0.1.0-r3

12.0.1.0-r2

12.0.1.0-r1

11.0.0.12-r1

11.0.0.15-r2-eus

11.0.0.15-r1-eus

11.0.0.14-r1-eus

11.0.0.13-r2-eus

11.0.0.13-r1-eus

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v3.0 3.0.0

12.0.2.0-r2

12.0.2.0-r1

12.0.1.0-r4

12.0.1.0-r3

12.0.1.0-r2

12.0.1.0-r1

11.0.0.12-r1

11.0.0.14-r1-eus

11.0.0.13-r2-eus

11.0.0.13-r1-eus

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v2.1 2.1.0

12.0.2.0-r1

12.0.1.0-r4

12.0.1.0-r3

12.0.1.0-r2

12.0.1.0-r1

11.0.0.12-r1

11.0.0.11-r2

11.0.0.14-r1-eus

11.0.0.13-r2-eus

11.0.0.13-r1-eus

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v2.0 2.0.0

12.0.1.0-r4

12.0.1.0-r3

12.0.1.0-r2

12.0.1.0-r1

11.0.0.12-r1

11.0.0.11-r2

11.0.0.13-r2-eus

11.0.0.13-r1-eus

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v1.5 1.5.2

12.0.1.0-r3

12.0.1.0-r2

12.0.1.0-r1

11.0.0.12-r1

11.0.0.11-r2

11.0.0.11-r1

11.0.0.10-r2 or earlier Continuous Delivery releases

11.0.0.13-r1-eus

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v1.5 1.5.1

12.0.1.0-r2

12.0.1.0-r1

11.0.0.12-r1

11.0.0.11-r2

11.0.0.11-r1

11.0.0.10-r2 or earlier Continuous Delivery releases

11.0.0.13-r1-eus

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v1.5 1.5.0

12.0.1.0-r1

11.0.0.12-r1

11.0.0.11-r2

11.0.0.11-r1

11.0.0.10-r2 or earlier Continuous Delivery releases

11.0.0.12-r1-eus

11.0.0.10-r3-eus

For deprecations, see spec.version values.

v1.4 1.4.x

11.0.0.12-r1

11.0.0.11-r2

11.0.0.11-r1

11.0.0.10-r2 or earlier Continuous Delivery releases

11.0.0.12-r1-eus

11.0.0.10-r3-eus

v1.3 1.3.x

11.0.0.11-r2

11.0.0.11-r1

11.0.0.10-r2 or earlier Continuous Delivery releases

11.0.0.10-r3-eus

v1.2 1.2.0

11.0.0.11-r1

11.0.0.10-r2 or earlier Continuous Delivery releases

11.0.0.10-r3-eus

v1.1-eus 1.1.x

11.0.0.12-r1-eus

11.0.0.10-r3-eus

11.0.0.10-r2 or earlier Continuous Delivery releases

v1.0 1.0.x

11.0.0.10-r2 or earlier Continuous Delivery releases

Note:

These instructions apply only to an IBM App Connect Operator 5.1.x upgrade. For information about upgrading to any Continuous Delivery version of the Operator between 1.0.x and 4.2.0, see Documentation for previous releases.

Upgrade considerations for channels, versions, and licenses

To obtain curated versions of the IBM App Connect Operator, clusters that are connected to the internet access the IBM Operator Catalog, and clusters in a restricted network use a configured product-specific catalog within the network. The Operator Lifecycle Manager (OLM), which runs by default in the cluster, queries the catalog for new versions of the IBM App Connect Operator.

Guidance for restricted networks:

In a restricted network, new versions of the IBM App Connect Operator are offered only after updating the internal catalog and mirroring a new version of the images to the internal registry.


The IBM App Connect Operator is installed and managed by OLM. OLM tracks the specified channel in the catalog for new versions of the Operator, and based on the approval strategy specified during installation identifies whether an automatic or manual upgrade should occur for a running Operator.

  • Upgrading from IBM App Connect Operator 4.2.0 or earlier to 5.1.x: Because the IBM App Connect Operator 5.1.x is delivered on a different channel from earlier versions, you must initialize an upgrade to this latest version by manually updating the existing v4.2 or earlier "Continuous Delivery" channel in your Operator subscription to the v5.1 channel. OLM will then track the v5.1 channel in the catalog for new versions of the Operator, and upgrade the Operator according to the approval strategy that was specified during installation.
  • Upgrading from an earlier IBM App Connect Operator 5.1.x (for example, 5.1.0) to a subsequent 5.1.x: If Automatic approval is set on the Operator's subscription, OLM automatically upgrades the Operator to the latest version, but requires manual intervention if Manual approval is set on the subscription.

After the Operator is upgraded, it determines how to upgrade existing instances of your custom resources:

  • If you upgraded from IBM App Connect Operator 4.2.0 or earlier to 5.1.x, manual intervention will be required to complete each upgrade due to the change in the Operator channel:
    • To upgrade your instances to the latest version that the Operator provides (on the v5.1 Operator channel), you must ensure that the spec.version value is set to subscribe to the 12.0 or 12.0.5 custom resource channel, or is set to the fully qualified 12.0.5.0-rX version.
    • Because the release includes new features in addition to fixes, new licenses are required to run the instances, so you must also update the spec.license.licence value.
  • For subsequent releases of 5.1.x Operator versions in the v5.1 channel, existing instances of your custom resources will be upgraded as follows:
    • If the same licenses apply and spec.version is set to a channel, OLM will automatically upgrade an instance to the latest version.
    • If the same licenses apply and spec.version is set to a fully qualified version number, you will need to update the spec.version value for an instance to upgrade to the latest version. You can specify the latest fully qualified version number or a channel.
    • If a new set of licenses are required, and spec.version is set to a channel, you will need to update the spec.license.licence value for an instance in order to complete the upgrade. (Operator versions sometimes include new features in addition to fixes, so new licenses might be required to run the instances.)
    • If a new set of licenses are required, and spec.version is set to a fully qualified version number, you will need to complete the upgrade as follows:
      • Update the spec.license.licence value.
      • Update the spec.version value to the latest fully qualified version number or to a channel.

For more information, see spec.version values and Licensing reference for IBM App Connect Operator.