@@ -652,9 +652,10 @@ message Cluster {
652652 // If this is not set, we default to a merge window of 1000ms. To disable it, set the merge
653653 // window to 0.
654654 //
655- // Note: merging does not apply to cluster membership changes (e.g.: adds/removes); this is
656- // because merging those updates isn't currently safe. See
657- // https://github.com/envoyproxy/envoy/pull/3941.
655+ // .. note::
656+ // Merging does not apply to cluster membership changes (e.g.: adds/removes); this is
657+ // because merging those updates isn't currently safe. See
658+ // https://github.com/envoyproxy/envoy/pull/3941.
658659 google.protobuf.Duration update_merge_window = 4 ;
659660
660661 // If set to true, Envoy will :ref:`exclude <arch_overview_load_balancing_excluded>` new hosts
@@ -816,12 +817,14 @@ message Cluster {
816817 string name = 1 [(validate.rules ).string = {min_len : 1 }];
817818
818819 // An optional alternative to the cluster name to be used for observability. This name is used
819- // emitting stats for the cluster and access logging the cluster name. This will appear as
820+ // for emitting stats for the cluster and access logging the cluster name. This will appear as
820821 // additional information in configuration dumps of a cluster's current status as
821822 // :ref:`observability_name <envoy_v3_api_field_admin.v3.ClusterStatus.observability_name>`
822- // and as an additional tag "upstream_cluster.name" while tracing. Note: Any ``:`` in the name
823- // will be converted to ``_`` when emitting statistics. This should not be confused with
824- // :ref:`Router Filter Header <config_http_filters_router_x-envoy-upstream-alt-stat-name>`.
823+ // and as an additional tag "upstream_cluster.name" while tracing.
824+ //
825+ // .. note::
826+ // Any ``:`` in the name will be converted to ``_`` when emitting statistics. This should not be confused with
827+ // :ref:`Router Filter Header <config_http_filters_router_x-envoy-upstream-alt-stat-name>`.
825828 string alt_stat_name = 28 [(udpa.annotations.field_migrate ).rename = "observability_name" ];
826829
827830 oneof cluster_discovery_type {
@@ -942,6 +945,7 @@ message Cluster {
942945 // "envoy.filters.network.thrift_proxy". See the extension's documentation for details on
943946 // specific options.
944947 // [#next-major-version: make this a list of typed extensions.]
948+ // [#extension-category: envoy.upstream_options]
945949 map <string , google.protobuf.Any > typed_extension_protocol_options = 36 ;
946950
947951 // If the DNS refresh rate is specified and the cluster type is either
@@ -953,8 +957,15 @@ message Cluster {
953957 // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
954958 // and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
955959 // this setting is ignored.
956- google.protobuf.Duration dns_refresh_rate = 16
957- [(validate.rules ).duration = {gt {nanos : 1000000 }}];
960+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
961+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
962+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
963+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
964+ google.protobuf.Duration dns_refresh_rate = 16 [
965+ deprecated = true ,
966+ (validate.rules ).duration = {gt {nanos : 1000000 }},
967+ (envoy.annotations.deprecated_at_minor_version ) = "3.0"
968+ ];
958969
959970 // DNS jitter can be optionally specified if the cluster type is either
960971 // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
@@ -965,7 +976,15 @@ message Cluster {
965976 // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
966977 // and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
967978 // this setting is ignored.
968- google.protobuf.Duration dns_jitter = 58 ;
979+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
980+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
981+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
982+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
983+ google.protobuf.Duration dns_jitter = 58 [
984+ deprecated = true ,
985+ (validate.rules ).duration = {gte {}},
986+ (envoy.annotations.deprecated_at_minor_version ) = "3.0"
987+ ];
969988
970989 // If the DNS failure refresh rate is specified and the cluster type is either
971990 // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
@@ -975,16 +994,31 @@ message Cluster {
975994 // other than :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>` and
976995 // :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>` this setting is
977996 // ignored.
978- RefreshRate dns_failure_refresh_rate = 44 ;
997+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
998+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
999+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1000+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1001+ RefreshRate dns_failure_refresh_rate = 44
1002+ [deprecated = true , (envoy.annotations.deprecated_at_minor_version ) = "3.0" ];
9791003
9801004 // Optional configuration for setting cluster's DNS refresh rate. If the value is set to true,
9811005 // cluster's DNS refresh rate will be set to resource record's TTL which comes from DNS
9821006 // resolution.
983- bool respect_dns_ttl = 39 ;
1007+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1008+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1009+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1010+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1011+ bool respect_dns_ttl = 39
1012+ [deprecated = true , (envoy.annotations.deprecated_at_minor_version ) = "3.0" ];
9841013
9851014 // The DNS IP address resolution policy. If this setting is not specified, the
9861015 // value defaults to
9871016 // :ref:`AUTO<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DnsLookupFamily.AUTO>`.
1017+ // For logical and strict dns cluster, this field is deprecated in favor of using the
1018+ // :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1019+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1020+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1021+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
9881022 DnsLookupFamily dns_lookup_family = 17 [(validate.rules ).enum = {defined_only : true}];
9891023
9901024 // If DNS resolvers are specified and the cluster type is either
@@ -1024,6 +1058,9 @@ message Cluster {
10241058 // During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
10251059 // when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
10261060 // When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
1061+ // Also note that this field is deprecated for logical dns and strict dns clusters and will be ignored when
1062+ // :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1063+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
10271064 // [#extension-category: envoy.network.dns_resolver]
10281065 core.v3.TypedExtensionConfig typed_dns_resolver_config = 55 ;
10291066
@@ -1311,7 +1348,7 @@ message TrackClusterStats {
13111348
13121349 // If request_response_sizes is true, then the :ref:`histograms
13131350 // <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes
1314- // of requests and responses will be published.
1351+ // of requests and responses will be published. Additionally, number of headers in the requests and responses will be tracked.
13151352 bool request_response_sizes = 2 ;
13161353
13171354 // If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
0 commit comments