Common types

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

api/v2/core/base.proto

config.core.v3.Locality

[config.core.v3.Locality proto]

Identifies location of where either Envoy runs or where upstream hosts run.

{
  "region": "...",
  "zone": "...",
  "sub_zone": "..."
}

region

(string) Region this zone belongs to.

zone

(string) Defines the local service zone where Envoy is running. Though optional, it should be set if discovery service routing is used and the discovery service exposes zone data, either in this message or via --service-zone. The meaning of zone is context dependent, e.g. Availability Zone (AZ) on AWS, Zone on GCP, etc.

sub_zone

(string) When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.

config.core.v3.BuildVersion

[config.core.v3.BuildVersion proto]

BuildVersion combines SemVer version of extension with free-form build information (i.e. ‘alpha’, ‘private-build’) as a set of strings.

{
  "version": "{...}",
  "metadata": "{...}"
}

version

(type.v3.SemanticVersion) SemVer version of extension.

metadata

(Struct) Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file

config.core.v3.Extension

[config.core.v3.Extension proto]

Version and identification for an Envoy extension.

{
  "name": "...",
  "category": "...",
  "version": "{...}",
  "disabled": "..."
}

name

(string) This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.

category

(string) Category of the extension. Extension category names use reverse DNS notation. For instance “envoy.filters.listener” for Envoy’s built-in listener filters or “com.acme.filters.http” for HTTP filters from acme.com vendor.

version

(config.core.v3.BuildVersion) The version is a property of the extension and maintained independently of other extensions and the Envoy API. This field is not set when extension did not provide version information.

disabled

(bool) Indicates that the extension is present but was disabled via dynamic configuration.

config.core.v3.Node

[config.core.v3.Node proto]

Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving.

{
  "id": "...",
  "cluster": "...",
  "metadata": "{...}",
  "dynamic_parameters": "{...}",
  "locality": "{...}",
  "user_agent_name": "...",
  "user_agent_version": "...",
  "user_agent_build_version": "{...}",
  "extensions": [],
  "client_features": [],
  "listening_addresses": []
}

id

(string) An opaque node identifier for the Envoy node. This also provides the local service node name. It should be set if any of the following features are used: statsd, CDS, and HTTP tracing, either in this message or via --service-node.

cluster

(string) Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: statsd, health check cluster verification, runtime override directory, user agent addition, HTTP global rate limiting, CDS, and HTTP tracing, either in this message or via --service-cluster.

metadata

(Struct) Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.

dynamic_parameters

(repeated map<string, .xds.core.v3.ContextParams>) Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike other fields in this message). For example, the xDS client may have a shard identifier that changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the dynamic context on the Server::Instance’s LocalInfo context provider. The shard ID dynamic parameter then appears in this field during future discovery requests.

locality

(config.core.v3.Locality) Locality specifying where the Envoy instance is running.

user_agent_name

(string) Free-form string that identifies the entity requesting config. E.g. “envoy” or “grpc”

user_agent_version

(string) Free-form string that identifies the version of the entity requesting config. E.g. “1.12.2” or “abcd1234”, or “SpecialEnvoyBuild”

Only one of user_agent_version, user_agent_build_version may be set.

user_agent_build_version

(config.core.v3.BuildVersion) Structured version of the entity requesting config.

Only one of user_agent_version, user_agent_build_version may be set.

extensions

(repeated config.core.v3.Extension) List of extensions and their versions supported by the node.

client_features

(repeated string) Client feature support list. These are well known features described in the Envoy API repository for a given major version of an API. Client features use reverse DNS naming scheme, for example com.acme.feature. See the list of features that xDS client may support.

listening_addresses

(repeated config.core.v3.Address) Known listening ports on the node as a generic hint to the management server for filtering listeners to be returned. For example, if there is a listener bound to port 80, the list can optionally contain the SocketAddress (0.0.0.0,80). The field is optional and just a hint.

config.core.v3.Metadata

[config.core.v3.Metadata proto]

Metadata provides additional inputs to filters based on matched listeners, filter chains, routes and endpoints. It is structured as a map, usually from filter name (in reverse DNS format) to metadata specific to the filter. Metadata key-values for a filter are merged as connection and request handling occurs, with later values for the same key overriding earlier values.

An example use of metadata is providing additional values to http_connection_manager in the envoy.http_connection_manager.access_log namespace.

Another example use of metadata is to per service config info in cluster metadata, which may get consumed by multiple filters.

For load balancing, Metadata provides a means to subset cluster endpoints. Endpoints have a Metadata object associated and routes contain a Metadata object to match against. There are some well defined metadata used today for this purpose:

