Overview

The Envoy v2 APIs are defined as proto3 Protocol Buffers in the data plane API repository. They support

  • Streaming delivery of xDS API updates via gRPC. This reduces resource requirements and can lower the update latency.
  • A new REST-JSON API in which the JSON/YAML formats are derived mechanically via the proto3 canonical JSON mapping.
  • Delivery of updates via the filesystem, REST-JSON or gRPC endpoints.
  • Advanced load balancing through an extended endpoint assignment API and load and resource utilization reporting to management servers.
  • Stronger consistency and ordering properties when needed. The v2 APIs still maintain a baseline eventual consistency model.

See the xDS protocol description for further details on aspects of v2 message exchange between Envoy and the management server.

Bootstrap configuration

To use the v2 API, it’s necessary to supply a bootstrap configuration file. This provides static server configuration and configures Envoy to access dynamic configuration if needed. This is supplied on the command-line via the -c flag, i.e.:

  1. ./envoy -c <path to config>.{json,yaml,pb,pb_text}

where the extension reflects the underlying v2 config representation.

The Bootstrap message is the root of the configuration. A key concept in the Bootstrap message is the distinction between static and dynamic resources. Resources such as a Listener or Cluster may be supplied either statically in static_resources or have an xDS service such as LDS or CDS configured in dynamic_resources.

Example

Below we will use YAML representation of the config protos and a running example of a service proxying HTTP from 127.0.0.1:10000 to 127.0.0.2:1234.

Static

A minimal fully static bootstrap config is provided below:

  1. admin:
  2.   access_log_path: /tmp/admin_access.log
  3.   address:
  4.     socket_address: { address: 127.0.0.1, port_value: 9901 }
  6. static_resources:
  7.   listeners:
  8.   - name: listener_0
  9.     address:
  10.       socket_address: { address: 127.0.0.1, port_value: 10000 }
  11.     filter_chains:
  12.     - filters:
  13.       - name: envoy.http_connection_manager
  14.         typed_config:
  15.           "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
  16.           stat_prefix: ingress_http
  17.           codec_type: AUTO
  18.           route_config:
  19.             name: local_route
  20.             virtual_hosts:
  21.             - name: local_service
  22.               domains: ["*"]
  23.               routes:
  24.               - match: { prefix: "/" }
  25.                 route: { cluster: some_service }
  26.           http_filters:
  27.           - name: envoy.router
  28.   clusters:
  29.   - name: some_service
  30.     connect_timeout: 0.25s
  31.     type: STATIC
  32.     lb_policy: ROUND_ROBIN
  33.     load_assignment:
  34.       cluster_name: some_service
  35.       endpoints:
  36.       - lb_endpoints:
  37.         - endpoint:
  38.             address:
  39.               socket_address:
  40.                 address: 127.0.0.1
  41.                 port_value: 1234

Mostly static with dynamic EDS

A bootstrap config that continues from the above example with dynamic endpoint discovery via an EDS gRPC management server listening on 127.0.0.1:5678 is provided below:

  1. admin:
  2.   access_log_path: /tmp/admin_access.log
  3.   address:
  4.     socket_address: { address: 127.0.0.1, port_value: 9901 }
  6. static_resources:
  7.   listeners:
  8.   - name: listener_0
  9.     address:
  10.       socket_address: { address: 127.0.0.1, port_value: 10000 }
  11.     filter_chains:
  12.     - filters:
  13.       - name: envoy.http_connection_manager
  14.         typed_config:
  15.           "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
  16.           stat_prefix: ingress_http
  17.           codec_type: AUTO
  18.           route_config:
  19.             name: local_route
  20.             virtual_hosts:
  21.             - name: local_service
  22.               domains: ["*"]
  23.               routes:
  24.               - match: { prefix: "/" }
  25.                 route: { cluster: some_service }
  26.           http_filters:
  27.           - name: envoy.router
  28.   clusters:
  29.   - name: some_service
  30.     connect_timeout: 0.25s
  31.     lb_policy: ROUND_ROBIN
  32.     type: EDS
  33.     eds_cluster_config:
  34.       eds_config:
  35.         api_config_source:
  36.           api_type: GRPC
  37.           grpc_services:
  38.             envoy_grpc:
  39.               cluster_name: xds_cluster
  40.   - name: xds_cluster
  41.     connect_timeout: 0.25s
  42.     type: STATIC
  43.     lb_policy: ROUND_ROBIN
  44.     http2_protocol_options: {}
  45.     upstream_connection_options:
  46.       # configure a TCP keep-alive to detect and reconnect to the admin
  47.       # server in the event of a TCP socket half open connection
  48.       tcp_keepalive: {}
  49.     load_assignment:
  50.       cluster_name: xds_cluster
  51.       endpoints:
  52.       - lb_endpoints:
  53.         - endpoint:
  54.             address:
  55.               socket_address:
  56.                 address: 127.0.0.1
  57.                 port_value: 5678

