Home / Keptn v1 Docs / Release 0.18.x / Reference / Miscellaneous / distributor
A distributor subscribes a Keptn service with the Keptn Control Plane. Both local and remote subscriptions are supported:
Each service has its own distributor that is configured by environment variables. In most cases, only a subset of these need to be configured. After the application is deployed, its subscription can be changed directly in the Bridge.
The following environment variables configure the distributor when it runs outside the Keptn cluster:
KEPTN_API_ENDPOINT- Keptn API Endpoint - needed when the distributor runs outside of the Keptn cluster. default =
KEPTN_API_TOKEN- Keptn API Token - needed when the distributor runs outside of the Keptn cluster. default =
The following environment variables configure Keptn to serve as a proxy for the Keptn API:
API_PROXY_PORT- Port on which the distributor listens for incoming Keptn API requests by its execution plane service. default =
API_PROXY_PATH- Path on which the distributor listens for incoming Keptn API requests by its execution plane service. default =
API_PROXY_HTTP_TIMEOUT- Timeout value (in seconds) for the API Proxy’s HTTP Client. default =
HTTP_POLLING_INTERVAL- Interval (in seconds) in which the distributor checks for new triggered events on the Keptn API. default =
EVENT_FORWARDING_PATH- Path on which the distributor listens for incoming events from its execution plane service. default =
HTTP_SSL_VERIFY- Determines whether the distributor should check the validity of SSL certificates when sending requests to a Keptn API endpoint via HTTPS. default =
The following environment variables configure the distributor when it runs within the Keptn cluster:
PUBSUB_URL- The URL of the NATS cluster to which the distributor should connect when the distributor is running within the Keptn cluster. default =
PUBSUB_TOPIC- Comma separated list of topics (i.e. event types) for which the distributor should listen (see https://github.com/keptn/spec/blob/0.2.4/cloudevents.md for details). This is the initial subscription for the service; it is overridden by subscription information supplied through the Bridge.
PUBSUB_RECIPIENT- Hostname of the execution plane service to which the distributor should forward incoming CloudEvents. default =
PUBSUB_RECIPIENT_PORT- Port of the execution plane service to which the distributor should forward incoming CloudEvents. default =
PUBSUB_RECIPIENT_PATH- Path of the execution plane service to which the distributor should forward incoming CloudEvents. default =
PUBSUB_GROUP- Used to join a group for receiving messages from the message broker. Note that only one instance of a distributor in a set of distributors having the same
PUBSUB_GROUPare able to receive the event. default =
The following environment variables filter events:
PROJECT_FILTER- Filter events for a specific project. default =
"", supports a comma-separated list of projects.
STAGE_FILTER- Filter events for a specific stage. default =
"", supports a comma-separated list of stages.
SERVICE_FILTER- Filter events for a specific service. default =
"", supports a comma-separated list of services.
The following environment variables configure how the distributor identifies specific integrations:
DISABLE_REGISTRATION- Disables automatic registration of the Keptn integration to the control plane. default =
REGISTRATION_INTERVAL- Time duration between trying to re-register to the Keptn control plane. default =
LOCATION- Location on which the distributor is running, e.g. “executionPlane-A”. default =
DISTRIBUTOR_VERSION- The software version of the distributor. default =
VERSION- The version of the Keptn integration. default =
K8S_DEPLOYMENT_NAME- Kubernetes deployment name of the Keptn integration. default =
K8S_POD_NAME- Kubernetes deployment name of the Keptn integration. default =
K8S_NAMESPACE- Kubernetes namespace of the Keptn integration, which is
keptn-execfor the Execution Plane. default =
The following environment variables configure the Oauth Client Credentials:
OAUTH_CLIENT_ID- OAuth client ID used when performing Oauth Client Credentials Flow. default =
OAUTH_CLIENT_SECRET- OAuth client ID used when performing Oauth Client Credentials Flow. default =
OAUTH_DISCOVERY- Discovery URL called by the distributor to obtain further information for the OAuth Client Credentials Flow, e.g. the token URL. default =
OAUTH_TOKEN_URL- Url to obtain the access token. If set, this will override
OAUTH_DISCOVERYmeaning, that no discovery will happen. default =
OAUTH_SCOPES- Comma separated list of tokens to be used during the OAuth Client Credentials Flow. =
All cloud events specified in
PUBSUB_TOPIC that match the filters
are forwarded to
The above list of environment variables is pretty long, but in most scenarios only a few of them have to be set. The following examples show how to set the environment variables properly, depending on where the distributor and it’s accompanying execution plane service should run:
Configuring the distributor when running within the Keptn cluster
In this case, usually only the
PUBSUB_TOPIC must be defined, e.g.:
This is not necessary if the distributor is used only as a proxy for the Keptn API and not needed for subscribing to any topic.
This forwards all incoming events of that topic to
which is the URL of the execution plane service running in the same pod as the distributor.
If the execution plane service has a different hostname (e.g., when not running in the same pod),
a different port, or listens for events on a different path,
the env vars
can be set to change this default URL, e.g.:
PUBSUB_RECIPIENT: "http://my-service PUBSUB_RECIPIENT_PORT: "9000" PUBSUB_RECIPIENT_PATH: "/event-path
This causes the distributor to forward all incoming events for its subscribed topic
The execution plane service can then access the distributor’s Keptn API proxy at
and can forward events by sending them to
The Keptn API services are then reachable for the execution plane service via the following URLs:
If the distributor should listen on a port other than
(e.g. when that port is needed by the execution plane service),
a different port can be set using the
API_PROXY_PORT environment variable.
Configuring the distributor when running outside of the Keptn cluster
In this case, the Keptn API URL and the API token, as well as a topic have to be defined:
KEPTN_API_ENDPOINT: "https://my-keptn-api:8080/api" KEPTN_API_TOKEN: "my-keptn-api-token" PUBSUB_TOPIC: "sh.keptn.event.approval.triggered" # can be left empty if the distributor is only used as a proxy to interact with the Keptn API
If the endpoint specified by
KEPTN_API_ENDPOINT does not provide a valid SSL certificate,
by default, the distributor denies any requests to that endpoint.
This behavior can be changed by setting the variable
The remaining parameters, such as
PUBSUB_RECIPIENT_PATH, as well as the
API_PROXY_PORT can be configured as described above.
Providing a unique name for execution planes that run the same integration
If your Keptn multi-cluster set-up includes multiple execution planes that run the same integration service, you must configure a unique name for each execution plane. By default, Keptn uses the execution plane integration name and version to identify the execution plane. Multiple execution planes that run the same integration service thus have the same identifier, so Keptn assigns the same set of event subscriptions to them all unless you assign a different name to each remote execution plane integration.
K8S_DEPLOYMENT_NAME environment variable on each execution plane
to set a unique name label and distributor service name for that execution plane:
Each integration that uses the distibutor must properly configure the value of
Some integrations, including
configure this value based on the value of the
app.kubernetes.io/name Kubernetes label;
for example, see the Jmeter deployment.yaml file.
For these integrations, you can provide a unique name for the execution plane
by editing the
values.yaml on each execution plane and setting a unique value for the
Note that, if the
nameOverride value is set to a different value
K8S_DEPLOYMENT_NAME environment variable,
K8S_DEPLOYMENT_NAME takes precedence.
Distributors are installed automatically as a part of Keptn.
To deploy the current version of a distributor in your Keptn Kubernetes cluster, apply the deploy/distributor.yaml file from this repository:
kubectl apply -f deploy/service.yaml
To delete a deployed distributor, use the file
deploy/distributor.yaml from this repository and delete the Kubernetes resources:
kubectl delete -f deploy/service.yaml
Keptn release 0.15.x and earlier supported the
K8S_NODE_NAME environment variable to define
the Kubernetes node name on which the Keptn integration runs.
Using this variable in conjunction with
allowed Keptn to differentiate between instances of the same integration
that ran on different execution planes
so it was not necessary to manually set the value of
For Keptn release 0.16.x and later,
each integration is now uniquely defined by just two parameters:
K8S_DEPLOYMENT_NAME (which is a string such as
jmeter-service unless modified)
K8S_NAMESPACE (which is
K8S_DEPLOYMENT_NAME environment variable must be explicitly set to a unique value
on each execution plane
so that all instances of the integration are listed separately on the integrations page in the Keptn Bridge
and so that events for that integration are only delivered to the appropriate execution plane.
In Keptn Release 0.14.x, the NATS dependency is upgraded.
Because of this, the NATS cluster name is now
keptn-nats-cluster as used in earlier releases.
This causes a crashloop for any Keptn service that is not using the 0.14.x distributor.
If you cannot update your distributor to 0.14.x,
you may be able to run your existing distributor
by setting the
PUBSUB_URLenvironment variable to
See the Keptn.0.14.1 Release Announcement