Configuring gateways for applications

When you upgrade to Event Endpoint Management 11.8.0, your subscriptions are converted to applications. For applications to be able to subscribe to multiple topics, you must update your Event Gateways to support multi-topic subscriptions.

Important: Multi-topic subscriptions for applications are not enabled until all registered gateways are updated.

Before you begin

Ensure that your Event Manager is upgraded to 11.8.0, and your Event Gateways are all upgraded to use the image from the 11.8.0 release.

Identify all gateway configuration properties that you customized, for example, gateway security settings. You must set these properties again in the new gateway configuration.

To make your Event Gateways capable of handling applications that subscribe to multiple topics, follow the steps for your gateway type:

Converting operator-managed gateways

  1. In the Event Endpoint Management UI navigation pane, click Administration > Event Gateways.
  2. For each Event Gateway click More options icon More options > View configuration details.
  3. Select the Operator-managed tab.
  4. Copy the contents of the Gateway properties text area.
  5. Create a file called <gateway-name>-1180-update.yaml, and paste in the configuration from step 4.
  6. If you made customizations to your gateway, then update the corresponding properties in your <gateway-name>-1180-update.yaml file. For example, if you set spec.openTelemetry.endpoint='https://my.collector.endpoint.example.com:4317', then set this again in the <gateway-name>-1180-update.yaml file.
  7. Run the following command to apply the update: kubectl -n <namespace> apply -f <gateway-name>-1180-update.yaml.
  8. Update your gateway backup to use the <gateway-name>-1180-update.yaml file.

Converting Kubernetes Deployment gateways

  1. In the Event Endpoint Management UI navigation pane, click Administration > Event Gateways.
  2. For each Event Gateway click More options icon More options > View configuration details.
  3. Select the Kubernetes deployment tab.
  4. Copy the contents of the Gateway properties text area.
  5. Create a file called <gateway-name>-1180-update.yaml, and paste in the configuration from step 4.
  6. If you made customizations to your gateway, then update the corresponding properties in your <gateway-name>-1180-update.yaml file. For example, if you set spec.template.pod.spec.containers[egw].env[AUDIT_LOG_FORMAT]="CADF" in the custom resource definition of your gateway, then set audit.log.format=CADF in the ConfigMap section of your <gateway-name>-1180-update.yaml file. Review Event Gateway ConfigMap and environment variable reference and Event Gateway Custom Resource reference to identify where to set customized properties.
  7. Run the following command to apply the update: kubectl -n <namespace> apply -f <gateway-name>-1180-update.yaml.
  8. Update your gateway backup to the <gateway-name>-1180-update.yaml file.

Converting Docker gateways

  1. In the Event Endpoint Management UI navigation pane, click Administration > Event Gateways.
  2. For each Event Gateway click More options icon More options > View configuration details.
  3. Select the Docker tab.
  4. Copy the contents of the Gateway properties text area.
  5. Create a file called <gateway-name>-docker-run, and paste in the configuration from step 4.
  6. If you made customizations to your gateway, then update the corresponding properties in your <gateway-name>-docker-run file. Search the gateway properties ConfigMap and environment variables reference for the properties that you want to update.
  7. Use the new <gateway-name>-docker-run command as the run command for your gateway.
  8. Update your gateway backup with the <gateway-name>-docker-run file.