Notice above that xds_cluster is defined to point Envoy at the management server. Even in an otherwise completely dynamic configurations, some static resources need to be defined to point Envoy at its xDS management server(s).

It’s important to set appropriate TCP Keep-Alive options in the tcp_keepalive block. This will help detect TCP half open connections to the xDS management server and re-establish a full connection.

In the above example, the EDS management server could then return a proto encoding of a DiscoveryResponse:

  1. version_info: "0"
  2. resources:
  3. - "@type": type.googleapis.com/envoy.api.v2.ClusterLoadAssignment
  4.   cluster_name: some_service
  5.   endpoints:
  6.   - lb_endpoints:
  7.     - endpoint:
  8.         address:
  9.           socket_address:
  10.             address: 127.0.0.2
  11.             port_value: 1234

The versioning and type URL scheme that appear above are explained in more detail in the streaming gRPC subscription protocol documentation.

Dynamic

A fully dynamic bootstrap configuration, in which all resources other than those belonging to the management server are discovered via xDS is provided below:

  1. admin:
  2.   access_log_path: /tmp/admin_access.log
  3.   address:
  4.     socket_address: { address: 127.0.0.1, port_value: 9901 }
  6. dynamic_resources:
  7.   lds_config:
  8.     api_config_source:
  9.       api_type: GRPC
  10.       grpc_services:
  11.         envoy_grpc:
  12.           cluster_name: xds_cluster
  13.   cds_config:
  14.     api_config_source:
  15.       api_type: GRPC
  16.       grpc_services:
  17.         envoy_grpc:
  18.           cluster_name: xds_cluster
  20. static_resources:
  21.   clusters:
  22.   - name: xds_cluster
  23.     connect_timeout: 0.25s
  24.     type: STATIC
  25.     lb_policy: ROUND_ROBIN
  26.     http2_protocol_options: {}
  27.     upstream_connection_options:
  28.       # configure a TCP keep-alive to detect and reconnect to the admin
  29.       # server in the event of a TCP socket half open connection
  30.       tcp_keepalive: {}
  31.     load_assignment:
  32.       cluster_name: xds_cluster
  33.       endpoints:
  34.       - lb_endpoints:
  35.         - endpoint:
  36.             address:
  37.               socket_address:
  38.                 address: 127.0.0.1
  39.                 port_value: 5678

The management server could respond to LDS requests with:

  1. version_info: "0"
  2. resources:
  3. - "@type": type.googleapis.com/envoy.api.v2.Listener
  4.   name: listener_0
  5.   address:
  6.     socket_address:
  7.       address: 127.0.0.1
  8.       port_value: 10000
  9.   filter_chains:
  10.   - filters:
  11.     - name: envoy.http_connection_manager
  12.       typed_config:
  13.         "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
  14.         stat_prefix: ingress_http
  15.         codec_type: AUTO
  16.         rds:
  17.           route_config_name: local_route
  18.           config_source:
  19.             api_config_source:
  20.               api_type: GRPC
  21.               grpc_services:
  22.                 envoy_grpc:
  23.                   cluster_name: xds_cluster
  24.         http_filters:
  25.         - name: envoy.router

