Advanced Event Gateway configuration

Configure environment variables, security, and performance settings.

How your Event Gateway is configured depends on the deployment method of that gateway instance. Refer to the Event Gateways properties reference for details of all the Event Gateway configuration properties.

Note: Remember to back up your gateway configuration after you make updates.

Operator-managed Event Gateways

Operator-managed Event Gateways are configured in the Event Gateway custom resource. The Event Endpoint Management operator observes, reconciles, and enforces the configuration that is specified in the custom resource.

Setting Event Gateway environment variables

Environment variables can be set as follows for operator-managed Event Gateway instances by using template overrides:

spec:
  template:
    pod:
      spec:
        containers:
          - name: egw
            env:
              - name: <name>
                value: <value>

Kubernetes Deployment Event Gateways

Kubernetes Deployment Event Gateways are configured in the Event Gateway ConfigMap. The Event Endpoint Management UI generates the ConfigMap when you install the Event Gateway.

Setting ConfigMap properties on Kubernetes Deployment Event Gateways

Important: For operator-managed gateways, do not configure gateway properties in the ConfigMap, set gateway properties in the custom resource.

The format of the Kubernetes Deployment Event Gateway’s ConfigMap is as follows:

apiVersion: v1
kind: ConfigMap
metadata:
  name: "<gateway group>-<gateway id>-config"
  labels:
    app: "testexample"
    gatewayGroup: "<gateway group>"
    gatewayId: "<gateway id>"
data:
  gateway.properties: |
    # Gateway Configuration
    egw.enable.otel.metrics=true
    kafka.otel.record.tracing.enabled=true
    ...

Run the following command to edit the ConfigMap:

kubectl -n <namespace> edit configmap <gateway group>-<gateway id>-config

If you want to supply string-type properties without them being visible in the ConfigMap, then you can set the property to a file path with file://<filepath>, where the specified file contains the property value. You can append ?jsonpath=<json-path> to pull out a single string value from a JSON file.
Property names that contain {n} must be updated to replace {n} with a string of your choice. You can use this string to group properties together. For example, replace kafka.listener.{0}.groups with kafka.listener.external.groups.

Docker Event Gateways

On Docker gateways, properties are configured by providing arguments in the Docker run command, for example: -e <variable name>.

To update Docker gateway properties:

Uninstall the gateway as described in Uninstalling a Docker Event Gateway.
Deploy the docker gateway again with the properties that you want to change specified in the docker run arguments.

Configuring Event Gateway security

You can configure several settings that can protect the Event Gateway from uncontrolled resource consumption such as excessive memory usage, or connection exhaustion. Enable these features to help you ensure that the gateway remains available and responsive.

For information about the security properties that you can configure, see the Event Gateways properties reference.