Upgrading Event Endpoint Management

Use the following instructions to upgrade Event Endpoint Management. The procedure involves upgrading the API Connect operator in the OpenShift Container Platform web console, and then upgrading your existing instance of Event Endpoint Management in the IBM Cloud Pak Platform UI.

About this task

The following table summarizes the versions of Event Endpoint Management in the previous and current release of Cloud Pak for Integration.

Cloud Pak for Integration Event Endpoint Management (instance) Operator (API Connect operator ibm-apiconnect) Operator channel
2022.4.1 3.2.0 v3.2
2022.2.1 3.1.0 v3.1 3.0.0 v3.0
2021.4.1 2.5.1 v2.5 2.5.0 v2.5 2.4.1 v2.4 2.4.0 v2.4
2021.3.1 2.3.1 v2.3
2021.2.1 2.3.0 v2.3
2021.1.1 2.2.0 v2.2


Complete the following steps to upgrade your Event Endpoint Management version.

  1. If applicable, allow Ingress traffic from the default namespace.

  2. Use the OpenShift Container Platform web console to upgrade the API Connect operator by changing the subscription channel to the v3.2 version. Ensure you have the DataPower operator subscription channel set to v1.6 before changing the subscription channel for the API Connect operator.

    1. Log in to the OpenShift Container Platform web console using your login credentials.

    2. Expand the Operators in the navigation on the left, and click Installed Operators.

    3. From the Project list, select the namespace (project) the instance is installed in. Click the operator called IBM API Connect that manages the project.

    4. Click the Subscription tab. This shows the Subscription details for the operator.

    5. Click the version number link in the Update channel section (for example, v2.5). The Change Subscription update channel dialog is displayed, showing the channels that are available to upgrade to.

    6. Select v3.0 and click the Save button on the Change Subscription update channel dialog.

  3. In IBM API Connect operator, select the Event Endpoint Manager tab and search the Name column for the installed instance and click the name.

  4. After the Event Endpoint Manager instance is in a Ready state, use the IBM Cloud Pak Platform UI to enable upgrades. Because the upgrade deletes your analytics data, you must enable the Allow upgrade setting to prevent an accidental upgrade. This is required even if your Event Endpoint Manager instance does not use analytics.

    1. In the Platform UI dashboard, click Integration instances.

    2. Click the Menu icon Menu icon next to the Event Endpoint Management instance name (has Event Endpoint Management in the Type column), and then select Edit.

    3. Click the Advanced settings toggle to open more configuration options.

    4. Click Allow upgrade in the Advanced settings navigation list.

    5. Click the Advanced: Allow upgrade (optional) toggle to enable it.

    6. Click Update.

  5. Complete the upgrade for Event Endpoint Manager instance by changing the subscription channel to version

    1. Click the Navigation Menu in the top left.

    2. Expand Administration and click Integration instances.

      If an update is available for a runtime, the Information icon Information icon displays next to the runtime's current Version number.

    3. Click the Menu icon Menu icon next to the Event Endpoint Management instance name (has Event Endpoint Management in the Type column), and then click Change version.

    4. From the Select a new channel or version list, select

    5. Click Change version to save your selections and start the upgrade. In the runtimes table, the Status column for the runtime displays the Upgrading message. The upgrade is complete when the Status is Ready and the Version displays the new version number.

Post-upgrade tasks

Consider the following steps after upgrading.

Registering and configuring an Event Gateway Service

The Event Gateway Service enforces runtime policies to secure and control access to your event sources. The gateway service is deployed as part of an Event Endpoint Management instance, and you can register and configure the service after upgrading.

Updating existing AsyncAPI documents for use with the Event Gateway Service

AsyncAPI documents created in the Event Endpoint Management can be updated to be enforced in Event Endpoint Management and later. This requires manual modification of your AsyncAPI as follows:

  1. Update your AsyncAPI document in the AsyncAPI editor to satisfy the additional conditions required for enforcement.

  2. In the AsyncAPI editor, go to the Source view, delete the x-ibm-configuration section of the document, and click Save.

  3. After saving, reload the page. This recreates the x-ibm-configuration section, and sets this API to be enforced.

  4. Switch back to Form view, and click the Gateway tab.

  5. Update the Bootstrap servers field to reflect the bootstrap servers address of your Kafka cluster.

  6. Switch to the Source view, and add a clusterconfigid key and value under the invoke-kafka object. This value must be a unique identifier for this API.

  7. Click Save to update the document.

Updating configuration for standalone gateway

If you have a standalone Event Gateway Service set up with a usage-based license, update your current gatewayConfig.json configuration file to include the secret and the address of the route set up by Event Endpoint Management to report usage.

  1. A ConfigMap is available for the EventEndpointManager custom resource as part of the Event Endpoint Management installation. It is created in your namespace where you deployed Event Endpoint Management. Use the OpenShift CLI to retrieve the configuration from data.gatewayConfig\.json of the ConfigMap.

    Run the following command to retrieve the secret from the ConfigMap, and make a note of the value:

    oc get configmap -l app.kubernetes.io/name=eem-services -n <NAMESPACE> -ojsonpath='{.items[0].data.gatewayConfig\.json}' | grep secret

  2. Run the following command to retrieve the address of the route set up by Event Endpoint Management to report usage, and make a note of the address:

    oc get route <INSTANCE_NAME>-eem-services -n <NAMESPACE> -ojsonpath='{.status.ingress[0].host}'

  3. Modify the content of gatewayConfig.json configuration file to update it with the information retrieved in the previous two steps:

    • Edit secret and add the value retrieved in step 1.

    • Edit lsConfig.endpoint and add the address of the route you retrieved in step 2, including the https:// protocol prefix.

  4. You can verify that usage reporting is set up and working as expected.