Upgrading operator-managed Event Gateways on Red Hat OpenShift

Edit online

On Red Hat OpenShift, upgrade to the latest version by updating the operator channel.

Pre-upgrade checks and preparation

The pre-upgrade checks and preparation ensure that your Event Endpoint Management operator and gateway installation is ready to upgrade. These steps do not commit you to completing the upgrade, so you can do them before your upgrade window.

  1. Determine which Operator Lifecycle Manager (OLM) channel is used by your existing subscription.

    You can check the channel that you are subscribed to in the OpenShift web console, or by using the CLI as follows:

    1. Run the following command to check your subscription details:
      oc -n <namespace> get subscription

      where <namespace> is the Event Endpoint Management operator namespace.

    2. Check the CHANNEL column for the channel you are subscribed to, for example:
      NAME                          PACKAGE                        SOURCE                                CHANNEL
ibm-eventendpointmanagement   ibm-eventendpointmanagement    ibm-eventendpointmanagement-catalog   v11.7
      This is the subscription that you created during installation.
  2. If you are managing your catalog sources with a CASE bundle, then download the CASE bundle for your target version.
    1. Download and extract the latest Event Endpoint Management CASE version:
      oc ibm-pak get ibm-eventendpointmanagement
    2. Generate mirror manifests:
      oc ibm-pak generate mirror-manifests ibm-eventendpointmanagement icr.io

If you installed by using the IBM Operator Catalog, then the latest Event Endpoint Management release for your update channel is always available.

Upgrading by using the Red Hat OpenShift CLI

If you are using the Red Hat OpenShift OpenShift command-line interface (CLI), complete the steps in the following sections to upgrade your Event Endpoint Management operator. Set <namespace> to the namespace of your Event Endpoint Management operator.

  1. Log in to your Red Hat OpenShift Container Platform as a cluster administrator: oc login.
  2. If you are managing your catalog sources with a CASE bundle, then apply the CASE bundle:
    oc apply -f ~/.ibm-pak/data/mirror/ibm-eventendpointmanagement/<case version>/catalog-sources.yaml

    If your existing subscription is already on the v11.7 channel, then the upgrade to 11.7.x is applied automatically.

  3. Verify that the target version Event Endpoint Management Operator upgrade channel is available:
    oc -n <namespace> get packagemanifest ibm-eventendpointmanagement -o=jsonpath='{.status.channels[*].name}'
  4. Change the subscription to move to the required update channel, where vX.Y is the required update channel (for example, v11.8):
    oc -n <namespace> patch subscription ibm-eventendpointmanagement --patch '{"spec":{"channel":"vX.Y"}}' --type=merge
  5. If you are upgrading from 11.6.x, then update the spec.license.license field in the custom resources of your Event Gateway instances to the license for 11.7.0.
    1. Get the names of your Event Gateway instances:
      oc -n <namespace> get eventgateways.events.ibm.com
    2. For each instance, update the license:
      oc -n <namespace> patch eventgateway.events.ibm.com <gateway instance name> --patch '{"spec":{"license":{"license":"<license ID>"}}}' --type=merge
  6. Check the status of the Subscription custom resource to confirm that your Event Endpoint Management operator was updated to your target version.
    oc -n <namespace> get -o yaml subscription
    where <namespace> is the Event Endpoint Management operator namespace. The status.installedCSV field in the output shows the current operator version.

All Event Gateway pods that are updated as part of the upgrade are restarted.

Upgrading Subscription by using the Red Hat OpenShift OpenShift web console

If you are using the web console, complete the steps in the following sections to upgrade your Event Endpoint Management operator and Event Gateway instances.

  1. Log in to the OpenShift Container Platform web console using your login credentials.
  2. Expand Operators in the navigation on the left, and click Installed Operators.
  3. From the Project list, select the project (namespace) the instance is installed in.
  4. Locate the operator that manages your Event Gateway instance in the project. It is called Event Endpoint Management in the Name column. Click the Event Endpoint Management link in the row.
  5. Click the Subscription tab to display the Subscription details for the Event Endpoint Management operator.
  6. Select the version number link in the Update channel section (for example, v11.8). The Change Subscription update channel dialog is displayed, showing the channels that are available to upgrade to.
  7. Select the required channel, for example v11.8, and click Save on the Change Subscription update channel dialog.
  8. If you are upgrading from 11.5.x, then update the spec.license.license field in the custom resources of your Event Gateway instances to the license ID for 11.6.0 and later. The instances will not upgrade until the license ID is updated.
  9. Monitor your Event Endpoint Management operator and Event Gateway instances in the web console to confirm that the upgrade completes.
All Event Gateway pods that are updated as part of the upgrade are restarted.