Common discovery API components (proto)

service.discovery.v3.ResourceLocator

[service.discovery.v3.ResourceLocator proto]

Specifies a resource to be subscribed to.

{
  "name": ...,
  "dynamic_parameters": {...}
}

name: (string) The resource name to subscribe to.

dynamic_parameters: (repeated map<string, string>) A set of dynamic parameters used to match against the dynamic parameter constraints on the resource. This allows clients to select between multiple variants of the same resource.

service.discovery.v3.ResourceName

[service.discovery.v3.ResourceName proto]

Specifies a concrete resource name.

{
  "name": ...,
  "dynamic_parameter_constraints": {...}
}

name: (string) The name of the resource.

dynamic_parameter_constraints: (service.discovery.v3.DynamicParameterConstraints) Dynamic parameter constraints associated with this resource. To be used by client-side caches (including xDS proxies) when matching subscribed resource locators.

service.discovery.v3.DiscoveryRequest

[service.discovery.v3.DiscoveryRequest proto]

A DiscoveryRequest requests a set of versioned resources of the same type for a given Envoy node on some API.

{
  "version_info": ...,
  "node": {...},
  "resource_names": [],
  "type_url": ...,
  "response_nonce": ...,
  "error_detail": {...}
}

version_info: (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: (config.core.v3.Node) The node making the request.

resource_names: (repeated string) 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.

type_url: (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.

response_nonce: (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).

error_detail: (Status) This is populated when the previous 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.

service.discovery.v3.DiscoveryResponse

[service.discovery.v3.DiscoveryResponse proto]

{
  "version_info": ...,
  "resources": [],
  "type_url": ...,
  "nonce": ...,
  "control_plane": {...}
}

version_info: (string) The version of the response data.

resources: (repeated Any) The response resources. These resources are typed and depend on the API being called.

type_url: (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.

control_plane: (config.core.v3.ControlPlane) The control plane instance that sent the response.

service.discovery.v3.DeltaDiscoveryRequest

[service.discovery.v3.DeltaDiscoveryRequest proto]

DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC endpoint for Delta xDS.

With Delta xDS, the DeltaDiscoveryResponses do not need to include a full snapshot of the tracked resources. Instead, DeltaDiscoveryResponses are a diff to the state of a xDS client. In Delta XDS there are per-resource versions, which allow tracking state at the resource granularity. An xDS Delta session is always in the context of a gRPC bidirectional stream. This allows the xDS server to keep track of the state of xDS clients connected to it.

In Delta xDS the nonce field is required and used to pair DeltaDiscoveryResponse to a DeltaDiscoveryRequest ACK or NACK. Optionally, a response message level system_version_info is present for debugging purposes only.

DeltaDiscoveryRequest plays two independent roles. Any DeltaDiscoveryRequest can be either or both of: [1] informing the server of what resources the client has gained/lost interest in (using resource_names_subscribe and resource_names_unsubscribe), or [2] (N)ACKing an earlier resource update from the server (using response_nonce, with presence of error_detail making it a NACK). Additionally, the first message (for a given type_url) of a reconnected gRPC stream has a third role: informing the server of the resources (and their versions) that the client already possesses, using the initial_resource_versions field.

As with state-of-the-world, when multiple resource types are multiplexed (ADS), all requests/acknowledgments/updates are logically walled off by type_url: a Cluster ACK exists in a completely separate world from a prior Route NACK. In particular, initial_resource_versions being sent at the “start” of every gRPC stream actually entails a message for each type_url, each with its own initial_resource_versions.

{
  "node": {...},
  "type_url": ...,
  "resource_names_subscribe": [],
  "resource_names_unsubscribe": [],
  "initial_resource_versions": {...},
  "response_nonce": ...,
  "error_detail": {...}
}

node: (config.core.v3.Node) The node making the request.

type_url: (string) 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.

resource_names_unsubscribe: (repeated string) A list of Resource names to remove from the list of tracked resources.

initial_resource_versions: (repeated map<string, string>) 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.

response_nonce: (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.

error_detail: (Status) This is populated when the previous DiscoveryResponse failed to update configuration. The message field in error_details provides the Envoy internal exception related to the failure.

service.discovery.v3.DeltaDiscoveryResponse

[service.discovery.v3.DeltaDiscoveryResponse proto]

{
  "system_version_info": ...,
  "resources": [],
  "type_url": ...,
  "removed_resources": [],
  "removed_resource_names": [],
  "nonce": ...
}

system_version_info: (string) The version of the response data (used for debugging).

resources: (repeated service.discovery.v3.Resource) The response resources. These are typed resources, whose types must match the type_url field.

type_url: (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.

removed_resources: (repeated string) Resources names of resources that have be deleted and to be removed from the xDS Client. Removed resources for missing resources can be ignored.

removed_resource_names: (repeated service.discovery.v3.ResourceName) Alternative to removed_resources that allows specifying which variant of a resource is being removed. This variant must be used for any resource for which dynamic parameter constraints were sent to the client.

nonce: (string) The nonce provides a way for DeltaDiscoveryRequests to uniquely reference a DeltaDiscoveryResponse when (N)ACKing. The nonce is required.

service.discovery.v3.DynamicParameterConstraints

[service.discovery.v3.DynamicParameterConstraints proto]

A set of dynamic parameter constraints associated with a variant of an individual xDS resource. These constraints determine whether the resource matches a subscription based on the set of dynamic parameters in the subscription, as specified in the ResourceLocator.dynamic_parameters field. This allows xDS implementations (clients, servers, and caching proxies) to determine which variant of a resource is appropriate for a given client.

{
  "constraint": {...},
  "or_constraints": {...},
  "and_constraints": {...},
  "not_constraints": {...}
}

constraint

(service.discovery.v3.DynamicParameterConstraints.SingleConstraint) A single constraint to evaluate.

Only one of constraint, or_constraints, and_constraints, not_constraints may be set.

or_constraints

(service.discovery.v3.DynamicParameterConstraints.ConstraintList) A list of constraints that match if any one constraint in the list matches.

Only one of constraint, or_constraints, and_constraints, not_constraints may be set.

and_constraints

(service.discovery.v3.DynamicParameterConstraints.ConstraintList) A list of constraints that must all match.

Only one of constraint, or_constraints, and_constraints, not_constraints may be set.

not_constraints

(service.discovery.v3.DynamicParameterConstraints) The inverse (NOT) of a set of constraints.

Only one of constraint, or_constraints, and_constraints, not_constraints may be set.

service.discovery.v3.DynamicParameterConstraints.SingleConstraint

[service.discovery.v3.DynamicParameterConstraints.SingleConstraint proto]

A single constraint for a given key.

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

key: (string) The key to match against.

value

(string) Matches this exact value.

Precisely one of value, exists must be set.

exists

(service.discovery.v3.DynamicParameterConstraints.SingleConstraint.Exists) Key is present (matches any value except for the key being absent). This allows setting a default constraint for clients that do not send a key at all, while there may be other clients that need special configuration based on that key.

Precisely one of value, exists must be set.

service.discovery.v3.DynamicParameterConstraints.SingleConstraint.Exists

[service.discovery.v3.DynamicParameterConstraints.SingleConstraint.Exists proto]

service.discovery.v3.DynamicParameterConstraints.ConstraintList

[service.discovery.v3.DynamicParameterConstraints.ConstraintList proto]

{
  "constraints": []
}

constraints: (repeated service.discovery.v3.DynamicParameterConstraints)

service.discovery.v3.Resource

[service.discovery.v3.Resource proto]

{
  "name": ...,
  "resource_name": {...},
  "aliases": [],
  "version": ...,
  "resource": {...},
  "ttl": {...},
  "metadata": {...}
}

name: (string) The resource’s name, to distinguish it from others of the same type of resource. Only one of name or resource_name may be set.

resource_name: (service.discovery.v3.ResourceName) Alternative to the name field, to be used when the server supports multiple variants of the named resource that are differentiated by dynamic parameter constraints. Only one of name or resource_name may be set.

aliases: (repeated string) 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: (Any) The resource being tracked.

ttl

(Duration) 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.

metadata: (config.core.v3.Metadata) The Metadata field can be used to provide additional information for the resource. E.g. the trace data for debugging.