• {"envoy.lb": {"canary": <bool> }} This indicates the canary status of an endpoint and is also used during header processing (x-envoy-upstream-canary) and for stats purposes.

{
  "filter_metadata": "{...}",
  "typed_filter_metadata": "{...}"
}

filter_metadata

(repeated map<string, Struct>) Key is the reverse DNS filter name, e.g. com.acme.widget. The envoy.* namespace is reserved for Envoy’s built-in filters. If both filter_metadata and typed_filter_metadata fields are present in the metadata with same keys, only typed_filter_metadata field will be parsed.

typed_filter_metadata

(repeated map<string, Any>) Key is the reverse DNS filter name, e.g. com.acme.widget. The envoy.* namespace is reserved for Envoy’s built-in filters. The value is encoded as google.protobuf.Any. If both filter_metadata and typed_filter_metadata fields are present in the metadata with same keys, only typed_filter_metadata field will be parsed.

config.core.v3.RuntimeUInt32

[config.core.v3.RuntimeUInt32 proto]

Runtime derived uint32 with a default when not specified.

{
  "default_value": "...",
  "runtime_key": "..."
}

default_value

(uint32) Default value if runtime value is not available.

runtime_key

(string, REQUIRED) Runtime key to get value for comparison. This value is used if defined.

config.core.v3.RuntimePercent

[config.core.v3.RuntimePercent proto]

Runtime derived percentage with a default when not specified.

{
  "default_value": "{...}",
  "runtime_key": "..."
}

default_value

(type.v3.Percent) Default value if runtime value is not available.

runtime_key

(string, REQUIRED) Runtime key to get value for comparison. This value is used if defined.

config.core.v3.RuntimeDouble

[config.core.v3.RuntimeDouble proto]

Runtime derived double with a default when not specified.

{
  "default_value": "...",
  "runtime_key": "..."
}

default_value

(double) Default value if runtime value is not available.

runtime_key

(string, REQUIRED) Runtime key to get value for comparison. This value is used if defined.

config.core.v3.RuntimeFeatureFlag

[config.core.v3.RuntimeFeatureFlag proto]

Runtime derived bool with a default when not specified.

{
  "default_value": "{...}",
  "runtime_key": "..."
}

default_value

(BoolValue, REQUIRED) Default value if runtime value is not available.

runtime_key

(string, REQUIRED) Runtime key to get value for comparison. This value is used if defined. The boolean value must be represented via its canonical JSON encoding.

config.core.v3.HeaderValue

[config.core.v3.HeaderValue proto]

Header name/value pair.

{
  "key": "...",
  "value": "..."
}

key

(string, REQUIRED) Header name.

value

(string) Header value.

The same format specifier as used for HTTP access logging applies here, however unknown header values are replaced with the empty string instead of -.

config.core.v3.HeaderValueOption

[config.core.v3.HeaderValueOption proto]

Header name/value pair plus option to control append behavior.

{
  "header": "{...}",
  "append": "{...}"
}

header

(config.core.v3.HeaderValue, REQUIRED) Header name/value pair that this option applies to.

append

(BoolValue) Should the value be appended? If true (default), the value is appended to existing values. Otherwise it replaces any existing values.

Enum config.core.v3.HeaderValueOption.HeaderAppendAction

[config.core.v3.HeaderValueOption.HeaderAppendAction proto]

Describes the supported actions types for header append action.

APPEND_IF_EXISTS_OR_ADD

(DEFAULT) ⁣This action will append the specified value to the existing values if the header already exists. If the header doesn’t exist then this will add the header with specified key and value.

ADD_IF_ABSENT

⁣This action will add the header if it doesn’t already exist. If the header already exists then this will be a no-op.

OVERWRITE_IF_EXISTS_OR_ADD

⁣This action will overwrite the specified value by discarding any existing values if the header already exists. If the header doesn’t exist then this will add the header with specified key and value.

config.core.v3.HeaderMap

[config.core.v3.HeaderMap proto]

Wrapper for a set of headers.

{
  "headers": []
}

headers

(repeated config.core.v3.HeaderValue)

config.core.v3.WatchedDirectory

[config.core.v3.WatchedDirectory proto]

A directory that is watched for changes, e.g. by inotify on Linux. Move/rename events inside this directory trigger the watch.

{
  "path": "..."
}

path

(string, REQUIRED) Directory path to watch.

config.core.v3.DataSource

[config.core.v3.DataSource proto]

Data source consisting of either a file or an inline value.

{
  "filename": "...",
  "inline_bytes": "...",
  "inline_string": "..."
}

filename

(string) Local filesystem data source.