The management server could respond to RDS requests with:

  1. version_info: "0"
  2. resources:
  3. - "@type": type.googleapis.com/envoy.api.v2.RouteConfiguration
  4.   name: local_route
  5.   virtual_hosts:
  6.   - name: local_service
  7.     domains: ["*"]
  8.     routes:
  9.     - match: { prefix: "/" }
  10.       route: { cluster: some_service }

The management server could respond to CDS requests with:

  1. version_info: "0"
  2. resources:
  3. - "@type": type.googleapis.com/envoy.api.v2.Cluster
  4.   name: some_service
  5.   connect_timeout: 0.25s
  6.   lb_policy: ROUND_ROBIN
  7.   type: EDS
  8.   eds_cluster_config:
  9.     eds_config:
  10.       api_config_source:
  11.         api_type: GRPC
  12.         grpc_services:
  13.           envoy_grpc:
  14.             cluster_name: xds_cluster

The management server could respond to EDS requests with:

  1. version_info: "0"
  2. resources:
  3. - "@type": type.googleapis.com/envoy.api.v2.ClusterLoadAssignment
  4.   cluster_name: some_service
  5.   endpoints:
  6.   - lb_endpoints:
  7.     - endpoint:
  8.         address:
  9.           socket_address:
  10.             address: 127.0.0.2
  11.             port_value: 1234

Upgrading from v1 configuration

While new v2 bootstrap JSON/YAML can be written, it might be expedient to upgrade an existing v1 JSON/YAML configuration to v2. To do this (in an Envoy source tree), you can run:

  1. bazel run //tools:v1_to_bootstrap <path to v1 JSON/YAML configuration file>

Management server

A v2 xDS management server will implement the below endpoints as required for gRPC and/or REST serving. In both streaming gRPC and REST-JSON cases, a DiscoveryRequest is sent and a DiscoveryResponse received following the xDS protocol.

gRPC streaming endpoints

POST /envoy.api.v2.ClusterDiscoveryService/StreamClusters

See cds.proto for the service definition. This is used by Envoy as a client when

  1. cds_config:
  2.   api_config_source:
  3.     api_type: GRPC
  4.     grpc_services:
  5.       envoy_grpc:
  6.         cluster_name: some_xds_cluster

is set in the dynamic_resources of the Bootstrap config.

POST /envoy.api.v2.EndpointDiscoveryService/StreamEndpoints

See eds.proto for the service definition. This is used by Envoy as a client when

  1. eds_config:
  2.   api_config_source:
  3.     api_type: GRPC
  4.     grpc_services:
  5.       envoy_grpc:
  6.         cluster_name: some_xds_cluster

is set in the eds_cluster_config field of the Cluster config.

POST /envoy.api.v2.ListenerDiscoveryService/StreamListeners

See lds.proto for the service definition. This is used by Envoy as a client when

  1. lds_config:
  2.   api_config_source:
  3.     api_type: GRPC
  4.     grpc_services:
  5.       envoy_grpc:
  6.         cluster_name: some_xds_cluster

is set in the dynamic_resources of the Bootstrap config.

POST /envoy.api.v2.RouteDiscoveryService/StreamRoutes

See rds.proto for the service definition. This is used by Envoy as a client when

  1. route_config_name: some_route_name
  2. config_source:
  3.   api_config_source:
  4.     api_type: GRPC
  5.     grpc_services:
  6.       envoy_grpc:
  7.         cluster_name: some_xds_cluster

is set in the rds field of the HttpConnectionManager config.

REST endpoints

POST /v2/discovery:clusters

See cds.proto for the service definition. This is used by Envoy as a client when

  1. cds_config:
  2.   api_config_source:
  3.     api_type: REST
  4.     cluster_names: [some_xds_cluster]

is set in the dynamic_resources of the Bootstrap config.

POST /v2/discovery:endpoints

See eds.proto for the service definition. This is used by Envoy as a client when

  1. eds_config:
  2.   api_config_source:
  3.     api_type: REST
  4.     cluster_names: [some_xds_cluster]

is set in the eds_cluster_config field of the Cluster config.

POST /v2/discovery:listeners

