12 min • read

Emissary-ingress Environment variables

Use the following variables for the environment of your Emissary-ingress container:

VariableDefault valueValue type
AMBASSADOR_ID[ "default" ]List of strings
AES_LOG_LEVELwarnLog level
AGENT_CONFIG_RESOURCE_NAMEambassador-agent-cloud-tokenString
AMBASSADOR_AMBEX_NO_RATELIMITfalseBoolean: true=true, any other value=false
AMBASSADOR_AMBEX_SNAPSHOT_COUNT30Integer
AMBASSADOR_CLUSTER_IDEmptyString
AMBASSADOR_CONFIG_BASE_DIR/ambassadorString
AMBASSADOR_DISABLE_FEATURESEmptyAny
AMBASSADOR_DRAIN_TIME600Integer
AMBASSADOR_ENVOY_API_VERSIONV3String Enum; V3 or V2
AMBASSADOR_GRPC_METRICS_SINKEmptyString (address:port)
AMBASSADOR_ISTIO_SECRET_DIR/etc/istio-certsString
AMBASSADOR_JSON_LOGGINGfalseBoolean; non-empty=true, empty=false
AMBASSADOR_LABEL_SELECTOREmptyString (label=value)
AMBASSADOR_NAMESPACEdefault (1)Kubernetes namespace
AMBASSADOR_RECONFIG_MAX_DELAY1Integer
AMBASSADOR_SINGLE_NAMESPACEEmptyBoolean; non-empty=true, empty=false
AMBASSADOR_SNAPSHOT_COUNT4Integer
AMBASSADOR_VERIFY_SSL_FALSEfalseBoolean; true=true, any other value=false
DD_ENTITY_IDEmptyString
DOGSTATSDfalseBoolean; Python value.lower() == "true"
SCOUT_DISABLEfalseBoolean; false=false, any other value=true
STATSD_ENABLEDfalseBoolean; Python value.lower() == "true"
STATSD_PORT8125Integer
STATSD_HOSTstatsd-sinkString
STATSD_FLUSH_INTERVAL1Integer
_AMBASSADOR_IDEmptyString
_AMBASSADOR_TLS_SECRET_NAMEEmptyString
_AMBASSADOR_TLS_SECRET_NAMESPACEEmptyString
_CONSUL_HOSTEmptyString
_CONSUL_PORTEmptyInteger
AMBASSADOR_DISABLE_SNAPSHOT_SERVERfalseBoolean; non-empty=true, empty=false
AMBASSADOR_ENVOY_BASE_ID0Integer

Feature Flag Environment Variables

VariableDefault valueValue type
AMBASSADOR_EDS_BYPASSfalseBoolean; Python value.lower() == "true"
AMBASSADOR_FORCE_SECRET_VALIDATIONfalseBoolean: true=true, any other value=false
AMBASSADOR_KNATIVE_SUPPORTfalseBoolean; non-empty=true, empty=false
AMBASSADOR_UPDATE_MAPPING_STATUSfalseBoolean; true=true, any other value=false
ENVOY_CONCURRENCYEmptyInteger
DISABLE_STRICT_LABEL_SELECTORSfalseBoolean; true=true, any other value=false

AMBASSADOR_ID

Emissary-ingress supports running multiple installs in the same cluster without restricting a given instance of Emissary-ingress to a single namespace. The resources that are visible to an installation can be limited with the AMBASSADOR_ID environment variable.

More information

AES_LOG_LEVEL

Adjust the log level by setting the AES_LOG_LEVEL environment variable; from least verbose to most verbose, the valid values are error, warn/warning, info, debug, and trace. The default is info. Log level names are case-insensitive.

More information

AGENT_CONFIG_RESOURCE_NAME

Allows overriding the default config_map/secret that is used for extracting the CloudToken for connecting with Ambassador cloud. It allows all components (and not only the Ambassador Agent) to authenticate requests to Ambassador Cloud. If unset it will just fallback to searching for a config map or secret with the name of ambassador-agent-cloud-token. Note: the secret will take precedence if both a secret and config map are set.

AMBASSADOR_AMBEX_NO_RATELIMIT

Completely disables ratelimiting Envoy reconfiguration under memory pressure. This can help performance with the endpoint or Consul resolvers, but could make OOMkills more likely with large configurations. The default is false, meaning that the rate limiter is active.

More information

AMBASSADOR_AMBEX_SNAPSHOT_COUNT

