discovery.proto

Package : envoy.api.v2

Top

discovery.proto

Table of Contents

DeltaDiscoveryRequest

Field Type Label Description
node solo.io.envoy.api.v2.core.Node The node making the request.
typeUrl string Type of the resource that is being requested, e.g. “type.googleapis.com/envoy.api.v2.ClusterLoadAssignment”.
resourceNamesSubscribe []string repeated 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.
resourceNamesUnsubscribe []string repeated A list of Resource names to remove from the list of tracked resources.
initialResourceVersions []envoy.api.v2.DeltaDiscoveryRequest.InitialResourceVersionsEntry repeated 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.
responseNonce string 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.
errorDetail google.rpc.Status This is populated when the previous DiscoveryResponse (envoy_api_msg_DiscoveryResponse) failed to update configuration. The message field in error_details provides the Envoy internal exception related to the failure.

DeltaDiscoveryRequest.InitialResourceVersionsEntry

Field Type Label Description
key string
value string

DeltaDiscoveryResponse

Field Type Label Description
systemVersionInfo string The version of the response data (used for debugging).
resources []envoy.api.v2.Resource repeated The response resources. These are typed resources, whose types must match the type_url field.
typeUrl string 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.
removedResources []string repeated Resources names of resources that have be deleted and to be removed from the xDS Client. Removed resources for missing resources can be ignored.
nonce string The nonce provides a way for DeltaDiscoveryRequests to uniquely reference a DeltaDiscoveryResponse when (N)ACKing. The nonce is required.

DiscoveryRequest

Field Type Label Description
versionInfo string 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.
node solo.io.envoy.api.v2.core.Node The node making the request.
resourceNames []string repeated 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 may have empty resource_names, which will cause all resources for the Envoy instance to be returned. 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.
typeUrl string 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.
responseNonce string nonce corresponding to DiscoveryResponse being ACK/NACKed. See above discussion on version_info and the DiscoveryResponse nonce comment. This may be empty only if 1) this is a non-persistent-stream xDS such as HTTP, or 2) the client has not yet accepted an update in this xDS stream (unlike delta, where it is populated only for new explicit ACKs).
errorDetail google.rpc.Status This is populated when the previous 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.

DiscoveryResponse

Field Type Label Description
versionInfo string The version of the response data.
resources []google.protobuf.Any repeated The response resources. These resources are typed and depend on the API being called.
canary bool [#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.
typeUrl string Type URL for resources. Identifies the xDS API when muxing over ADS. Must be consistent with the type_url in the ‘resources’ repeated Any (if non-empty).
nonce string 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.
controlPlane solo.io.envoy.api.v2.core.ControlPlane [#not-implemented-hide:] The control plane instance that sent the response.

Resource

Field Type Label Description
name string The resource's name, to distinguish it from others of the same type of resource.
aliases []string repeated [#not-implemented-hide:] The aliases are a list of other names that this resource can go by.
version string The resource level version. It allows xDS to track the state of individual resources.
resource google.protobuf.Any The resource being tracked.