package envoy.service.discovery.v3
Get desktop application:
View/edit binary Protocol Buffers messages
Bi-directional streaming interface for messages. Subscribe, Ack, Push are represented as upstream messages. Monitor, Receipts, SubscribeResponse, AckResponse are represented as downstream messages. See https://github.com/lyft/envoy-api#apis for a description of the role of ADS and how it is intended to be used by a management server. ADS requests have the same structure as their singleton xDS counterparts, but can multiplex many resource types on a single stream. The type_url in the DiscoveryRequest/DiscoveryResponse provides sufficient information to recover the multiplexed singleton APIs at the Envoy instance and management server.
rpc StreamAggregatedResources (stream , stream )
xds.proto:281message
xds.proto:64Binary compatible with DiscoveryRequest, with payload extension
string version_info = 1
The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request. It is expected that no new request is sent after a response is received until the Envoy instance is ready to ACK/NACK the new configuration. ACK/NACK takes place by returning the new API config version as applied or the previous API config version respectively. Each type_url (see below) has an independent version associated with it.
optional node = 2
The node making the request.
repeated string resource_names = 3
List of resources to subscribe to, e.g. list of cluster names or a route configuration name. If this is empty, all resources for the API are returned. LDS/CDS expect empty resource_names, since this is global discovery for the Envoy instance. The LDS and CDS responses will then imply a number of resources that need to be fetched via EDS/RDS, which will be explicitly enumerated in resource_names.
string type_url = 4
Type of the resource that is being requested, e.g. "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment". This is implicit in requests made via singleton xDS APIs such as CDS, LDS, etc. but is required for ADS.
string response_nonce = 5
nonce corresponding to DiscoveryResponse being ACK/NACKed. See above discussion on version_info and the DiscoveryResponse nonce comment. This may be empty if no nonce is available, e.g. at startup or for non-stream xDS implementations.
optional error_detail = 6
This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration. The *message* field in *error_details* provides the Envoy internal exception related to the failure. It is only intended for consumption during manual debugging, the string provided is not guaranteed to be stable across Envoy versions. google.rpc.Status
message
xds.proto:105string version_info = 1
The version of the response data.
repeated resources = 2
The response resources. These resources are typed and depend on the API being called. google.protobuf.Any
bool canary = 3
[#not-implemented-hide:] Canary is used to support two Envoy command line flags: * --terminate-on-canary-transition-failure. When set, Envoy is able to terminate if it detects that configuration is stuck at canary. Consider this example sequence of updates: - Management server applies a canary config successfully. - Management server rolls back to a production config. - Envoy rejects the new production config. Since there is no sensible way to continue receiving configuration updates, Envoy will then terminate and apply production config from a clean slate. * --dry-run-canary. When set, a canary response will never be applied, only validated via a dry run.
string type_url = 4
Type URL for resources. This must be consistent with the type_url in the Any messages for resources if resources is non-empty. This effectively identifies the xDS API when muxing over ADS.
string nonce = 5
For gRPC based subscriptions, the nonce provides a way to explicitly ack a specific DiscoveryResponse in a following DiscoveryRequest. Additional messages may have been sent by Envoy to the management server for the previous version on the stream prior to this DiscoveryResponse, that were unprocessed at response send time. The nonce allows the management server to ignore any further DiscoveryRequests for the previous version until a DiscoveryRequest bearing the nonce. The nonce is optional and is not required for non-stream based xDS implementations.
rpc DeltaAggregatedResources (stream , stream )
xds.proto:282message
xds.proto:145optional node = 1
The node making the request.
string type_url = 2
Type of the resource that is being requested, e.g. ``type.googleapis.com/envoy.api.v2.ClusterLoadAssignment``. This does not need to be set if resources are only referenced via ``xds_resource_subscribe`` and ``xds_resources_unsubscribe``.
repeated string resource_names_subscribe = 3
DeltaDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream. All resource names in the resource_names_subscribe list are added to the set of tracked resources and all resource names in the resource_names_unsubscribe list are removed from the set of tracked resources. *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or resource_names_unsubscribe list simply means that no resources are to be added or removed to the resource list. *Like* state-of-the-world xDS, the server must send updates for all tracked resources, but can also send updates for resources the client has not subscribed to. NOTE: the server must respond with all resources listed in resource_names_subscribe, even if it believes the client has the most recent version of them. The reason: the client may have dropped them, but then regained interest before it had a chance to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd. These two fields can be set in any DeltaDiscoveryRequest, including ACKs and initial_resource_versions. A list of Resource names to add to the list of tracked resources.
repeated string resource_names_unsubscribe = 4
A list of Resource names to remove from the list of tracked resources.
map<string, string> initial_resource_versions = 5
Informs the server of the versions of the resources the xDS client knows of, to enable the client to continue the same logical xDS session even in the face of gRPC stream reconnection. It will not be populated: [1] in the very first stream of a session, since the client will not yet have any resources, [2] in any message after the first in a stream (for a given type_url), since the server will already be correctly tracking the client's state. (In ADS, the first message *of each type_url* of a reconnected stream populates this map.) The map's keys are names of xDS resources known to the xDS client. The map's values are opaque resource versions.
string response_nonce = 6
When the DeltaDiscoveryRequest is a ACK or NACK message in response to a previous DeltaDiscoveryResponse, the response_nonce must be the nonce in the DeltaDiscoveryResponse. Otherwise (unlike in DiscoveryRequest) response_nonce must be omitted.
optional error_detail = 7
This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration. The ``message`` field in ``error_details`` provides the Envoy internal exception related to the failure.
message
xds.proto:203string system_version_info = 1
The version of the response data (used for debugging).
repeated resources = 2
The response resources. These are typed resources, whose types must match the type_url field.
string type_url = 4
Type URL for resources. Identifies the xDS API when muxing over ADS. Must be consistent with the type_url in the Any within 'resources' if 'resources' is non-empty.
repeated string removed_resources = 6
Resources names of resources that have be deleted and to be removed from the xDS Client. Removed resources for missing resources can be ignored.
string nonce = 5
The nonce provides a way for DeltaDiscoveryRequests to uniquely reference a DeltaDiscoveryResponse when (N)ACKing. The nonce is required.
message
xds.proto:29Used in: ,
string id = 1
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: :ref:`statsd <arch_overview_statistics>`, :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing <arch_overview_tracing>`, either in this message or via :option:`--service-node`.
string cluster = 2
Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: :ref:`statsd <arch_overview_statistics>`, :ref:`health check cluster verification <config_cluster_manager_cluster_hc_service_name>`, :ref:`runtime override directory <config_runtime_override_subdirectory>`, :ref:`user agent addition <config_http_conn_man_add_user_agent>`, :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`, :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing <arch_overview_tracing>`, either in this message or via :option:`--service-cluster`.
optional metadata = 3
Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.
string build_version = 5
This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet. This will be set by Envoy in management server RPCs.
message
xds.proto:226Used in:
string name = 3
The resource's name, to distinguish it from others of the same type of resource.
repeated string aliases = 4
The aliases are a list of other names that this resource can go by.
string version = 1
The resource level version. It allows xDS to track the state of individual resources.
optional resource = 2
The resource being tracked.
optional ttl = 6
Time-to-live value for the resource. For each resource, a timer is started. The timer is reset each time the resource is received with a new TTL. If the resource is received with no TTL set, the timer is removed for the resource. Upon expiration of the timer, the configuration for the resource will be removed. The TTL can be refreshed or changed by sending a response that doesn't change the resource version. In this case the resource field does not need to be populated, which allows for light-weight "heartbeat" updates to keep a resource with a TTL alive. The TTL feature is meant to support configurations that should be removed in the event of a management server failure. For example, the feature may be used for fault injection testing where the fault injection should be terminated in the event that Envoy loses contact with the management server.
optional cache_control = 7
Cache control properties for the resource. [#not-implemented-hide:]
message
xds.proto:229Cache control properties for the resource. [#not-implemented-hide:]
Used in:
bool do_not_cache = 1
If true, xDS proxies may not cache this resource. Note that this does not apply to clients other than xDS proxies, which must cache resources for their own use, regardless of the value of this field.
message
xds.proto:13Used in: ,
int32 code = 1
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
string message = 2
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
repeated details = 3
A list of messages that carry the error details. There is a common set of message types for APIs to use. google.protobuf.Any