Event Gateway configuration reference

Uses: Event Gateway

Version:

Applying configuration

You can configure a Kong Event Gateway data plane at start time by passing environment variables or a YAML configuration file.

Event Gateway reads settings for a data plane node in the following order of precedence:

Environment variables
YAML configuration file
Default parameters

Note: Configuration can only be applied at data plane node startup. If you need to adjust any configuration, launch a new data plane, or stop the data plane and relaunch it with the new file or environment variables.

All configuration parameters for Event Gateway data planes can be managed via environment variables.

To configure a setting using an environment variable, declare an environment variable with the name of the setting.

Parameters specific to your data plane, such as observability and debugging, must be prefixed with KEG__
Parameters that define the connection between the data plane and the control plane must be prefixed with KEG__KONNECT__ or KONNECT_

See each configuration parameter for the specific environment variable that you need to set.

For example, to set the log level to error, you would set the following during launch, adding KEG__OBSERVABILITY__LOG_FLAGS to the default parameters:

docker run -d \
-e "KONNECT_REGION=us" \
-e "KONNECT_DOMAIN=konghq.com" \
-e "KONNECT_GATEWAY_CLUSTER_ID=your-gateway-id" \
-e "KONNECT_CLIENT_CERT=example-cert" \
-e "KONNECT_CLIENT_KEY=example-key" \
-e "KEG__OBSERVABILITY__LOG_FLAGS=error" \
-p 19092-19101:19092-19101 \
kong/kong-event-gateway:latest

Copied!

Note: Using a local config file is intended for internal development and testing purposes only.

To configure Event Gateway, you can create a configuration file in YAML format.

For example, here’s a basic configuration file that adds a log level setting to the default data plane node settings:

cat <<EOF > bootstrap.yaml
konnect:
  region: us
  domain: konghq.com
  gateway_cluster_id: example-gateway-uuid
  client_cert: |
    example-cert
  client_key: |
    example-key
observability:
  log_flags: error
EOF

Copied!

To apply the file, mount the file to the container and pass the --bootstrap flag with the run command. For example:

docker run \
  -v /host/path/bootstrap.yaml:/container/path/bootstrap.yaml \
  kong/kong-event-gateway:latest \
  --bootstrap /container/path/bootstrap.yaml

Copied!

Event Gateway configuration reference

Applying configuration

Configuration parameters

Help us make these docs great!

Still need help