Envoy-configuration snapshots get saved (as ambex-#.json) in /ambassador/snapshots. The number of snapshots is controlled by the AMBASSADOR_AMBEX_SNAPSHOT_COUNT environment variable. Set it to 0 to disable.

More information

AMBASSADOR_CLUSTER_ID

Each Emissary-ingress installation generates a unique cluster ID based on the UID of its Kubernetes namespace and its Emissary-ingress ID: the resulting cluster ID is a UUID which cannot be used to reveal the namespace name nor Emissary-ingress ID itself. Emissary-ingress needs RBAC permission to get namespaces for this purpose, as shown in the default YAML files provided by Datawire; if not granted this permission it will generate a UUID based only on the Emissary-ingress ID. To disable cluster ID generation entirely, set the environment variable AMBASSADOR_CLUSTER_ID to a UUID that will be used for the cluster ID.

More information

AMBASSADOR_CONFIG_BASE_DIR

Controls where Emissary-ingress will store snapshots. By default, the latest configuration will be in /ambassador/snapshots. If you have overridden it, Emissary-ingress saves configurations in $AMBASSADOR_CONFIG_BASE_DIR/snapshots.

More information

AMBASSADOR_DISABLE_FEATURES

To completely disable feature reporting, set the environment variable AMBASSADOR_DISABLE_FEATURES to any non-empty value.

More information

AMBASSADOR_DRAIN_TIME

At each reconfiguration, Emissary-ingress keeps around the old version of it's envoy config for the duration of the configured drain time. The AMBASSADOR_DRAIN_TIME variable controls how much of a grace period Emissary-ingress provides active clients when reconfiguration happens. Its unit is seconds and it defaults to 600 (10 minutes). This can impact memory usage because Emissary-ingress needs to keep around old versions of its configuration for the duration of the drain time.

More information

AMBASSADOR_ENVOY_API_VERSION

By default, Emissary-ingress will configure Envoy using the V3 Envoy API. In Emissary-ingress 2.0, you were able switch back to Envoy V2 by setting the AMBASSADOR_ENVOY_API_VERSION environment variable to "V2". Emissary-ingress 3.0 has removed support for the V2 API and only the V3 API is used. While this variable cannot be set to another value in 3.0, it may be used when introducing new API versions that are not yet available in Emissary-ingress such as V4.

AMBASSADOR_GRPC_METRICS_SINK

Configures Edgissary (envoy) to send metrics to the Agent which are then relayed to the Cloud. If not set then we don’t configure envoy to send metrics to the agent. If set with a bad address:port then we log an error message. In either scenario, it just stops metrics from being sent to the Agent which has no negative effect on general routing or Edgissary uptime.

AMBASSADOR_ISTIO_SECRET_DIR

Emissary-ingress will read the mTLS certificates from /etc/istio-certs unless configured to use a different directory with the AMBASSADOR_ISTIO_SECRET_DIR environment variable and create a secret in that location named istio-certs.

More information

AMBASSADOR_JSON_LOGGING

When AMBASSADOR_JSON_LOGGING is set to true, JSON format will be used for most of the control plane logs. Some (but few) logs from gunicorn and the Kubernetes client-go package will still be in text only format.

More information

AMBASSADOR_LABEL_SELECTOR

Restricts Emissary-ingress's configuration to only the labelled resources. For example, you could apply a version-two: true label to all resources that should be visible to Emissary-ingress, then set AMBASSADOR_LABEL_SELECTOR=version-two=true in its Deployment. Resources without the specified label will be ignored.

AMBASSADOR_NAMESPACE

Controls namespace configuration for Amabssador.

More information

AMBASSADOR_RECONFIG_MAX_DELAY

Controls up to how long Ambassador will wait to receive changes before doing an Envoy reconfiguration. The unit is in seconds and must be > 0.

AMBASSADOR_SINGLE_NAMESPACE

When set, configures Emissary-ingress to only work within a single namespace.

More information

AMBASSADOR_SNAPSHOT_COUNT

The number of snapshots that Emissary-ingress should save.

AMBASSADOR_VERIFY_SSL_FALSE

By default, Emissary-ingress will verify the TLS certificates provided by the Kubernetes API. In some situations, the cluster may be deployed with self-signed certificates. In this case, set AMBASSADOR_VERIFY_SSL_FALSE to true to disable verifying the TLS certificates.

More information

DD_ENTITY_ID

Emissary-ingress supports setting the dd.internal.entity_id statitics tag using the DD_ENTITY_ID environment variable. If this value is set, statistics will be tagged with the value of the environment variable. Otherwise, this statistics tag will be omitted (the default).

More information

DOGSTATSD

If you are a user of the Datadog monitoring system, pulling in the Envoy statistics from Emissary-ingress is very easy. Because the DogStatsD protocol is slightly different than the normal StatsD protocol, in addition to setting Emissary-ingress's STATSD_ENABLED=true environment variable, you also need to set theDOGSTATSD=true environment variable.

More information

SCOUT_DISABLE

Emissary-ingress integrates Scout, a service that periodically checks with Datawire servers to advise of available updates. Scout also sends anonymized usage data and the Emissary-ingress version. This information is important to us as we prioritize test coverage, bug fixes, and feature development. Note that the Emissary-ingress will run regardless of the status of Scout.

We do not recommend you disable Scout, since we use this mechanism to notify users of new releases (including critical fixes and security issues). This check can be disabled by setting the environment variable SCOUT_DISABLE to 1 in your Emissary-ingress deployment.

More information

STATSD_ENABLED

If enabled, then Emissary-ingress has Envoy expose metrics information via the ubiquitous and well-tested StatsD protocol. To enable this, you will simply need to set the environment variable STATSD_ENABLED=true in Emissary-ingress's deployment YAML

More information

STATSD_HOST

When this variable is set, Emissary-ingress by default sends statistics to a Kubernetes service named statsd-sink on UDP port 8125 (the usual port of the StatsD protocol). You may instead tell Emissary-ingress to send the statistics to a different StatsD server by setting the STATSD_HOST environment variable. This can be useful if you have an existing StatsD sink available in your cluster.

More information

STATSD_PORT

Allows for configuring StatsD on a port other than the default (8125)

More information

STATSD_FLUSH_INTERVAL

How often, in seconds, to submit statsd reports (if STATSD_ENABLED)

More information

_AMBASSADOR_ID

Used with the Ambassador Consul connector. Sets the Ambassador ID so multiple instances of this integration can run per-Cluster when there are multiple Emissary-ingresses (Required if AMBASSADOR_ID is set in your Emissary-ingress Deployment

More information

_AMBASSADOR_TLS_SECRET_NAME

Used with the Ambassador Consul connector. Sets the name of the Kubernetes v1.Secret created by this program that contains the Consul-generated TLS certificate.

More information

_AMBASSADOR_TLS_SECRET_NAMESPACE

Used with the Ambassador Consul connector. Sets the namespace of the Kubernetes v1.Secret created by this program.

More information

_CONSUL_HOST

Used with the Ambassador Consul connector. Sets the IP or DNS name of the target Consul HTTP API server

More information

_CONSUL_PORT

Used with the Ambassador Consul connector. Sets the port number of the target Consul HTTP API server.

More information

AMBASSADOR_DISABLE_SNAPSHOT_SERVER

Disables the built-in snapshot server

AMBASSADOR_ENVOY_BASE_ID

Base ID of the Envoy process

AMBASSADOR_EDS_BYPASS

Bypasses EDS handling of endpoints and causes endpoints to be inserted to clusters manually. This can help resolve with 503 UH caused by certification rotation relating to a delay between EDS + CDS.

AMBASSADOR_FORCE_SECRET_VALIDATION

If you set the AMBASSADOR_FORCE_SECRET_VALIDATION environment variable, invalid Secrets will be rejected, and a Host or TLSContext resource attempting to use an invalid certificate will be disabled entirely.

More information

AMBASSADOR_KNATIVE_SUPPORT

Enables support for knative

AMBASSADOR_UPDATE_MAPPING_STATUS

If AMBASSADOR_UPDATE_MAPPING_STATUS is set to the string true, Emissary-ingress will update the status of every Mapping CRD that it accepts for its configuration. This has no effect on the proper functioning of Emissary-ingress itself, and can be a performance burden on installations with many Mappings. It has no effect for Mappings stored as annotations.

The default is false. We recommend leaving AMBASSADOR_UPDATE_MAPPING_STATUS turned off unless required for external systems.

More information

ENVOY_CONCURRENCY

Configures the optional --concurrency command line option when launching Envoy. This controls the number of worker threads used to serve requests and can be used to fine-tune system resource usage.

DISABLE_STRICT_LABEL_SELECTORS

In Emissary-ingress version 3.2, a bug with how Hosts are associated with Mappings was fixed and with how Listeners are assocaited with Hosts. The mappingSelector\selector fields in Hosts and Listeners were not properly being enforced in prior versions. If any single label from the selector was matched then the resources would be associated with each other instead of requiring all labels in the selector to be present. Additonally, if the hostname of a Mapping matched the hostname of a Host then they would be associated regardless of the configuration of mappingSelector\selector.

In version 3.2 this bug was fixed and resources that configure a selector will only be associated if all labels required by the selector are present. This brings the mappingSelector and selector fields in-line with how label selectors are used throughout Kubernetes. To avoid unexpected behavior after the upgrade, add all labels that configured in any mappingSelector\selector to Mappings you want to associate with the Host or the Hosts you want to be associated with the Listener. You can opt-out of this fix and return to the old association behavior by setting the environment variable DISABLE_STRICT_LABEL_SELECTORS to "true" (default: "false"). A future version of Emissary-ingress may remove the ability to opt-out of this bugfix.

Note: The mappingSelector field is only configurable on v3alpha1 CRDs. In the v2 CRDs the equivalent field is selector. either selector or mappingSelector may be configured in the v3alpha1 CRDs, but selector has been deprecated in favour of mappingSelector.

See The Host documentation for more information about Host / Mapping association.

Port assignments

Emissary-ingress uses the following ports to listen for HTTP/HTTPS traffic automatically via TCP:

PortProcessFunction
8001envoyInternal stats, logging, etc.; not exposed outside pod
8002wattInternal watt snapshot access; not exposed outside pod
8003ambexInternal ambex snapshot access; not exposed outside pod
8004diagdInternal diagd access; not exposed outside pod
8005snapshotExposes a scrubbed Emissary-ingress snapshot outside of the pod
8080envoyDefault HTTP service port
8443envoyDefault HTTPS service port
8877diagdDirect access to diagnostics UI; provided by busyambassador entrypoint

  1. This may change in a future release to reflect the Pods's namespace if deployed to a namespace other than default. https://github.com/emissary-ingress/emissary/issues/1583