See lds.proto for the service definition. This is used by Envoy as a client when

  1. lds_config:
  2.   api_config_source:
  3.     api_type: REST
  4.     cluster_names: [some_xds_cluster]

is set in the dynamic_resources of the Bootstrap config.

POST /v2/discovery:routes

See rds.proto for the service definition. This is used by Envoy as a client when

  1. route_config_name: some_route_name
  2. config_source:
  3.   api_config_source:
  4.     api_type: REST
  5.     cluster_names: [some_xds_cluster]

is set in the rds field of the HttpConnectionManager config.

Aggregated Discovery Service

While Envoy fundamentally employs an eventual consistency model, ADS provides an opportunity to sequence API update pushes and ensure affinity of a single management server for an Envoy node for API updates. ADS allows one or more APIs and their resources to be delivered on a single, bidirectional gRPC stream by the management server. Without this, some APIs such as RDS and EDS may require the management of multiple streams and connections to distinct management servers.

ADS will allow for hitless updates of configuration by appropriate sequencing. For example, suppose foo.com was mapped to cluster X. We wish to change the mapping in the route table to point foo.com at cluster Y. In order to do this, a CDS/EDS update must first be delivered containing both clusters X and Y.

Without ADS, the CDS/EDS/RDS streams may point at distinct management servers, or when on the same management server at distinct gRPC streams/connections that require coordination. The EDS resource requests may be split across two distinct streams, one for X and one for Y. ADS allows these to be coalesced to a single stream to a single management server, avoiding the need for distributed synchronization to correctly sequence the update. With ADS, the management server would deliver the CDS, EDS and then RDS updates on a single stream.

ADS is only available for gRPC streaming (not REST) and is described more fully in this document. The gRPC endpoint is:

POST /envoy.api.v2.AggregatedDiscoveryService/StreamAggregatedResources

See discovery.proto for the service definition. This is used by Envoy as a client when

  1. ads_config:
  2.   api_type: GRPC
  3.   grpc_services:
  4.     envoy_grpc:
  5.       cluster_name: some_ads_cluster

is set in the dynamic_resources of the Bootstrap config.

When this is set, any of the configuration sources above can be set to use the ADS channel. For example, a LDS config could be changed from

  1. lds_config:
  2.   api_config_source:
  3.     api_type: REST
  4.     cluster_names: [some_xds_cluster]

to

  1. lds_config: {ads: {}}

with the effect that the LDS stream will be directed to some_ads_cluster over the shared ADS channel.

Management Server Unreachability

When an Envoy instance loses connectivity with the management server, Envoy will latch on to the previous configuration while actively retrying in the background to reestablish the connection with the management server.

Envoy debug logs the fact that it is not able to establish a connection with the management server every time it attempts a connection.

connected_state statistic provides a signal for monitoring this behavior.

Statistics

Management Server has a statistics tree rooted at control_plane. with the following statistics:

NameTypeDescription
connected_stateGaugeA boolean (1 for connected and 0 for disconnected) that indicates the current connection state with management server
rate_limit_enforcedCounterTotal number of times rate limit was enforced for management server requests
pending_requestsGaugeTotal number of pending requests when the rate limit was enforced

Status

All features described in the v2 API reference are implemented unless otherwise noted. In the v2 API reference and the v2 API repository, all protos are frozen unless they are tagged as draft or experimental. Here, frozen means that we will not break wire format compatibility.

Frozen protos may be further extended, e.g. by adding new fields, in a manner that does not break backwards compatibility. Fields in the above protos may be later deprecated, subject to the breaking change policy, when their related functionality is no longer required. While frozen APIs have their wire format compatibility preserved, we reserve the right to change proto namespaces, file locations and nesting relationships, which may cause breaking code changes. We will aim to minimize the churn here.

Protos tagged draft, meaning that they are near finalized, are likely to be at least partially implemented in Envoy but may have wire format breaking changes made prior to freezing.

Protos tagged experimental, have the same caveats as draft protos and may have major changes made prior to Envoy implementation and freezing.

The current open v2 API issues are tracked here.