Upgrading Gateway

This following procedures are for upgrading the Gateway capability. If you need information about installation, see Gateway deployment.

Upgrading the Gateway involves:

  1. Updating the DataPower operator using the Operator Lifecycle Manager (OLM).

  2. Updating the DataPower operand by editing the DataPowerService custom resource (CR).

These two operations can be configured to happen automatically, or they can be initiated manually.

Upgrading the operator

The OLM will attempt to upgrade an operator when a new version is available to the cluster.

  • Automatic approval - If the DataPower operator subscription is set to Automatic approval, no action is required.

  • Manual approval - If the subscription is set to Manual approval, a Cluster Administrator must approve the Install Plan created by OLM to upgrade the operator.

    • You approve the InstallPlan on Operators > Installed Operators in the OpenShift console.

    • The upgrade status under the Subscription tab displays as "Upgrading" until the user reviews and approves its Install Plan.

    • After confirming approval on the Install Plan page, the subscription upgrade status changes to "Up to date".

Upgrading the operand

An upgraded DataPower Operator may support new versions of the DataPower operand.

  • Automatic upgrade - If your DataPowerService CR spec.version is set to a channel, and the operator supports a newer version in that channel, your DataPower deployment is automatically upgraded.

  • Manual upgrade - If your DataPowerService CR spec.version is set to a specific version, upgrade your DataPower deployment by updating the spec.version in the DataPowerService CR.

Users can also identify what versions are available to a given instance of DataPower by looking at the status.versions.available section of the DataPowerService CR.

Upgrading to Extended Update Support (EUS)

  1. The EUS DataPower Operator requires Red Hat OpenShift 4.6. Therefore, you must upgrade Red Hat OpenShift to version 4.6. See Updating a cluster between minor versions in the Red Hat OpenShift documentation.

  2. After you have upgraded Red Hat OpenShift, navigate to the Installed Operators section in OpenShift and select the IBM DataPower operator.

  3. Click the Subscription tab and change the channel to v1.2-eus. Result: OLM upgrades the operator to the latest EUS version. If manual approval is needed, a Cluster Administrator must approve the InstallPlan created by OLM to upgrade the operator.

  4. Upgrading the operand:

    • Automatic upgrade - If your DataPowerService CR spec.version is set to a non-EUS channel, update the spec.version to 10.0-eus. This will enable automatic upgrades for the 10.0.1.x EUS channel.

    • Manual upgrade - If your DataPowerService CR spec.version is set to a non-EUS version, update the spec.version to an available EUS version, such as 10.0.1.1-eus.