@@ -21,6 +21,8 @@ import "google/protobuf/wrappers.proto";
2121
2222import  "xds/core/v3/collection_entry.proto" ;
2323
24+ import  "envoy/annotations/deprecation.proto" ;
25+ import  "udpa/annotations/migrate.proto" ;
2426import  "udpa/annotations/security.proto" ;
2527import  "udpa/annotations/status.proto" ;
2628import  "udpa/annotations/versioning.proto" ;
@@ -158,6 +160,7 @@ message Cluster {
158160    google.protobuf.Struct  match  =  2 ;
159161
160162    // The configuration of the transport socket. 
163+     // [#extension-category: envoy.transport_sockets.upstream] 
161164    core.v3.TransportSocket  transport_socket  =  3 ;
162165  }
163166
@@ -171,6 +174,7 @@ message Cluster {
171174
172175    // Cluster specific configuration which depends on the cluster being instantiated. 
173176    // See the supported cluster for further documentation. 
177+     // [#extension-category: envoy.clusters] 
174178    google.protobuf.Any  typed_config  =  2 ;
175179  }
176180
@@ -681,11 +685,16 @@ message Cluster {
681685  // Any ``:`` in the cluster name will be converted to ``_`` when emitting statistics. 
682686  string  name  =  1  [(validate.rules ).string  = {min_len : 1 }];
683687
684-   // An optional alternative to the cluster name to be used while emitting stats. 
685-   // Any ``:`` in the name will be converted to ``_`` when emitting statistics. This should not be 
686-   // confused with :ref:`Router Filter Header 
687-   // <config_http_filters_router_x-envoy-upstream-alt-stat-name>`. 
688-   string  alt_stat_name  =  28 ;
688+   // An optional alternative to the cluster name to be used for observability. This name is used 
689+   // emitting stats for the cluster and access logging the cluster name. This will appear as 
690+   // additional information in configuration dumps of a cluster's current status as 
691+   // :ref:`observability_name <envoy_v3_api_field_admin.v3.ClusterStatus.observability_name>` 
692+   // and as an additional tag "upstream_cluster.name" while tracing. Note: access logging using 
693+   // this field is presently enabled with runtime feature 
694+   // `envoy.reloadable_features.use_observable_cluster_name`. Any ``:`` in the name will be 
695+   // converted to ``_`` when emitting statistics. This should not be confused with :ref:`Router 
696+   // Filter Header <config_http_filters_router_x-envoy-upstream-alt-stat-name>`. 
697+   string  alt_stat_name  =  28  [(udpa.annotations.field_migrate ).rename  = "observability_name" ];
689698
690699  oneof  cluster_discovery_type  {
691700    // The :ref:`service discovery type <arch_overview_service_discovery_types>` 
@@ -747,10 +756,11 @@ message Cluster {
747756  // in the :ref:`http_protocol_options <envoy_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message. 
748757  // upstream_http_protocol_options can be set via the cluster's 
749758  // :ref:`extension_protocol_options<envoy_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`. 
750-   // See ref:`upstream_http_protocol_options 
759+   // See : ref:`upstream_http_protocol_options 
751760  // <envoy_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>` 
752761  // for example usage. 
753-   core.v3.UpstreamHttpProtocolOptions  upstream_http_protocol_options  =  46  [deprecated  = true ];
762+   core.v3.UpstreamHttpProtocolOptions  upstream_http_protocol_options  =  46 
763+       [deprecated  = true , (envoy.annotations.deprecated_at_minor_version )  = "3.0" ];
754764
755765  // Additional options when handling HTTP requests upstream. These options will be applicable to 
756766  // both HTTP1 and HTTP2 requests. 
@@ -759,20 +769,22 @@ message Cluster {
759769  // in the :ref:`http_protocol_options <envoy_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message. 
760770  // common_http_protocol_options can be set via the cluster's 
761771  // :ref:`extension_protocol_options<envoy_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`. 
762-   // See ref:`upstream_http_protocol_options 
772+   // See : ref:`upstream_http_protocol_options 
763773  // <envoy_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>` 
764774  // for example usage. 
765-   core.v3.HttpProtocolOptions  common_http_protocol_options  =  29  [deprecated  = true ];
775+   core.v3.HttpProtocolOptions  common_http_protocol_options  =  29 
776+       [deprecated  = true , (envoy.annotations.deprecated_at_minor_version )  = "3.0" ];
766777
767778  // Additional options when handling HTTP1 requests. 
768779  // This has been deprecated in favor of http_protocol_options fields in the in the 
769780  // :ref:`http_protocol_options <envoy_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message. 
770781  // http_protocol_options can be set via the cluster's 
771782  // :ref:`extension_protocol_options<envoy_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`. 
772-   // See ref:`upstream_http_protocol_options 
783+   // See : ref:`upstream_http_protocol_options 
773784  // <envoy_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>` 
774785  // for example usage. 
775-   core.v3.Http1ProtocolOptions  http_protocol_options  =  13  [deprecated  = true ];
786+   core.v3.Http1ProtocolOptions  http_protocol_options  =  13 
787+       [deprecated  = true , (envoy.annotations.deprecated_at_minor_version )  = "3.0" ];
776788
777789  // Even if default HTTP2 protocol options are desired, this field must be 
778790  // set so that Envoy will assume that the upstream supports HTTP/2 when 
@@ -784,11 +796,14 @@ message Cluster {
784796  // :ref:`http_protocol_options <envoy_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` 
785797  // message. http2_protocol_options can be set via the cluster's 
786798  // :ref:`extension_protocol_options<envoy_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`. 
787-   // See ref:`upstream_http_protocol_options 
799+   // See : ref:`upstream_http_protocol_options 
788800  // <envoy_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>` 
789801  // for example usage. 
790-   core.v3.Http2ProtocolOptions  http2_protocol_options  =  14 
791-       [deprecated  = true , (udpa.annotations.security ).configure_for_untrusted_upstream  = true ];
802+   core.v3.Http2ProtocolOptions  http2_protocol_options  =  14  [
803+     deprecated  = true ,
804+     (udpa.annotations.security ).configure_for_untrusted_upstream  = true ,
805+     (envoy.annotations.deprecated_at_minor_version )  = "3.0" 
806+   ];
792807
793808  // The extension_protocol_options field is used to provide extension-specific protocol options 
794809  // for upstream connections. The key should match the extension filter name, such as 
@@ -924,7 +939,8 @@ message Cluster {
924939  // <envoy_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message. 
925940  // http_protocol_options can be set via the cluster's 
926941  // :ref:`extension_protocol_options<envoy_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`. 
927-   ClusterProtocolSelection  protocol_selection  =  26  [deprecated  = true ];
942+   ClusterProtocolSelection  protocol_selection  =  26 
943+       [deprecated  = true , (envoy.annotations.deprecated_at_minor_version )  = "3.0" ];
928944
929945  // Optional options for upstream connections. 
930946  UpstreamConnectionOptions  upstream_connection_options  =  30 ;
@@ -985,7 +1001,8 @@ message Cluster {
9851001  // 
9861002  //   This field has been deprecated in favor of `timeout_budgets`, part of 
9871003  //   :ref:`track_cluster_stats <envoy_api_field_config.cluster.v3.Cluster.track_cluster_stats>`. 
988-   bool  track_timeout_budgets  =  47  [deprecated  = true ];
1004+   bool  track_timeout_budgets  =  47 
1005+       [deprecated  = true , (envoy.annotations.deprecated_at_minor_version )  = "3.0" ];
9891006
9901007  // Optional customization and configuration of upstream connection pool, and upstream type. 
9911008  // 
@@ -1004,6 +1021,7 @@ message Cluster {
10041021  // If users desire custom connection pool or upstream behavior, for example terminating 
10051022  // CONNECT only if a custom filter indicates it is appropriate, the custom factories 
10061023  // can be registered and configured here. 
1024+   // [#extension-category: envoy.upstreams] 
10071025  core.v3.TypedExtensionConfig  upstream_config  =  48 ;
10081026
10091027  // Configuration to track optional cluster stats. 
0 commit comments