From 484fcd76bdc790237d26e8a67dcf7d2c0750aa70 Mon Sep 17 00:00:00 2001 From: su225 Date: Tue, 30 Mar 2021 13:43:18 +0530 Subject: [PATCH 1/8] [envoy-15622] add generic XDS protobuf definitions for v3 API (without docs yet) Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 46 ++++++++++++++++- api/envoy/service/status/v4alpha/csds.proto | 48 +++++++++++++++++- .../envoy/service/status/v3/csds.proto | 46 ++++++++++++++++- .../envoy/service/status/v4alpha/csds.proto | 49 ++++++++++++++++++- 4 files changed, 185 insertions(+), 4 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 3a1c748fc81b..e4704b7e71cd 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -7,6 +7,8 @@ import "envoy/config/core/v3/base.proto"; import "envoy/type/matcher/v3/node.proto"; import "google/api/annotations.proto"; +import "google/protobuf/any.proto"; +import "google/protobuf/timestamp.proto"; import "envoy/annotations/deprecation.proto"; import "udpa/annotations/status.proto"; @@ -124,10 +126,52 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v2.ClientConfig"; + // GenericXdsConfig is a simpler and generic version of specifying + // XDS config status and the dump. + // [#next-free-field: 9] + message GenericXdsConfig { + // type_url represents the fully qualified name of xDS resource type + // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. + string type_url = 1; + + // name of the xDS resource + string name = 2; + + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // field will be "" + string version_info = 3; + + // The xDS resource config. Actual content depends on the type + google.protobuf.Any xds_config = 4; + + // Timestamp when the xDS resource was last updated + google.protobuf.Timestamp last_updated = 5; + + // Per xDS resource config status. It is generated by management servers. + // It will not be present if the CSDS server is an xDS client. + ConfigStatus config_status = 6; + + // Per xDS resource status from the view of a xDS client + admin.v3.ClientResourceStatus client_status = 7; + + // Set if the last update failed, cleared after the next successful update. + // The *error_state* field contains the rejected version of this particular + // resource along with the reason and timestamp. For successfully updated or + // acknowledged resource, this field should be empty. + // [#not-implemented-hide:] + admin.v3.UpdateFailureState error_state = 8; + } + // Node for a particular client. config.core.v3.Node node = 1; - repeated PerXdsConfig xds_config = 2; + // This field is deprecated in favor of generic_xds_configs which is + // much simpler and uniform in structure. + repeated PerXdsConfig xds_config = 2 + [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; + + repeated GenericXdsConfig generic_xds_configs = 3; } message ClientStatusResponse { diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index b8720330e9b7..000160209b04 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -7,6 +7,8 @@ import "envoy/config/core/v4alpha/base.proto"; import "envoy/type/matcher/v4alpha/node.proto"; import "google/api/annotations.proto"; +import "google/protobuf/any.proto"; +import "google/protobuf/timestamp.proto"; import "udpa/annotations/status.proto"; import "udpa/annotations/versioning.proto"; @@ -116,10 +118,54 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v3.ClientConfig"; + // GenericXdsConfig is a simpler and generic version of specifying + // XDS config status and the dump. + // [#next-free-field: 9] + message GenericXdsConfig { + option (udpa.annotations.versioning).previous_message_type = + "envoy.service.status.v3.ClientConfig.GenericXdsConfig"; + + // type_url represents the fully qualified name of xDS resource type + // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. + string type_url = 1; + + // name of the xDS resource + string name = 2; + + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // field will be "" + string version_info = 3; + + // The xDS resource config. Actual content depends on the type + google.protobuf.Any xds_config = 4; + + // Timestamp when the xDS resource was last updated + google.protobuf.Timestamp last_updated = 5; + + // Per xDS resource config status. It is generated by management servers. + // It will not be present if the CSDS server is an xDS client. + ConfigStatus config_status = 6; + + // Per xDS resource status from the view of a xDS client + admin.v4alpha.ClientResourceStatus client_status = 7; + + // Set if the last update failed, cleared after the next successful update. + // The *error_state* field contains the rejected version of this particular + // resource along with the reason and timestamp. For successfully updated or + // acknowledged resource, this field should be empty. + // [#not-implemented-hide:] + admin.v4alpha.UpdateFailureState error_state = 8; + } + + reserved 2; + + reserved "xds_config"; + // Node for a particular client. config.core.v4alpha.Node node = 1; - repeated PerXdsConfig xds_config = 2; + repeated GenericXdsConfig generic_xds_configs = 3; } message ClientStatusResponse { diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index 3a1c748fc81b..e4704b7e71cd 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -7,6 +7,8 @@ import "envoy/config/core/v3/base.proto"; import "envoy/type/matcher/v3/node.proto"; import "google/api/annotations.proto"; +import "google/protobuf/any.proto"; +import "google/protobuf/timestamp.proto"; import "envoy/annotations/deprecation.proto"; import "udpa/annotations/status.proto"; @@ -124,10 +126,52 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v2.ClientConfig"; + // GenericXdsConfig is a simpler and generic version of specifying + // XDS config status and the dump. + // [#next-free-field: 9] + message GenericXdsConfig { + // type_url represents the fully qualified name of xDS resource type + // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. + string type_url = 1; + + // name of the xDS resource + string name = 2; + + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // field will be "" + string version_info = 3; + + // The xDS resource config. Actual content depends on the type + google.protobuf.Any xds_config = 4; + + // Timestamp when the xDS resource was last updated + google.protobuf.Timestamp last_updated = 5; + + // Per xDS resource config status. It is generated by management servers. + // It will not be present if the CSDS server is an xDS client. + ConfigStatus config_status = 6; + + // Per xDS resource status from the view of a xDS client + admin.v3.ClientResourceStatus client_status = 7; + + // Set if the last update failed, cleared after the next successful update. + // The *error_state* field contains the rejected version of this particular + // resource along with the reason and timestamp. For successfully updated or + // acknowledged resource, this field should be empty. + // [#not-implemented-hide:] + admin.v3.UpdateFailureState error_state = 8; + } + // Node for a particular client. config.core.v3.Node node = 1; - repeated PerXdsConfig xds_config = 2; + // This field is deprecated in favor of generic_xds_configs which is + // much simpler and uniform in structure. + repeated PerXdsConfig xds_config = 2 + [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; + + repeated GenericXdsConfig generic_xds_configs = 3; } message ClientStatusResponse { diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index 751e06b645ce..55ae09f34578 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -7,6 +7,8 @@ import "envoy/config/core/v4alpha/base.proto"; import "envoy/type/matcher/v4alpha/node.proto"; import "google/api/annotations.proto"; +import "google/protobuf/any.proto"; +import "google/protobuf/timestamp.proto"; import "envoy/annotations/deprecation.proto"; import "udpa/annotations/status.proto"; @@ -124,10 +126,55 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v3.ClientConfig"; + // GenericXdsConfig is a simpler and generic version of specifying + // XDS config status and the dump. + // [#next-free-field: 9] + message GenericXdsConfig { + option (udpa.annotations.versioning).previous_message_type = + "envoy.service.status.v3.ClientConfig.GenericXdsConfig"; + + // type_url represents the fully qualified name of xDS resource type + // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. + string type_url = 1; + + // name of the xDS resource + string name = 2; + + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // field will be "" + string version_info = 3; + + // The xDS resource config. Actual content depends on the type + google.protobuf.Any xds_config = 4; + + // Timestamp when the xDS resource was last updated + google.protobuf.Timestamp last_updated = 5; + + // Per xDS resource config status. It is generated by management servers. + // It will not be present if the CSDS server is an xDS client. + ConfigStatus config_status = 6; + + // Per xDS resource status from the view of a xDS client + admin.v4alpha.ClientResourceStatus client_status = 7; + + // Set if the last update failed, cleared after the next successful update. + // The *error_state* field contains the rejected version of this particular + // resource along with the reason and timestamp. For successfully updated or + // acknowledged resource, this field should be empty. + // [#not-implemented-hide:] + admin.v4alpha.UpdateFailureState error_state = 8; + } + // Node for a particular client. config.core.v4alpha.Node node = 1; - repeated PerXdsConfig xds_config = 2; + // This field is deprecated in favor of generic_xds_configs which is + // much simpler and uniform in structure. + repeated PerXdsConfig hidden_envoy_deprecated_xds_config = 2 + [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; + + repeated GenericXdsConfig generic_xds_configs = 3; } message ClientStatusResponse { From 7097451c44a192d5452a3fbf6e31fc88a94819ce Mon Sep 17 00:00:00 2001 From: su225 Date: Wed, 19 May 2021 14:08:51 +0530 Subject: [PATCH 2/8] [envoy-15622] add description for generic_xds_configs field Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 2 ++ api/envoy/service/status/v4alpha/csds.proto | 2 ++ generated_api_shadow/envoy/service/status/v3/csds.proto | 2 ++ generated_api_shadow/envoy/service/status/v4alpha/csds.proto | 2 ++ 4 files changed, 8 insertions(+) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index e4704b7e71cd..40da3c4c35d8 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -171,6 +171,8 @@ message ClientConfig { repeated PerXdsConfig xds_config = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; + // Represents generic xDS config and the exact config structure depends on + // the type URL (like Cluster if it is CDS) repeated GenericXdsConfig generic_xds_configs = 3; } diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index 000160209b04..15391b99e60c 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -165,6 +165,8 @@ message ClientConfig { // Node for a particular client. config.core.v4alpha.Node node = 1; + // Represents generic xDS config and the exact config structure depends on + // the type URL (like Cluster if it is CDS) repeated GenericXdsConfig generic_xds_configs = 3; } diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index e4704b7e71cd..40da3c4c35d8 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -171,6 +171,8 @@ message ClientConfig { repeated PerXdsConfig xds_config = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; + // Represents generic xDS config and the exact config structure depends on + // the type URL (like Cluster if it is CDS) repeated GenericXdsConfig generic_xds_configs = 3; } diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index 55ae09f34578..3f793657013c 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -174,6 +174,8 @@ message ClientConfig { repeated PerXdsConfig hidden_envoy_deprecated_xds_config = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; + // Represents generic xDS config and the exact config structure depends on + // the type URL (like Cluster if it is CDS) repeated GenericXdsConfig generic_xds_configs = 3; } From 972f19c1f9f6bfcbbbc3c872aa2b28287dd2f910 Mon Sep 17 00:00:00 2001 From: su225 Date: Mon, 24 May 2021 13:03:14 +0530 Subject: [PATCH 3/8] add is_static_resource flag from code review comment Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 24 ++++++++++++------- api/envoy/service/status/v4alpha/csds.proto | 24 ++++++++++++------- .../envoy/service/status/v3/csds.proto | 24 ++++++++++++------- .../envoy/service/status/v4alpha/csds.proto | 24 ++++++++++++------- 4 files changed, 60 insertions(+), 36 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 40da3c4c35d8..229f7a65be90 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -128,17 +128,18 @@ message ClientConfig { // GenericXdsConfig is a simpler and generic version of specifying // XDS config status and the dump. - // [#next-free-field: 9] + // [#next-free-field: 10] message GenericXdsConfig { - // type_url represents the fully qualified name of xDS resource type + // Type_url represents the fully qualified name of xDS resource type // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. string type_url = 1; - // name of the xDS resource + // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` - // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // This is the :ref:`version_info ` in the last processed xDS discovery + // response. If there are only static bootstrap listeners, this // field will be "" string version_info = 3; @@ -155,12 +156,17 @@ message ClientConfig { // Per xDS resource status from the view of a xDS client admin.v3.ClientResourceStatus client_status = 7; - // Set if the last update failed, cleared after the next successful update. - // The *error_state* field contains the rejected version of this particular - // resource along with the reason and timestamp. For successfully updated or - // acknowledged resource, this field should be empty. + // Set if the last update failed, cleared after the next successful + // update. The *error_state* field contains the rejected version of + // this particular resource along with the reason and timestamp. For + // successfully updated or acknowledged resource, this field should + // be empty. // [#not-implemented-hide:] admin.v3.UpdateFailureState error_state = 8; + + // Is static resource is true if it is specified in the envoy config + // supplied during the start. + bool is_static_resource = 9; } // Node for a particular client. diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index 15391b99e60c..14c8f4ad9d1c 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -120,20 +120,21 @@ message ClientConfig { // GenericXdsConfig is a simpler and generic version of specifying // XDS config status and the dump. - // [#next-free-field: 9] + // [#next-free-field: 10] message GenericXdsConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v3.ClientConfig.GenericXdsConfig"; - // type_url represents the fully qualified name of xDS resource type + // Type_url represents the fully qualified name of xDS resource type // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. string type_url = 1; - // name of the xDS resource + // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` - // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // This is the :ref:`version_info ` in the last processed xDS discovery + // response. If there are only static bootstrap listeners, this // field will be "" string version_info = 3; @@ -150,12 +151,17 @@ message ClientConfig { // Per xDS resource status from the view of a xDS client admin.v4alpha.ClientResourceStatus client_status = 7; - // Set if the last update failed, cleared after the next successful update. - // The *error_state* field contains the rejected version of this particular - // resource along with the reason and timestamp. For successfully updated or - // acknowledged resource, this field should be empty. + // Set if the last update failed, cleared after the next successful + // update. The *error_state* field contains the rejected version of + // this particular resource along with the reason and timestamp. For + // successfully updated or acknowledged resource, this field should + // be empty. // [#not-implemented-hide:] admin.v4alpha.UpdateFailureState error_state = 8; + + // Is static resource is true if it is specified in the envoy config + // supplied during the start. + bool is_static_resource = 9; } reserved 2; diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index 40da3c4c35d8..229f7a65be90 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -128,17 +128,18 @@ message ClientConfig { // GenericXdsConfig is a simpler and generic version of specifying // XDS config status and the dump. - // [#next-free-field: 9] + // [#next-free-field: 10] message GenericXdsConfig { - // type_url represents the fully qualified name of xDS resource type + // Type_url represents the fully qualified name of xDS resource type // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. string type_url = 1; - // name of the xDS resource + // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` - // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // This is the :ref:`version_info ` in the last processed xDS discovery + // response. If there are only static bootstrap listeners, this // field will be "" string version_info = 3; @@ -155,12 +156,17 @@ message ClientConfig { // Per xDS resource status from the view of a xDS client admin.v3.ClientResourceStatus client_status = 7; - // Set if the last update failed, cleared after the next successful update. - // The *error_state* field contains the rejected version of this particular - // resource along with the reason and timestamp. For successfully updated or - // acknowledged resource, this field should be empty. + // Set if the last update failed, cleared after the next successful + // update. The *error_state* field contains the rejected version of + // this particular resource along with the reason and timestamp. For + // successfully updated or acknowledged resource, this field should + // be empty. // [#not-implemented-hide:] admin.v3.UpdateFailureState error_state = 8; + + // Is static resource is true if it is specified in the envoy config + // supplied during the start. + bool is_static_resource = 9; } // Node for a particular client. diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index 3f793657013c..f182d0d938d2 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -128,20 +128,21 @@ message ClientConfig { // GenericXdsConfig is a simpler and generic version of specifying // XDS config status and the dump. - // [#next-free-field: 9] + // [#next-free-field: 10] message GenericXdsConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v3.ClientConfig.GenericXdsConfig"; - // type_url represents the fully qualified name of xDS resource type + // Type_url represents the fully qualified name of xDS resource type // like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc. string type_url = 1; - // name of the xDS resource + // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` - // in the last processed xDS discovery response. If there are only static bootstrap listeners, this + // This is the :ref:`version_info ` in the last processed xDS discovery + // response. If there are only static bootstrap listeners, this // field will be "" string version_info = 3; @@ -158,12 +159,17 @@ message ClientConfig { // Per xDS resource status from the view of a xDS client admin.v4alpha.ClientResourceStatus client_status = 7; - // Set if the last update failed, cleared after the next successful update. - // The *error_state* field contains the rejected version of this particular - // resource along with the reason and timestamp. For successfully updated or - // acknowledged resource, this field should be empty. + // Set if the last update failed, cleared after the next successful + // update. The *error_state* field contains the rejected version of + // this particular resource along with the reason and timestamp. For + // successfully updated or acknowledged resource, this field should + // be empty. // [#not-implemented-hide:] admin.v4alpha.UpdateFailureState error_state = 8; + + // Is static resource is true if it is specified in the envoy config + // supplied during the start. + bool is_static_resource = 9; } // Node for a particular client. From c7cd32df58ceeb70ff18b8ff9ebb67d75cec24b5 Mon Sep 17 00:00:00 2001 From: su225 Date: Mon, 24 May 2021 21:56:47 +0530 Subject: [PATCH 4/8] fix documentation comment Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 229f7a65be90..7c540fb2747f 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -137,10 +137,9 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` in the last processed xDS discovery - // response. If there are only static bootstrap listeners, this - // field will be "" + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only + // static bootstrap listeners, this field will be "" string version_info = 3; // The xDS resource config. Actual content depends on the type From a245ec4dc3c6b12674988f7424af9c1dc778aa64 Mon Sep 17 00:00:00 2001 From: su225 Date: Wed, 26 May 2021 19:14:06 +0530 Subject: [PATCH 5/8] [envoy-15622] fix formatting Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 2 +- api/envoy/service/status/v4alpha/csds.proto | 7 +++---- generated_api_shadow/envoy/service/status/v3/csds.proto | 7 +++---- .../envoy/service/status/v4alpha/csds.proto | 7 +++---- 4 files changed, 10 insertions(+), 13 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 7c540fb2747f..0aa01fe28704 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -137,7 +137,7 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` + // This is the :ref:`version_info ` // in the last processed xDS discovery response. If there are only // static bootstrap listeners, this field will be "" string version_info = 3; diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index 14c8f4ad9d1c..fbef59559316 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -132,10 +132,9 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` in the last processed xDS discovery - // response. If there are only static bootstrap listeners, this - // field will be "" + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only + // static bootstrap listeners, this field will be "" string version_info = 3; // The xDS resource config. Actual content depends on the type diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index 229f7a65be90..0aa01fe28704 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -137,10 +137,9 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` in the last processed xDS discovery - // response. If there are only static bootstrap listeners, this - // field will be "" + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only + // static bootstrap listeners, this field will be "" string version_info = 3; // The xDS resource config. Actual content depends on the type diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index f182d0d938d2..31a4ecc786aa 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -140,10 +140,9 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` in the last processed xDS discovery - // response. If there are only static bootstrap listeners, this - // field will be "" + // This is the :ref:`version_info ` + // in the last processed xDS discovery response. If there are only + // static bootstrap listeners, this field will be "" string version_info = 3; // The xDS resource config. Actual content depends on the type From 96244e41a966686d1990ad9205e691ebbe60bfef Mon Sep 17 00:00:00 2001 From: su225 Date: Wed, 26 May 2021 21:29:34 +0530 Subject: [PATCH 6/8] fix formatting and docs Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 2 +- api/envoy/service/status/v4alpha/csds.proto | 2 +- generated_api_shadow/envoy/service/status/v3/csds.proto | 2 +- generated_api_shadow/envoy/service/status/v4alpha/csds.proto | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 0aa01fe28704..f90196af8edf 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -137,7 +137,7 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` + // This is the :ref:`version_info ` // in the last processed xDS discovery response. If there are only // static bootstrap listeners, this field will be "" string version_info = 3; diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index fbef59559316..c73c121807f1 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -132,7 +132,7 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` + // This is the :ref:`version_info ` // in the last processed xDS discovery response. If there are only // static bootstrap listeners, this field will be "" string version_info = 3; diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index 0aa01fe28704..f90196af8edf 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -137,7 +137,7 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` + // This is the :ref:`version_info ` // in the last processed xDS discovery response. If there are only // static bootstrap listeners, this field will be "" string version_info = 3; diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index 31a4ecc786aa..7d7fd405fc52 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -140,7 +140,7 @@ message ClientConfig { // Name of the xDS resource string name = 2; - // This is the :ref:`version_info ` + // This is the :ref:`version_info ` // in the last processed xDS discovery response. If there are only // static bootstrap listeners, this field will be "" string version_info = 3; From 361fbb569712850709557e98e8743ffb5ded42f1 Mon Sep 17 00:00:00 2001 From: su225 Date: Sun, 30 May 2021 12:06:46 +0530 Subject: [PATCH 7/8] address code review feedback - fix documentation Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 9 +++++---- api/envoy/service/status/v4alpha/csds.proto | 9 +++++---- generated_api_shadow/envoy/service/status/v3/csds.proto | 9 +++++---- .../envoy/service/status/v4alpha/csds.proto | 9 +++++---- 4 files changed, 20 insertions(+), 16 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index f90196af8edf..102264cd43b8 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -126,8 +126,9 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v2.ClientConfig"; - // GenericXdsConfig is a simpler and generic version of specifying - // XDS config status and the dump. + // 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 // [#next-free-field: 10] message GenericXdsConfig { // Type_url represents the fully qualified name of xDS resource type @@ -163,8 +164,8 @@ message ClientConfig { // [#not-implemented-hide:] admin.v3.UpdateFailureState error_state = 8; - // Is static resource is true if it is specified in the envoy config - // supplied during the start. + // Is static resource is true if it is specified in the config supplied + // during at the start. bool is_static_resource = 9; } diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index c73c121807f1..6edf1e673fdf 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -118,8 +118,9 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v3.ClientConfig"; - // GenericXdsConfig is a simpler and generic version of specifying - // XDS config status and the dump. + // 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 // [#next-free-field: 10] message GenericXdsConfig { option (udpa.annotations.versioning).previous_message_type = @@ -158,8 +159,8 @@ message ClientConfig { // [#not-implemented-hide:] admin.v4alpha.UpdateFailureState error_state = 8; - // Is static resource is true if it is specified in the envoy config - // supplied during the start. + // Is static resource is true if it is specified in the config supplied + // during at the start. bool is_static_resource = 9; } diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index f90196af8edf..102264cd43b8 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -126,8 +126,9 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v2.ClientConfig"; - // GenericXdsConfig is a simpler and generic version of specifying - // XDS config status and the dump. + // 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 // [#next-free-field: 10] message GenericXdsConfig { // Type_url represents the fully qualified name of xDS resource type @@ -163,8 +164,8 @@ message ClientConfig { // [#not-implemented-hide:] admin.v3.UpdateFailureState error_state = 8; - // Is static resource is true if it is specified in the envoy config - // supplied during the start. + // Is static resource is true if it is specified in the config supplied + // during at the start. bool is_static_resource = 9; } diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index 7d7fd405fc52..3e0a983ee3a3 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -126,8 +126,9 @@ message ClientConfig { option (udpa.annotations.versioning).previous_message_type = "envoy.service.status.v3.ClientConfig"; - // GenericXdsConfig is a simpler and generic version of specifying - // XDS config status and the dump. + // 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 // [#next-free-field: 10] message GenericXdsConfig { option (udpa.annotations.versioning).previous_message_type = @@ -166,8 +167,8 @@ message ClientConfig { // [#not-implemented-hide:] admin.v4alpha.UpdateFailureState error_state = 8; - // Is static resource is true if it is specified in the envoy config - // supplied during the start. + // Is static resource is true if it is specified in the config supplied + // during at the start. bool is_static_resource = 9; } From cf7aa965d0661ea1dc1502c4345e0a65a544531b Mon Sep 17 00:00:00 2001 From: su225 Date: Sun, 30 May 2021 16:02:03 +0530 Subject: [PATCH 8/8] fix documentation Signed-off-by: su225 --- api/envoy/service/status/v3/csds.proto | 2 +- api/envoy/service/status/v4alpha/csds.proto | 2 +- generated_api_shadow/envoy/service/status/v3/csds.proto | 2 +- generated_api_shadow/envoy/service/status/v4alpha/csds.proto | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 102264cd43b8..1d940d6a2dfe 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -165,7 +165,7 @@ message ClientConfig { admin.v3.UpdateFailureState error_state = 8; // Is static resource is true if it is specified in the config supplied - // during at the start. + // through the file at the startup. bool is_static_resource = 9; } diff --git a/api/envoy/service/status/v4alpha/csds.proto b/api/envoy/service/status/v4alpha/csds.proto index 6edf1e673fdf..9680c6feacf7 100644 --- a/api/envoy/service/status/v4alpha/csds.proto +++ b/api/envoy/service/status/v4alpha/csds.proto @@ -160,7 +160,7 @@ message ClientConfig { admin.v4alpha.UpdateFailureState error_state = 8; // Is static resource is true if it is specified in the config supplied - // during at the start. + // through the file at the startup. bool is_static_resource = 9; } diff --git a/generated_api_shadow/envoy/service/status/v3/csds.proto b/generated_api_shadow/envoy/service/status/v3/csds.proto index 102264cd43b8..1d940d6a2dfe 100644 --- a/generated_api_shadow/envoy/service/status/v3/csds.proto +++ b/generated_api_shadow/envoy/service/status/v3/csds.proto @@ -165,7 +165,7 @@ message ClientConfig { admin.v3.UpdateFailureState error_state = 8; // Is static resource is true if it is specified in the config supplied - // during at the start. + // through the file at the startup. bool is_static_resource = 9; } diff --git a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto index 3e0a983ee3a3..8a47045546f7 100644 --- a/generated_api_shadow/envoy/service/status/v4alpha/csds.proto +++ b/generated_api_shadow/envoy/service/status/v4alpha/csds.proto @@ -168,7 +168,7 @@ message ClientConfig { admin.v4alpha.UpdateFailureState error_state = 8; // Is static resource is true if it is specified in the config supplied - // during at the start. + // through the file at the startup. bool is_static_resource = 9; }