我的书签
添加书签
移除书签Client Status Discovery Service (CSDS)
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:
[service.status.v3.ClientStatusRequest proto]
Request for client status of clients identified by a list of NodeMatchers.
node_matchers
(repeated ) Management server can use these match criteria to identify clients. The match follows OR semantics.
node
(config.core.v3.Node) The node making the csds request.
service.status.v3.PerXdsConfig
[service.status.v3.PerXdsConfig proto]
Detailed config (per xDS) with status.
status
() Config status generated by management servers. Will not be present if the CSDS server is an xDS client.
client_status
(service.status.v3.ClientConfigStatus) Client config status is populated by xDS clients. Will not be present if the CSDS server is an xDS server. No matter what the client config status is, xDS clients should always dump the most recent accepted xDS config.
Attention
This field is deprecated. Use for per-resource config status instead.
listener_config
(admin.v3.ListenersConfigDump)
Only one of , cluster_config, , scoped_route_config, may be set.
cluster_config
Only one of , cluster_config, , scoped_route_config, may be set.
route_config
Only one of , cluster_config, , scoped_route_config, may be set.
scoped_route_config
Only one of listener_config, , route_config, , endpoint_config may be set.
endpoint_config
()
Only one of listener_config, , route_config, , endpoint_config may be set.
All xds configs for a particular client.
node
(config.core.v3.Node) Node for a particular client.
xds_config
(repeated ) This field is deprecated in favor of generic_xds_configs which is much simpler and uniform in structure.
generic_xds_configs
(repeated service.status.v3.ClientConfig.GenericXdsConfig) Represents generic xDS config and the exact config structure depends on the type URL (like Cluster if it is CDS)
service.status.v3.ClientConfig.GenericXdsConfig
[service.status.v3.ClientConfig.GenericXdsConfig proto]
GenericXdsConfig is used to specify the config status and the dump of any xDS resource identified by their type URL. It is the generalized version of the now deprecated ListenersConfigDump, ClustersConfigDump etc
type_url
() Type_url represents the fully qualified name of xDS resource type like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc.
name
(string) Name of the xDS resource
version_info
() This is the version_info in the last processed xDS discovery response. If there are only static bootstrap listeners, this field will be “”
xds_config
() The xDS resource config. Actual content depends on the type
last_updated
(Timestamp) Timestamp when the xDS resource was last updated
config_status
() Per xDS resource config status. It is generated by management servers. It will not be present if the CSDS server is an xDS client.
client_status
is_static_resource
(bool) Is static resource is true if it is specified in the config supplied through the file at the startup.
config
(repeated service.status.v3.ClientConfig) Client configs for the clients specified in the ClientStatusRequest.
Enum service.status.v3.ConfigStatus
[service.status.v3.ConfigStatus proto]
Status of a config from a management server view.
UNKNOWN
(DEFAULT) Status info is not available/unknown.
SYNCED
Management server has sent the config to client and received ACK.
NOT_SENT
Config is not sent.
STALE
Management server has sent the config to client but hasn’t received ACK/NACK.
ERROR
Management server has sent the config to client but received NACK. The attached config dump will be the latest config (the rejected one), since it is the persisted version in the management server.
Config status from a client-side view.
CLIENT_UNKNOWN
(DEFAULT) Config status is not available/unknown.
CLIENT_REQUESTED
Client requested the config but hasn’t received any config from management server yet.
CLIENT_ACKED
Client received the config and replied with ACK.
CLIENT_NACKED
Client received the config and replied with NACK. Notably, the attached config dump is not the NACKed version, but the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.
