@@ -17,6 +17,31 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
1717
1818// [#protodoc-title: ConfigDump]
1919
20+ // Resource status from the view of a xDS client, which tells the synchronization
21+ // status between the xDS client and the xDS server.
22+ enum ClientResourceStatus {
23+ // Resource status is not available/unknown.
24+ UNKNOWN = 0 ;
25+
26+ // Client requested this resource but hasn't received any update from management
27+ // server. The client will not fail requests, but will queue them until update
28+ // arrives or the client times out waiting for the resource.
29+ REQUESTED = 1 ;
30+
31+ // This resource has been requested by the client but has either not been
32+ // delivered by the server or was previously delivered by the server and then
33+ // subsequently removed from resources provided by the server. For more
34+ // information, please refer to the :ref:`"Knowing When a Requested Resource
35+ // Does Not Exist" <xds_protocol_resource_not_existed>` section.
36+ DOES_NOT_EXIST = 2 ;
37+
38+ // Client received this resource and replied with ACK.
39+ ACKED = 3 ;
40+
41+ // Client received this resource and replied with NACK.
42+ NACKED = 4 ;
43+ }
44+
2045// The :ref:`/config_dump <operations_admin_interface_config_dump>` admin endpoint uses this wrapper
2146// message to maintain and serve arbitrary configuration information from any component in Envoy.
2247message ConfigDump {
@@ -114,7 +139,7 @@ message ListenersConfigDump {
114139 }
115140
116141 // Describes a dynamically loaded listener via the LDS API.
117- // [#next-free-field: 6 ]
142+ // [#next-free-field: 7 ]
118143 message DynamicListener {
119144 option (udpa.annotations.versioning ).previous_message_type =
120145 "envoy.admin.v2alpha.ListenersConfigDump.DynamicListener" ;
@@ -143,6 +168,10 @@ message ListenersConfigDump {
143168 // resource along with the reason and timestamp. For successfully updated or
144169 // acknowledged resource, this field should be empty.
145170 UpdateFailureState error_state = 5 ;
171+
172+ // The client status of this resource.
173+ // [#not-implemented-hide:]
174+ ClientResourceStatus client_status = 6 ;
146175 }
147176
148177 // This is the :ref:`version_info <envoy_api_field_service.discovery.v3.DiscoveryResponse.version_info>` in the
@@ -177,6 +206,7 @@ message ClustersConfigDump {
177206 }
178207
179208 // Describes a dynamically loaded cluster via the CDS API.
209+ // [#next-free-field: 6]
180210 message DynamicCluster {
181211 option (udpa.annotations.versioning ).previous_message_type =
182212 "envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster" ;
@@ -199,6 +229,10 @@ message ClustersConfigDump {
199229 // acknowledged resource, this field should be empty.
200230 // [#not-implemented-hide:]
201231 UpdateFailureState error_state = 4 ;
232+
233+ // The client status of this resource.
234+ // [#not-implemented-hide:]
235+ ClientResourceStatus client_status = 5 ;
202236 }
203237
204238 // This is the :ref:`version_info <envoy_api_field_service.discovery.v3.DiscoveryResponse.version_info>` in the
@@ -240,6 +274,7 @@ message RoutesConfigDump {
240274 google.protobuf.Timestamp last_updated = 2 ;
241275 }
242276
277+ // [#next-free-field: 6]
243278 message DynamicRouteConfig {
244279 option (udpa.annotations.versioning ).previous_message_type =
245280 "envoy.admin.v2alpha.RoutesConfigDump.DynamicRouteConfig" ;
@@ -261,6 +296,10 @@ message RoutesConfigDump {
261296 // acknowledged resource, this field should be empty.
262297 // [#not-implemented-hide:]
263298 UpdateFailureState error_state = 4 ;
299+
300+ // The client status of this resource.
301+ // [#not-implemented-hide:]
302+ ClientResourceStatus client_status = 5 ;
264303 }
265304
266305 // The statically loaded route configs.
@@ -292,7 +331,7 @@ message ScopedRoutesConfigDump {
292331 google.protobuf.Timestamp last_updated = 3 ;
293332 }
294333
295- // [#next-free-field: 6 ]
334+ // [#next-free-field: 7 ]
296335 message DynamicScopedRouteConfigs {
297336 option (udpa.annotations.versioning ).previous_message_type =
298337 "envoy.admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs" ;
@@ -317,6 +356,10 @@ message ScopedRoutesConfigDump {
317356 // acknowledged resource, this field should be empty.
318357 // [#not-implemented-hide:]
319358 UpdateFailureState error_state = 5 ;
359+
360+ // The client status of this resource.
361+ // [#not-implemented-hide:]
362+ ClientResourceStatus client_status = 6 ;
320363 }
321364
322365 // The statically loaded scoped route configs.
@@ -332,7 +375,7 @@ message SecretsConfigDump {
332375 "envoy.admin.v2alpha.SecretsConfigDump" ;
333376
334377 // DynamicSecret contains secret information fetched via SDS.
335- // [#next-free-field: 6 ]
378+ // [#next-free-field: 7 ]
336379 message DynamicSecret {
337380 option (udpa.annotations.versioning ).previous_message_type =
338381 "envoy.admin.v2alpha.SecretsConfigDump.DynamicSecret" ;
@@ -357,6 +400,10 @@ message SecretsConfigDump {
357400 // acknowledged resource, this field should be empty.
358401 // [#not-implemented-hide:]
359402 UpdateFailureState error_state = 5 ;
403+
404+ // The client status of this resource.
405+ // [#not-implemented-hide:]
406+ ClientResourceStatus client_status = 6 ;
360407 }
361408
362409 // StaticSecret specifies statically loaded secret in bootstrap.
@@ -400,6 +447,7 @@ message EndpointsConfigDump {
400447 google.protobuf.Timestamp last_updated = 2 ;
401448 }
402449
450+ // [#next-free-field: 6]
403451 message DynamicEndpointConfig {
404452 // [#not-implemented-hide:] This is the per-resource version information. This version is currently taken from the
405453 // :ref:`version_info <envoy_api_field_service.discovery.v3.DiscoveryResponse.version_info>` field at the time that
@@ -418,6 +466,10 @@ message EndpointsConfigDump {
418466 // acknowledged resource, this field should be empty.
419467 // [#not-implemented-hide:]
420468 UpdateFailureState error_state = 4 ;
469+
470+ // The client status of this resource.
471+ // [#not-implemented-hide:]
472+ ClientResourceStatus client_status = 5 ;
421473 }
422474
423475 // The statically loaded endpoint configs.
0 commit comments