Precisely one of filename, inline_bytes, inline_string must be set.

inline_bytes

(bytes) Bytes inlined in the configuration.

Precisely one of filename, inline_bytes, inline_string must be set.

inline_string

(string) String inlined in the configuration.

Precisely one of filename, inline_bytes, inline_string must be set.

config.core.v3.RetryPolicy

[config.core.v3.RetryPolicy proto]

The message specifies the retry policy of remote data source when fetching fails.

{
  "retry_back_off": "{...}",
  "num_retries": "{...}"
}

retry_back_off

(config.core.v3.BackoffStrategy) Specifies parameters that control retry backoff strategy. This parameter is optional, in which case the default base interval is 1000 milliseconds. The default maximum interval is 10 times the base interval.

num_retries

(UInt32Value) Specifies the allowed number of retries. This parameter is optional and defaults to 1.

config.core.v3.RemoteDataSource

[config.core.v3.RemoteDataSource proto]

The message specifies how to fetch data from remote and how to verify it.

{
  "http_uri": "{...}",
  "sha256": "...",
  "retry_policy": "{...}"
}

http_uri

(config.core.v3.HttpUri, REQUIRED) The HTTP URI to fetch the remote data.

sha256

(string, REQUIRED) SHA256 string for verifying data.

retry_policy

(config.core.v3.RetryPolicy) Retry policy for fetching remote data.

config.core.v3.AsyncDataSource

[config.core.v3.AsyncDataSource proto]

Async data source which support async data fetch.

{
  "local": "{...}",
  "remote": "{...}"
}

local

(config.core.v3.DataSource) Local async data source.

Precisely one of local, remote must be set.

remote

(config.core.v3.RemoteDataSource) Remote async data source.

Precisely one of local, remote must be set.

config.core.v3.TransportSocket

[config.core.v3.TransportSocket proto]

Configuration for transport socket in listeners and clusters. If the configuration is empty, a default transport socket implementation and configuration will be chosen based on the platform and existence of tls_context.

{
  "name": "...",
  "typed_config": "{...}"
}

name

(string, REQUIRED) The name of the transport socket to instantiate. The name must match a supported transport socket implementation.

typed_config

(Any) Implementation specific configuration which depends on the implementation being instantiated. See the supported transport socket implementations for further documentation.

config.core.v3.RuntimeFractionalPercent

[config.core.v3.RuntimeFractionalPercent proto]

Runtime derived FractionalPercent with defaults for when the numerator or denominator is not specified via a runtime key.

Note

Parsing of the runtime key’s data is implemented such that it may be represented as a FractionalPercent proto represented as JSON/YAML and may also be represented as an integer with the assumption that the value is an integral percentage out of 100. For instance, a runtime key lookup returning the value “42” would parse as a FractionalPercent whose numerator is 42 and denominator is HUNDRED.

{
  "default_value": "{...}",
  "runtime_key": "..."
}

default_value

(type.v3.FractionalPercent, REQUIRED) Default value if the runtime value’s for the numerator/denominator keys are not available.

runtime_key

(string) Runtime key for a YAML representation of a FractionalPercent.

config.core.v3.ControlPlane

[config.core.v3.ControlPlane proto]

Identifies a specific ControlPlane instance that Envoy is connected to.

{
  "identifier": "..."
}

identifier

(string) An opaque control plane identifier that uniquely identifies an instance of control plane. This can be used to identify which control plane instance, the Envoy is connected to.

Enum config.core.v3.RoutingPriority

[config.core.v3.RoutingPriority proto]

Envoy supports upstream priority routing both at the route and the virtual cluster level. The current priority implementation uses different connection pool and circuit breaking settings for each priority level. This means that even for HTTP/2 requests, two physical connections will be used to an upstream host. In the future Envoy will likely support true HTTP/2 priority over a single upstream connection.

DEFAULT

(DEFAULT) ⁣

HIGH

⁣

Enum config.core.v3.RequestMethod

[config.core.v3.RequestMethod proto]

HTTP request method.

METHOD_UNSPECIFIED

(DEFAULT) ⁣

GET

⁣

HEAD

⁣

POST

⁣

PUT

⁣

DELETE

⁣

CONNECT

⁣

OPTIONS

⁣

TRACE

⁣

PATCH

⁣

Enum config.core.v3.TrafficDirection

[config.core.v3.TrafficDirection proto]

Identifies the direction of the traffic relative to the local Envoy.

UNSPECIFIED

(DEFAULT) ⁣Default option is unspecified.

INBOUND

⁣The transport is used for incoming traffic.

OUTBOUND

⁣The transport is used for outgoing traffic.