async-grpc-xds 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (239) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +0 -0
  3. data/fixtures/async/grpc/test_interface.rb +79 -0
  4. data/fixtures/async/grpc/test_message.rb +56 -0
  5. data/lib/async/grpc/xds/ads_stream.rb +70 -0
  6. data/lib/async/grpc/xds/client.rb +255 -0
  7. data/lib/async/grpc/xds/context.rb +201 -0
  8. data/lib/async/grpc/xds/control_plane.rb +143 -0
  9. data/lib/async/grpc/xds/discovery_client.rb +356 -0
  10. data/lib/async/grpc/xds/health_checker.rb +88 -0
  11. data/lib/async/grpc/xds/load_balancer.rb +196 -0
  12. data/lib/async/grpc/xds/resource_builder.rb +138 -0
  13. data/lib/async/grpc/xds/resource_cache.rb +55 -0
  14. data/lib/async/grpc/xds/resources.rb +270 -0
  15. data/lib/async/grpc/xds/server.rb +34 -0
  16. data/lib/async/grpc/xds/service.rb +117 -0
  17. data/lib/async/grpc/xds/version.rb +12 -0
  18. data/lib/async/grpc/xds.rb +42 -0
  19. data/lib/envoy/annotations/deprecation_pb.rb +19 -0
  20. data/lib/envoy/config/cluster/v3/circuit_breaker_pb.rb +31 -0
  21. data/lib/envoy/config/cluster/v3/cluster_pb.rb +80 -0
  22. data/lib/envoy/config/cluster/v3/filter_pb.rb +28 -0
  23. data/lib/envoy/config/cluster/v3/outlier_detection_pb.rb +29 -0
  24. data/lib/envoy/config/core/v3/address_pb.rb +38 -0
  25. data/lib/envoy/config/core/v3/backoff_pb.rb +27 -0
  26. data/lib/envoy/config/core/v3/base_pb.rb +68 -0
  27. data/lib/envoy/config/core/v3/cel_pb.rb +24 -0
  28. data/lib/envoy/config/core/v3/config_source_pb.rb +42 -0
  29. data/lib/envoy/config/core/v3/event_service_config_pb.rb +27 -0
  30. data/lib/envoy/config/core/v3/extension_pb.rb +26 -0
  31. data/lib/envoy/config/core/v3/grpc_method_list_pb.rb +27 -0
  32. data/lib/envoy/config/core/v3/grpc_service_pb.rb +45 -0
  33. data/lib/envoy/config/core/v3/health_check_pb.rb +47 -0
  34. data/lib/envoy/config/core/v3/http_service_pb.rb +27 -0
  35. data/lib/envoy/config/core/v3/http_uri_pb.rb +27 -0
  36. data/lib/envoy/config/core/v3/protocol_pb.rb +51 -0
  37. data/lib/envoy/config/core/v3/proxy_protocol_pb.rb +31 -0
  38. data/lib/envoy/config/core/v3/resolver_pb.rb +27 -0
  39. data/lib/envoy/config/core/v3/socket_cmsg_headers_pb.rb +25 -0
  40. data/lib/envoy/config/core/v3/socket_option_pb.rb +31 -0
  41. data/lib/envoy/config/core/v3/substitution_format_string_pb.rb +30 -0
  42. data/lib/envoy/config/core/v3/udp_socket_config_pb.rb +26 -0
  43. data/lib/envoy/config/endpoint/v3/endpoint_components_pb.rb +40 -0
  44. data/lib/envoy/config/endpoint/v3/endpoint_pb.rb +32 -0
  45. data/lib/envoy/config/endpoint/v3/load_report_pb.rb +36 -0
  46. data/lib/envoy/service/discovery/v3/ads_pb.rb +26 -0
  47. data/lib/envoy/service/discovery/v3/aggregated_discovery_service.rb +64 -0
  48. data/lib/envoy/service/discovery/v3/discovery_pb.rb +42 -0
  49. data/lib/envoy/type/matcher/v3/address_pb.rb +25 -0
  50. data/lib/envoy/type/matcher/v3/filter_state_pb.rb +27 -0
  51. data/lib/envoy/type/matcher/v3/http_inputs_pb.rb +29 -0
  52. data/lib/envoy/type/matcher/v3/metadata_pb.rb +28 -0
  53. data/lib/envoy/type/matcher/v3/node_pb.rb +27 -0
  54. data/lib/envoy/type/matcher/v3/number_pb.rb +27 -0
  55. data/lib/envoy/type/matcher/v3/path_pb.rb +27 -0
  56. data/lib/envoy/type/matcher/v3/regex_pb.rb +30 -0
  57. data/lib/envoy/type/matcher/v3/status_code_input_pb.rb +25 -0
  58. data/lib/envoy/type/matcher/v3/string_pb.rb +29 -0
  59. data/lib/envoy/type/matcher/v3/struct_pb.rb +28 -0
  60. data/lib/envoy/type/matcher/v3/value_pb.rb +31 -0
  61. data/lib/envoy/type/metadata/v3/metadata_pb.rb +32 -0
  62. data/lib/envoy/type/v3/hash_policy_pb.rb +26 -0
  63. data/lib/envoy/type/v3/http_pb.rb +22 -0
  64. data/lib/envoy/type/v3/http_status_pb.rb +25 -0
  65. data/lib/envoy/type/v3/percent_pb.rb +26 -0
  66. data/lib/envoy/type/v3/range_pb.rb +25 -0
  67. data/lib/envoy/type/v3/ratelimit_strategy_pb.rb +28 -0
  68. data/lib/envoy/type/v3/ratelimit_unit_pb.rb +22 -0
  69. data/lib/envoy/type/v3/semantic_version_pb.rb +23 -0
  70. data/lib/envoy/type/v3/token_bucket_pb.rb +26 -0
  71. data/lib/envoy.rb +83 -0
  72. data/lib/google/protobuf/any_pb.rb +18 -0
  73. data/lib/google/protobuf/duration_pb.rb +18 -0
  74. data/lib/google/protobuf/empty_pb.rb +18 -0
  75. data/lib/google/protobuf/struct_pb.rb +21 -0
  76. data/lib/google/protobuf/timestamp_pb.rb +18 -0
  77. data/lib/google/protobuf/wrappers_pb.rb +26 -0
  78. data/lib/google/rpc/status_pb.rb +20 -0
  79. data/lib/udpa/annotations/migrate_pb.rb +22 -0
  80. data/lib/udpa/annotations/security_pb.rb +23 -0
  81. data/lib/udpa/annotations/sensitive_pb.rb +19 -0
  82. data/lib/udpa/annotations/status_pb.rb +21 -0
  83. data/lib/udpa/annotations/versioning_pb.rb +20 -0
  84. data/lib/validate/validate_pb.rb +43 -0
  85. data/lib/xds/annotations/v3/status_pb.rb +26 -0
  86. data/lib/xds/core/v3/authority_pb.rb +23 -0
  87. data/lib/xds/core/v3/cidr_pb.rb +24 -0
  88. data/lib/xds/core/v3/collection_entry_pb.rb +26 -0
  89. data/lib/xds/core/v3/context_params_pb.rb +22 -0
  90. data/lib/xds/core/v3/extension_pb.rb +23 -0
  91. data/lib/xds/core/v3/resource_locator_pb.rb +26 -0
  92. data/lib/xds/core/v3/resource_name_pb.rb +24 -0
  93. data/lib/xds/core/v3/resource_pb.rb +24 -0
  94. data/lib/xds/type/matcher/v3/domain_pb.rb +27 -0
  95. data/lib/xds/type/matcher/v3/http_inputs_pb.rb +22 -0
  96. data/lib/xds/type/matcher/v3/ip_pb.rb +28 -0
  97. data/lib/xds/type/matcher/v3/matcher_pb.rb +34 -0
  98. data/lib/xds/type/matcher/v3/range_pb.rb +31 -0
  99. data/lib/xds/type/matcher/v3/regex_pb.rb +25 -0
  100. data/lib/xds/type/matcher/v3/string_pb.rb +27 -0
  101. data/license.md +21 -0
  102. data/plan.md +156 -0
  103. data/proto/envoy/annotations/deprecation.proto +34 -0
  104. data/proto/envoy/annotations/resource.proto +19 -0
  105. data/proto/envoy/config/README.md +3 -0
  106. data/proto/envoy/config/cluster/v3/BUILD +18 -0
  107. data/proto/envoy/config/cluster/v3/circuit_breaker.proto +121 -0
  108. data/proto/envoy/config/cluster/v3/cluster.proto +1407 -0
  109. data/proto/envoy/config/cluster/v3/filter.proto +40 -0
  110. data/proto/envoy/config/cluster/v3/outlier_detection.proto +180 -0
  111. data/proto/envoy/config/core/v3/BUILD +16 -0
  112. data/proto/envoy/config/core/v3/address.proto +214 -0
  113. data/proto/envoy/config/core/v3/backoff.proto +37 -0
  114. data/proto/envoy/config/core/v3/base.proto +662 -0
  115. data/proto/envoy/config/core/v3/cel.proto +63 -0
  116. data/proto/envoy/config/core/v3/config_source.proto +283 -0
  117. data/proto/envoy/config/core/v3/event_service_config.proto +29 -0
  118. data/proto/envoy/config/core/v3/extension.proto +32 -0
  119. data/proto/envoy/config/core/v3/grpc_method_list.proto +33 -0
  120. data/proto/envoy/config/core/v3/grpc_service.proto +355 -0
  121. data/proto/envoy/config/core/v3/health_check.proto +443 -0
  122. data/proto/envoy/config/core/v3/http_service.proto +35 -0
  123. data/proto/envoy/config/core/v3/http_uri.proto +58 -0
  124. data/proto/envoy/config/core/v3/protocol.proto +807 -0
  125. data/proto/envoy/config/core/v3/proxy_protocol.proto +114 -0
  126. data/proto/envoy/config/core/v3/resolver.proto +36 -0
  127. data/proto/envoy/config/core/v3/socket_cmsg_headers.proto +28 -0
  128. data/proto/envoy/config/core/v3/socket_option.proto +108 -0
  129. data/proto/envoy/config/core/v3/substitution_format_string.proto +136 -0
  130. data/proto/envoy/config/core/v3/udp_socket_config.proto +32 -0
  131. data/proto/envoy/config/endpoint/v3/BUILD +16 -0
  132. data/proto/envoy/config/endpoint/v3/endpoint.proto +137 -0
  133. data/proto/envoy/config/endpoint/v3/endpoint_components.proto +229 -0
  134. data/proto/envoy/config/endpoint/v3/load_report.proto +220 -0
  135. data/proto/envoy/config/listener/v3/BUILD +18 -0
  136. data/proto/envoy/config/listener/v3/api_listener.proto +34 -0
  137. data/proto/envoy/config/listener/v3/listener.proto +455 -0
  138. data/proto/envoy/config/listener/v3/listener_components.proto +353 -0
  139. data/proto/envoy/config/listener/v3/quic_config.proto +108 -0
  140. data/proto/envoy/config/listener/v3/udp_listener_config.proto +52 -0
  141. data/proto/envoy/config/route/v3/BUILD +19 -0
  142. data/proto/envoy/config/route/v3/route.proto +172 -0
  143. data/proto/envoy/config/route/v3/route_components.proto +2918 -0
  144. data/proto/envoy/config/route/v3/scoped_route.proto +133 -0
  145. data/proto/envoy/extensions/transport_sockets/tls/v3/BUILD +14 -0
  146. data/proto/envoy/extensions/transport_sockets/tls/v3/cert.proto +12 -0
  147. data/proto/envoy/extensions/transport_sockets/tls/v3/common.proto +597 -0
  148. data/proto/envoy/extensions/transport_sockets/tls/v3/secret.proto +61 -0
  149. data/proto/envoy/extensions/transport_sockets/tls/v3/tls.proto +366 -0
  150. data/proto/envoy/extensions/transport_sockets/tls/v3/tls_spiffe_validator_config.proto +67 -0
  151. data/proto/envoy/service/README.md +3 -0
  152. data/proto/envoy/service/discovery/v3/BUILD +13 -0
  153. data/proto/envoy/service/discovery/v3/ads.proto +44 -0
  154. data/proto/envoy/service/discovery/v3/discovery.proto +443 -0
  155. data/proto/envoy/type/BUILD +9 -0
  156. data/proto/envoy/type/hash_policy.proto +28 -0
  157. data/proto/envoy/type/http.proto +24 -0
  158. data/proto/envoy/type/http_status.proto +140 -0
  159. data/proto/envoy/type/matcher/v3/address.proto +22 -0
  160. data/proto/envoy/type/matcher/v3/filter_state.proto +33 -0
  161. data/proto/envoy/type/matcher/v3/http_inputs.proto +71 -0
  162. data/proto/envoy/type/matcher/v3/metadata.proto +110 -0
  163. data/proto/envoy/type/matcher/v3/node.proto +29 -0
  164. data/proto/envoy/type/matcher/v3/number.proto +33 -0
  165. data/proto/envoy/type/matcher/v3/path.proto +31 -0
  166. data/proto/envoy/type/matcher/v3/regex.proto +97 -0
  167. data/proto/envoy/type/matcher/v3/status_code_input.proto +23 -0
  168. data/proto/envoy/type/matcher/v3/string.proto +94 -0
  169. data/proto/envoy/type/matcher/v3/struct.proto +91 -0
  170. data/proto/envoy/type/matcher/v3/value.proto +80 -0
  171. data/proto/envoy/type/metadata/v3/metadata.proto +117 -0
  172. data/proto/envoy/type/percent.proto +52 -0
  173. data/proto/envoy/type/range.proto +43 -0
  174. data/proto/envoy/type/semantic_version.proto +24 -0
  175. data/proto/envoy/type/token_bucket.proto +36 -0
  176. data/proto/envoy/type/v3/BUILD +12 -0
  177. data/proto/envoy/type/v3/hash_policy.proto +43 -0
  178. data/proto/envoy/type/v3/http.proto +24 -0
  179. data/proto/envoy/type/v3/http_status.proto +199 -0
  180. data/proto/envoy/type/v3/percent.proto +57 -0
  181. data/proto/envoy/type/v3/range.proto +50 -0
  182. data/proto/envoy/type/v3/ratelimit_strategy.proto +79 -0
  183. data/proto/envoy/type/v3/ratelimit_unit.proto +37 -0
  184. data/proto/envoy/type/v3/semantic_version.proto +27 -0
  185. data/proto/envoy/type/v3/token_bucket.proto +39 -0
  186. data/proto/google/protobuf/any.proto +162 -0
  187. data/proto/google/protobuf/duration.proto +115 -0
  188. data/proto/google/protobuf/empty.proto +51 -0
  189. data/proto/google/protobuf/struct.proto +95 -0
  190. data/proto/google/protobuf/timestamp.proto +145 -0
  191. data/proto/google/protobuf/wrappers.proto +157 -0
  192. data/proto/google/rpc/status.proto +47 -0
  193. data/proto/readme.md +70 -0
  194. data/proto/udpa/annotations/migrate.proto +49 -0
  195. data/proto/udpa/annotations/security.proto +31 -0
  196. data/proto/udpa/annotations/sensitive.proto +14 -0
  197. data/proto/udpa/annotations/status.proto +34 -0
  198. data/proto/udpa/annotations/versioning.proto +17 -0
  199. data/proto/validate/validate.proto +862 -0
  200. data/proto/xds/annotations/v3/migrate.proto +46 -0
  201. data/proto/xds/annotations/v3/security.proto +30 -0
  202. data/proto/xds/annotations/v3/sensitive.proto +16 -0
  203. data/proto/xds/annotations/v3/status.proto +59 -0
  204. data/proto/xds/annotations/v3/versioning.proto +20 -0
  205. data/proto/xds/core/v3/authority.proto +22 -0
  206. data/proto/xds/core/v3/cidr.proto +25 -0
  207. data/proto/xds/core/v3/collection_entry.proto +55 -0
  208. data/proto/xds/core/v3/context_params.proto +23 -0
  209. data/proto/xds/core/v3/extension.proto +26 -0
  210. data/proto/xds/core/v3/resource.proto +29 -0
  211. data/proto/xds/core/v3/resource_locator.proto +118 -0
  212. data/proto/xds/core/v3/resource_name.proto +42 -0
  213. data/proto/xds/type/matcher/v3/cel.proto +37 -0
  214. data/proto/xds/type/matcher/v3/domain.proto +46 -0
  215. data/proto/xds/type/matcher/v3/http_inputs.proto +23 -0
  216. data/proto/xds/type/matcher/v3/ip.proto +53 -0
  217. data/proto/xds/type/matcher/v3/matcher.proto +144 -0
  218. data/proto/xds/type/matcher/v3/range.proto +69 -0
  219. data/proto/xds/type/matcher/v3/regex.proto +46 -0
  220. data/proto/xds/type/matcher/v3/string.proto +71 -0
  221. data/proto/xds/type/v3/cel.proto +77 -0
  222. data/proto/xds/type/v3/range.proto +40 -0
  223. data/proto/xds/type/v3/typed_struct.proto +44 -0
  224. data/readme.md +37 -0
  225. data/releases.md +5 -0
  226. data/xds/Dockerfile.backend +24 -0
  227. data/xds/Dockerfile.control-plane +22 -0
  228. data/xds/backend_server.rb +68 -0
  229. data/xds/docker-compose.yaml +89 -0
  230. data/xds/go.mod +22 -0
  231. data/xds/go.sum +82 -0
  232. data/xds/readme.md +122 -0
  233. data/xds/test/async/grpc/xds/client.rb +294 -0
  234. data/xds/test/async/grpc/xds/control_plane.rb +94 -0
  235. data/xds/test_server.go +355 -0
  236. data/xds/update_protos.sh +123 -0
  237. data.tar.gz.sig +0 -0
  238. metadata +386 -0
  239. metadata.gz.sig +2 -0
@@ -0,0 +1,1407 @@
1
+ syntax = "proto3";
2
+
3
+ package envoy.config.cluster.v3;
4
+
5
+ import "envoy/config/cluster/v3/circuit_breaker.proto";
6
+ import "envoy/config/cluster/v3/filter.proto";
7
+ import "envoy/config/cluster/v3/outlier_detection.proto";
8
+ import "envoy/config/core/v3/address.proto";
9
+ import "envoy/config/core/v3/base.proto";
10
+ import "envoy/config/core/v3/config_source.proto";
11
+ import "envoy/config/core/v3/extension.proto";
12
+ import "envoy/config/core/v3/health_check.proto";
13
+ import "envoy/config/core/v3/protocol.proto";
14
+ import "envoy/config/core/v3/resolver.proto";
15
+ import "envoy/config/endpoint/v3/endpoint.proto";
16
+ import "envoy/type/metadata/v3/metadata.proto";
17
+ import "envoy/type/v3/percent.proto";
18
+
19
+ import "google/protobuf/any.proto";
20
+ import "google/protobuf/duration.proto";
21
+ import "google/protobuf/struct.proto";
22
+ import "google/protobuf/wrappers.proto";
23
+
24
+ import "xds/core/v3/collection_entry.proto";
25
+ import "xds/type/matcher/v3/matcher.proto";
26
+
27
+ import "envoy/annotations/deprecation.proto";
28
+ import "udpa/annotations/migrate.proto";
29
+ import "udpa/annotations/security.proto";
30
+ import "udpa/annotations/status.proto";
31
+ import "udpa/annotations/versioning.proto";
32
+ import "validate/validate.proto";
33
+
34
+ option java_package = "io.envoyproxy.envoy.config.cluster.v3";
35
+ option java_outer_classname = "ClusterProto";
36
+ option java_multiple_files = true;
37
+ option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3;clusterv3";
38
+ option (udpa.annotations.file_status).package_version_status = ACTIVE;
39
+
40
+ // [#protodoc-title: Cluster configuration]
41
+
42
+ // Cluster list collections. Entries are ``Cluster`` resources or references.
43
+ // [#not-implemented-hide:]
44
+ message ClusterCollection {
45
+ xds.core.v3.CollectionEntry entries = 1;
46
+ }
47
+
48
+ // Configuration for a single upstream cluster.
49
+ // [#next-free-field: 60]
50
+ message Cluster {
51
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.Cluster";
52
+
53
+ // Refer to :ref:`service discovery type <arch_overview_service_discovery_types>`
54
+ // for an explanation on each type.
55
+ enum DiscoveryType {
56
+ // Refer to the :ref:`static discovery type<arch_overview_service_discovery_types_static>`
57
+ // for an explanation.
58
+ STATIC = 0;
59
+
60
+ // Refer to the :ref:`strict DNS discovery
61
+ // type<arch_overview_service_discovery_types_strict_dns>`
62
+ // for an explanation.
63
+ STRICT_DNS = 1;
64
+
65
+ // Refer to the :ref:`logical DNS discovery
66
+ // type<arch_overview_service_discovery_types_logical_dns>`
67
+ // for an explanation.
68
+ LOGICAL_DNS = 2;
69
+
70
+ // Refer to the :ref:`service discovery type<arch_overview_service_discovery_types_eds>`
71
+ // for an explanation.
72
+ EDS = 3;
73
+
74
+ // Refer to the :ref:`original destination discovery
75
+ // type<arch_overview_service_discovery_types_original_destination>`
76
+ // for an explanation.
77
+ ORIGINAL_DST = 4;
78
+ }
79
+
80
+ // Refer to :ref:`load balancer type <arch_overview_load_balancing_types>` architecture
81
+ // overview section for information on each type.
82
+ enum LbPolicy {
83
+ reserved 4;
84
+
85
+ reserved "ORIGINAL_DST_LB";
86
+
87
+ // Refer to the :ref:`round robin load balancing
88
+ // policy<arch_overview_load_balancing_types_round_robin>`
89
+ // for an explanation.
90
+ ROUND_ROBIN = 0;
91
+
92
+ // Refer to the :ref:`least request load balancing
93
+ // policy<arch_overview_load_balancing_types_least_request>`
94
+ // for an explanation.
95
+ LEAST_REQUEST = 1;
96
+
97
+ // Refer to the :ref:`ring hash load balancing
98
+ // policy<arch_overview_load_balancing_types_ring_hash>`
99
+ // for an explanation.
100
+ RING_HASH = 2;
101
+
102
+ // Refer to the :ref:`random load balancing
103
+ // policy<arch_overview_load_balancing_types_random>`
104
+ // for an explanation.
105
+ RANDOM = 3;
106
+
107
+ // Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>`
108
+ // for an explanation.
109
+ MAGLEV = 5;
110
+
111
+ // This load balancer type must be specified if the configured cluster provides a cluster
112
+ // specific load balancer. Consult the configured cluster's documentation for whether to set
113
+ // this option or not.
114
+ CLUSTER_PROVIDED = 6;
115
+
116
+ // Use the new :ref:`load_balancing_policy
117
+ // <envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field to determine the LB policy.
118
+ // This has been deprecated in favor of using the :ref:`load_balancing_policy
119
+ // <envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field without
120
+ // setting any value in :ref:`lb_policy<envoy_v3_api_field_config.cluster.v3.Cluster.lb_policy>`.
121
+ LOAD_BALANCING_POLICY_CONFIG = 7;
122
+ }
123
+
124
+ // When V4_ONLY is selected, the DNS resolver will only perform a lookup for
125
+ // addresses in the IPv4 family. If V6_ONLY is selected, the DNS resolver will
126
+ // only perform a lookup for addresses in the IPv6 family. If AUTO is
127
+ // specified, the DNS resolver will first perform a lookup for addresses in
128
+ // the IPv6 family and fallback to a lookup for addresses in the IPv4 family.
129
+ // This is semantically equivalent to a non-existent V6_PREFERRED option.
130
+ // AUTO is a legacy name that is more opaque than
131
+ // necessary and will be deprecated in favor of V6_PREFERRED in a future major version of the API.
132
+ // If V4_PREFERRED is specified, the DNS resolver will first perform a lookup for addresses in the
133
+ // IPv4 family and fallback to a lookup for addresses in the IPv6 family. i.e., the callback
134
+ // target will only get v6 addresses if there were NO v4 addresses to return.
135
+ // If ALL is specified, the DNS resolver will perform a lookup for both IPv4 and IPv6 families,
136
+ // and return all resolved addresses. When this is used, Happy Eyeballs will be enabled for
137
+ // upstream connections. Refer to :ref:`Happy Eyeballs Support <arch_overview_happy_eyeballs>`
138
+ // for more information.
139
+ // For cluster types other than
140
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>` and
141
+ // :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`,
142
+ // this setting is
143
+ // ignored.
144
+ // [#next-major-version: deprecate AUTO in favor of a V6_PREFERRED option.]
145
+ enum DnsLookupFamily {
146
+ AUTO = 0;
147
+ V4_ONLY = 1;
148
+ V6_ONLY = 2;
149
+ V4_PREFERRED = 3;
150
+ ALL = 4;
151
+ }
152
+
153
+ enum ClusterProtocolSelection {
154
+ // Cluster can only operate on one of the possible upstream protocols (HTTP1.1, HTTP2).
155
+ // If :ref:`http2_protocol_options <envoy_v3_api_field_config.cluster.v3.Cluster.http2_protocol_options>` are
156
+ // present, HTTP2 will be used, otherwise HTTP1.1 will be used.
157
+ USE_CONFIGURED_PROTOCOL = 0;
158
+
159
+ // Use HTTP1.1 or HTTP2, depending on which one is used on the downstream connection.
160
+ USE_DOWNSTREAM_PROTOCOL = 1;
161
+ }
162
+
163
+ // TransportSocketMatch specifies what transport socket config will be used
164
+ // when the match conditions are satisfied.
165
+ message TransportSocketMatch {
166
+ option (udpa.annotations.versioning).previous_message_type =
167
+ "envoy.api.v2.Cluster.TransportSocketMatch";
168
+
169
+ // The name of the match, used in stats generation.
170
+ string name = 1 [(validate.rules).string = {min_len: 1}];
171
+
172
+ // Optional metadata match criteria.
173
+ // The connection to the endpoint with metadata matching what is set in this field
174
+ // will use the transport socket configuration specified here.
175
+ // The endpoint's metadata entry in ``envoy.transport_socket_match`` is used to match
176
+ // against the values specified in this field.
177
+ google.protobuf.Struct match = 2;
178
+
179
+ // The configuration of the transport socket.
180
+ // [#extension-category: envoy.transport_sockets.upstream]
181
+ core.v3.TransportSocket transport_socket = 3;
182
+ }
183
+
184
+ // Extended cluster type.
185
+ message CustomClusterType {
186
+ option (udpa.annotations.versioning).previous_message_type =
187
+ "envoy.api.v2.Cluster.CustomClusterType";
188
+
189
+ // The type of the cluster to instantiate. The name must match a supported cluster type.
190
+ string name = 1 [(validate.rules).string = {min_len: 1}];
191
+
192
+ // Cluster specific configuration which depends on the cluster being instantiated.
193
+ // See the supported cluster for further documentation.
194
+ // [#extension-category: envoy.clusters]
195
+ google.protobuf.Any typed_config = 2;
196
+ }
197
+
198
+ // Only valid when discovery type is EDS.
199
+ message EdsClusterConfig {
200
+ option (udpa.annotations.versioning).previous_message_type =
201
+ "envoy.api.v2.Cluster.EdsClusterConfig";
202
+
203
+ // Configuration for the source of EDS updates for this Cluster.
204
+ core.v3.ConfigSource eds_config = 1;
205
+
206
+ // Optional alternative to cluster name to present to EDS. This does not
207
+ // have the same restrictions as cluster name, i.e. it may be arbitrary
208
+ // length. This may be a xdstp:// URL.
209
+ string service_name = 2;
210
+ }
211
+
212
+ // Optionally divide the endpoints in this cluster into subsets defined by
213
+ // endpoint metadata and selected by route and weighted cluster metadata.
214
+ // [#next-free-field: 9]
215
+ message LbSubsetConfig {
216
+ option (udpa.annotations.versioning).previous_message_type =
217
+ "envoy.api.v2.Cluster.LbSubsetConfig";
218
+
219
+ // If NO_FALLBACK is selected, a result
220
+ // equivalent to no healthy hosts is reported. If ANY_ENDPOINT is selected,
221
+ // any cluster endpoint may be returned (subject to policy, health checks,
222
+ // etc). If DEFAULT_SUBSET is selected, load balancing is performed over the
223
+ // endpoints matching the values from the default_subset field.
224
+ enum LbSubsetFallbackPolicy {
225
+ NO_FALLBACK = 0;
226
+ ANY_ENDPOINT = 1;
227
+ DEFAULT_SUBSET = 2;
228
+ }
229
+
230
+ enum LbSubsetMetadataFallbackPolicy {
231
+ // No fallback. Route metadata will be used as-is.
232
+ METADATA_NO_FALLBACK = 0;
233
+
234
+ // A special metadata key ``fallback_list`` will be used to provide variants of metadata to try.
235
+ // Value of ``fallback_list`` key has to be a list. Every list element has to be a struct - it will
236
+ // be merged with route metadata, overriding keys that appear in both places.
237
+ // ``fallback_list`` entries will be used in order until a host is found.
238
+ //
239
+ // ``fallback_list`` key itself is removed from metadata before subset load balancing is performed.
240
+ //
241
+ // Example:
242
+ //
243
+ // for metadata:
244
+ //
245
+ // .. code-block:: yaml
246
+ //
247
+ // version: 1.0
248
+ // fallback_list:
249
+ // - version: 2.0
250
+ // hardware: c64
251
+ // - hardware: c32
252
+ // - version: 3.0
253
+ //
254
+ // at first, metadata:
255
+ //
256
+ // .. code-block:: json
257
+ //
258
+ // {"version": "2.0", "hardware": "c64"}
259
+ //
260
+ // will be used for load balancing. If no host is found, metadata:
261
+ //
262
+ // .. code-block:: json
263
+ //
264
+ // {"version": "1.0", "hardware": "c32"}
265
+ //
266
+ // is next to try. If it still results in no host, finally metadata:
267
+ //
268
+ // .. code-block:: json
269
+ //
270
+ // {"version": "3.0"}
271
+ //
272
+ // is used.
273
+ FALLBACK_LIST = 1;
274
+ }
275
+
276
+ // Specifications for subsets.
277
+ message LbSubsetSelector {
278
+ option (udpa.annotations.versioning).previous_message_type =
279
+ "envoy.api.v2.Cluster.LbSubsetConfig.LbSubsetSelector";
280
+
281
+ // Allows to override top level fallback policy per selector.
282
+ enum LbSubsetSelectorFallbackPolicy {
283
+ // If NOT_DEFINED top level config fallback policy is used instead.
284
+ NOT_DEFINED = 0;
285
+
286
+ // If NO_FALLBACK is selected, a result equivalent to no healthy hosts is reported.
287
+ NO_FALLBACK = 1;
288
+
289
+ // If ANY_ENDPOINT is selected, any cluster endpoint may be returned
290
+ // (subject to policy, health checks, etc).
291
+ ANY_ENDPOINT = 2;
292
+
293
+ // If DEFAULT_SUBSET is selected, load balancing is performed over the
294
+ // endpoints matching the values from the default_subset field.
295
+ DEFAULT_SUBSET = 3;
296
+
297
+ // If KEYS_SUBSET is selected, subset selector matching is performed again with metadata
298
+ // keys reduced to
299
+ // :ref:`fallback_keys_subset<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.fallback_keys_subset>`.
300
+ // It allows for a fallback to a different, less specific selector if some of the keys of
301
+ // the selector are considered optional.
302
+ KEYS_SUBSET = 4;
303
+ }
304
+
305
+ // List of keys to match with the weighted cluster metadata.
306
+ repeated string keys = 1;
307
+
308
+ // Selects a mode of operation in which each subset has only one host. This mode uses the same rules for
309
+ // choosing a host, but updating hosts is faster, especially for large numbers of hosts.
310
+ //
311
+ // If a match is found to a host, that host will be used regardless of priority levels.
312
+ //
313
+ // When this mode is enabled, configurations that contain more than one host with the same metadata value for the single key in ``keys``
314
+ // will use only one of the hosts with the given key; no requests will be routed to the others. The cluster gauge
315
+ // :ref:`lb_subsets_single_host_per_subset_duplicate<config_cluster_manager_cluster_stats_subset_lb>` indicates how many duplicates are
316
+ // present in the current configuration.
317
+ bool single_host_per_subset = 4;
318
+
319
+ // The behavior used when no endpoint subset matches the selected route's
320
+ // metadata.
321
+ LbSubsetSelectorFallbackPolicy fallback_policy = 2
322
+ [(validate.rules).enum = {defined_only: true}];
323
+
324
+ // Subset of
325
+ // :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
326
+ // :ref:`KEYS_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>`
327
+ // fallback policy.
328
+ // It has to be a non empty list if KEYS_SUBSET fallback policy is selected.
329
+ // For any other fallback policy the parameter is not used and should not be set.
330
+ // Only values also present in
331
+ // :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` are allowed, but
332
+ // ``fallback_keys_subset`` cannot be equal to ``keys``.
333
+ repeated string fallback_keys_subset = 3;
334
+ }
335
+
336
+ // The behavior used when no endpoint subset matches the selected route's
337
+ // metadata. The value defaults to
338
+ // :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
339
+ LbSubsetFallbackPolicy fallback_policy = 1 [(validate.rules).enum = {defined_only: true}];
340
+
341
+ // Specifies the default subset of endpoints used during fallback if
342
+ // fallback_policy is
343
+ // :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
344
+ // Each field in default_subset is
345
+ // compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
346
+ // namespace. It is valid for no hosts to match, in which case the behavior
347
+ // is the same as a fallback_policy of
348
+ // :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
349
+ google.protobuf.Struct default_subset = 2;
350
+
351
+ // For each entry, LbEndpoint.Metadata's
352
+ // ``envoy.lb`` namespace is traversed and a subset is created for each unique
353
+ // combination of key and value. For example:
354
+ //
355
+ // .. code-block:: json
356
+ //
357
+ // { "subset_selectors": [
358
+ // { "keys": [ "version" ] },
359
+ // { "keys": [ "stage", "hardware_type" ] }
360
+ // ]}
361
+ //
362
+ // A subset is matched when the metadata from the selected route and
363
+ // weighted cluster contains the same keys and values as the subset's
364
+ // metadata. The same host may appear in multiple subsets.
365
+ repeated LbSubsetSelector subset_selectors = 3;
366
+
367
+ // If true, routing to subsets will take into account the localities and locality weights of the
368
+ // endpoints when making the routing decision.
369
+ //
370
+ // There are some potential pitfalls associated with enabling this feature, as the resulting
371
+ // traffic split after applying both a subset match and locality weights might be undesirable.
372
+ //
373
+ // Consider for example a situation in which you have 50/50 split across two localities X/Y
374
+ // which have 100 hosts each without subsetting. If the subset LB results in X having only 1
375
+ // host selected but Y having 100, then a lot more load is being dumped on the single host in X
376
+ // than originally anticipated in the load balancing assignment delivered via EDS.
377
+ bool locality_weight_aware = 4;
378
+
379
+ // When used with locality_weight_aware, scales the weight of each locality by the ratio
380
+ // of hosts in the subset vs hosts in the original subset. This aims to even out the load
381
+ // going to an individual locality if said locality is disproportionately affected by the
382
+ // subset predicate.
383
+ bool scale_locality_weight = 5;
384
+
385
+ // If true, when a fallback policy is configured and its corresponding subset fails to find
386
+ // a host this will cause any host to be selected instead.
387
+ //
388
+ // This is useful when using the default subset as the fallback policy, given the default
389
+ // subset might become empty. With this option enabled, if that happens the LB will attempt
390
+ // to select a host from the entire cluster.
391
+ bool panic_mode_any = 6;
392
+
393
+ // If true, metadata specified for a metadata key will be matched against the corresponding
394
+ // endpoint metadata if the endpoint metadata matches the value exactly OR it is a list value
395
+ // and any of the elements in the list matches the criteria.
396
+ bool list_as_any = 7;
397
+
398
+ // Fallback mechanism that allows to try different route metadata until a host is found.
399
+ // If load balancing process, including all its mechanisms (like
400
+ // :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
401
+ // fails to select a host, this policy decides if and how the process is repeated using another metadata.
402
+ //
403
+ // The value defaults to
404
+ // :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
405
+ LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8
406
+ [(validate.rules).enum = {defined_only: true}];
407
+ }
408
+
409
+ // Configuration for :ref:`slow start mode <arch_overview_load_balancing_slow_start>`.
410
+ message SlowStartConfig {
411
+ // Represents the size of slow start window.
412
+ // If set, the newly created host remains in slow start mode starting from its creation time
413
+ // for the duration of slow start window.
414
+ google.protobuf.Duration slow_start_window = 1;
415
+
416
+ // This parameter controls the speed of traffic increase over the slow start window. Defaults to 1.0,
417
+ // so that endpoint would get linearly increasing amount of traffic.
418
+ // When increasing the value for this parameter, the speed of traffic ramp-up increases non-linearly.
419
+ // The value of aggression parameter should be greater than 0.0.
420
+ // By tuning the parameter, is possible to achieve polynomial or exponential shape of ramp-up curve.
421
+ //
422
+ // During slow start window, effective weight of an endpoint would be scaled with time factor and aggression:
423
+ // ``new_weight = weight * max(min_weight_percent, time_factor ^ (1 / aggression))``,
424
+ // where ``time_factor=(time_since_start_seconds / slow_start_time_seconds)``.
425
+ //
426
+ // As time progresses, more and more traffic would be sent to endpoint, which is in slow start window.
427
+ // Once host exits slow start, time_factor and aggression no longer affect its weight.
428
+ core.v3.RuntimeDouble aggression = 2;
429
+
430
+ // Configures the minimum percentage of origin weight that avoids too small new weight,
431
+ // which may cause endpoints in slow start mode receive no traffic in slow start window.
432
+ // If not specified, the default is 10%.
433
+ type.v3.Percent min_weight_percent = 3;
434
+ }
435
+
436
+ // Specific configuration for the RoundRobin load balancing policy.
437
+ message RoundRobinLbConfig {
438
+ // Configuration for slow start mode.
439
+ // If this configuration is not set, slow start will not be not enabled.
440
+ SlowStartConfig slow_start_config = 1;
441
+ }
442
+
443
+ // Specific configuration for the LeastRequest load balancing policy.
444
+ message LeastRequestLbConfig {
445
+ option (udpa.annotations.versioning).previous_message_type =
446
+ "envoy.api.v2.Cluster.LeastRequestLbConfig";
447
+
448
+ // The number of random healthy hosts from which the host with the fewest active requests will
449
+ // be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
450
+ google.protobuf.UInt32Value choice_count = 1 [(validate.rules).uint32 = {gte: 2}];
451
+
452
+ // The following formula is used to calculate the dynamic weights when hosts have different load
453
+ // balancing weights:
454
+ //
455
+ // ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``
456
+ //
457
+ // The larger the active request bias is, the more aggressively active requests will lower the
458
+ // effective weight when all host weights are not equal.
459
+ //
460
+ // ``active_request_bias`` must be greater than or equal to 0.0.
461
+ //
462
+ // When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
463
+ // of active requests at the time it picks a host and behaves like the Round Robin Load
464
+ // Balancer.
465
+ //
466
+ // When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
467
+ // weight by the number of active requests at the time it does a pick.
468
+ //
469
+ // The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
470
+ // host sets changes, e.g., whenever there is a host membership update or a host load balancing
471
+ // weight change.
472
+ //
473
+ // .. note::
474
+ // This setting only takes effect if all host weights are not equal.
475
+ core.v3.RuntimeDouble active_request_bias = 2;
476
+
477
+ // Configuration for slow start mode.
478
+ // If this configuration is not set, slow start will not be not enabled.
479
+ SlowStartConfig slow_start_config = 3;
480
+ }
481
+
482
+ // Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>`
483
+ // load balancing policy.
484
+ message RingHashLbConfig {
485
+ option (udpa.annotations.versioning).previous_message_type =
486
+ "envoy.api.v2.Cluster.RingHashLbConfig";
487
+
488
+ // The hash function used to hash hosts onto the ketama ring.
489
+ enum HashFunction {
490
+ // Use `xxHash <https://github.com/Cyan4973/xxHash>`_, this is the default hash function.
491
+ XX_HASH = 0;
492
+
493
+ // Use `MurmurHash2 <https://sites.google.com/site/murmurhash/>`_, this is compatible with
494
+ // std:hash<string> in GNU libstdc++ 3.4.20 or above. This is typically the case when compiled
495
+ // on Linux and not macOS.
496
+ MURMUR_HASH_2 = 1;
497
+ }
498
+
499
+ reserved 2;
500
+
501
+ // Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each
502
+ // provided host) the better the request distribution will reflect the desired weights. Defaults
503
+ // to 1024 entries, and limited to 8M entries. See also
504
+ // :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
505
+ google.protobuf.UInt64Value minimum_ring_size = 1 [(validate.rules).uint64 = {lte: 8388608}];
506
+
507
+ // The hash function used to hash hosts onto the ketama ring. The value defaults to
508
+ // :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
509
+ HashFunction hash_function = 3 [(validate.rules).enum = {defined_only: true}];
510
+
511
+ // Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered
512
+ // to further constrain resource use. See also
513
+ // :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
514
+ google.protobuf.UInt64Value maximum_ring_size = 4 [(validate.rules).uint64 = {lte: 8388608}];
515
+ }
516
+
517
+ // Specific configuration for the :ref:`Maglev<arch_overview_load_balancing_types_maglev>`
518
+ // load balancing policy.
519
+ message MaglevLbConfig {
520
+ // The table size for Maglev hashing. Maglev aims for "minimal disruption" rather than an absolute guarantee.
521
+ // Minimal disruption means that when the set of upstream hosts change, a connection will likely be sent to the same
522
+ // upstream as it was before. Increasing the table size reduces the amount of disruption.
523
+ // The table size must be prime number limited to 5000011. If it is not specified, the default is 65537.
524
+ google.protobuf.UInt64Value table_size = 1 [(validate.rules).uint64 = {lte: 5000011}];
525
+ }
526
+
527
+ // Specific configuration for the
528
+ // :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>`
529
+ // load balancing policy.
530
+ // [#extension: envoy.clusters.original_dst]
531
+ message OriginalDstLbConfig {
532
+ option (udpa.annotations.versioning).previous_message_type =
533
+ "envoy.api.v2.Cluster.OriginalDstLbConfig";
534
+
535
+ // When true, a HTTP header can be used to override the original dst address. The default header is
536
+ // :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>`.
537
+ //
538
+ // .. attention::
539
+ //
540
+ // This header isn't sanitized by default, so enabling this feature allows HTTP clients to
541
+ // route traffic to arbitrary hosts and/or ports, which may have serious security
542
+ // consequences.
543
+ //
544
+ // .. note::
545
+ //
546
+ // If the header appears multiple times only the first value is used.
547
+ bool use_http_header = 1;
548
+
549
+ // The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
550
+ // is set to true. If the value is empty, :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>` will be used.
551
+ string http_header_name = 2;
552
+
553
+ // The port to override for the original dst address. This port
554
+ // will take precedence over filter state and header override ports
555
+ google.protobuf.UInt32Value upstream_port_override = 3 [(validate.rules).uint32 = {lte: 65535}];
556
+
557
+ // The dynamic metadata key to override destination address.
558
+ // First the request metadata is considered, then the connection one.
559
+ type.metadata.v3.MetadataKey metadata_key = 4;
560
+ }
561
+
562
+ // Common configuration for all load balancer implementations.
563
+ // [#next-free-field: 9]
564
+ message CommonLbConfig {
565
+ option (udpa.annotations.versioning).previous_message_type =
566
+ "envoy.api.v2.Cluster.CommonLbConfig";
567
+
568
+ // Configuration for :ref:`zone aware routing
569
+ // <arch_overview_load_balancing_zone_aware_routing>`.
570
+ message ZoneAwareLbConfig {
571
+ option (udpa.annotations.versioning).previous_message_type =
572
+ "envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig";
573
+
574
+ // Configures percentage of requests that will be considered for zone aware routing
575
+ // if zone aware routing is configured. If not specified, the default is 100%.
576
+ // * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
577
+ // * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
578
+ type.v3.Percent routing_enabled = 1;
579
+
580
+ // Configures minimum upstream cluster size required for zone aware routing
581
+ // If upstream cluster size is less than specified, zone aware routing is not performed
582
+ // even if zone aware routing is configured. If not specified, the default is 6.
583
+ // * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
584
+ // * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
585
+ google.protobuf.UInt64Value min_cluster_size = 2;
586
+
587
+ // If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic
588
+ // mode<arch_overview_load_balancing_panic_threshold>`. Instead, the cluster will fail all
589
+ // requests as if all hosts are unhealthy. This can help avoid potentially overwhelming a
590
+ // failing service.
591
+ bool fail_traffic_on_panic = 3;
592
+ }
593
+
594
+ // Configuration for :ref:`locality weighted load balancing
595
+ // <arch_overview_load_balancing_locality_weighted_lb>`
596
+ message LocalityWeightedLbConfig {
597
+ option (udpa.annotations.versioning).previous_message_type =
598
+ "envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig";
599
+ }
600
+
601
+ // Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)
602
+ message ConsistentHashingLbConfig {
603
+ option (udpa.annotations.versioning).previous_message_type =
604
+ "envoy.api.v2.Cluster.CommonLbConfig.ConsistentHashingLbConfig";
605
+
606
+ // If set to ``true``, the cluster will use hostname instead of the resolved
607
+ // address as the key to consistently hash to an upstream host. Only valid for StrictDNS clusters with hostnames which resolve to a single IP address.
608
+ bool use_hostname_for_hashing = 1;
609
+
610
+ // Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150
611
+ // no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster.
612
+ // If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200.
613
+ // Minimum is 100.
614
+ //
615
+ // Applies to both Ring Hash and Maglev load balancers.
616
+ //
617
+ // This is implemented based on the method described in the paper https://arxiv.org/abs/1608.01350. For the specified
618
+ // ``hash_balance_factor``, requests to any upstream host are capped at ``hash_balance_factor/100`` times the average number of requests
619
+ // across the cluster. When a request arrives for an upstream host that is currently serving at its max capacity, linear probing
620
+ // is used to identify an eligible host. Further, the linear probe is implemented using a random jump in hosts ring/table to identify
621
+ // the eligible host (this technique is as described in the paper https://arxiv.org/abs/1908.08762 - the random jump avoids the
622
+ // cascading overflow effect when choosing the next host in the ring/table).
623
+ //
624
+ // If weights are specified on the hosts, they are respected.
625
+ //
626
+ // This is an O(N) algorithm, unlike other load balancers. Using a lower ``hash_balance_factor`` results in more hosts
627
+ // being probed, so use a higher value if you require better performance.
628
+ google.protobuf.UInt32Value hash_balance_factor = 2 [(validate.rules).uint32 = {gte: 100}];
629
+ }
630
+
631
+ // Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
632
+ // If not specified, the default is 50%.
633
+ // To disable panic mode, set to 0%.
634
+ //
635
+ // .. note::
636
+ // The specified percent will be truncated to the nearest 1%.
637
+ type.v3.Percent healthy_panic_threshold = 1;
638
+
639
+ oneof locality_config_specifier {
640
+ ZoneAwareLbConfig zone_aware_lb_config = 2;
641
+
642
+ LocalityWeightedLbConfig locality_weighted_lb_config = 3;
643
+ }
644
+
645
+ // If set, all health check/weight/metadata updates that happen within this duration will be
646
+ // merged and delivered in one shot when the duration expires. The start of the duration is when
647
+ // the first update happens. This is useful for big clusters, with potentially noisy deploys
648
+ // that might trigger excessive CPU usage due to a constant stream of healthcheck state changes
649
+ // or metadata updates. The first set of updates to be seen apply immediately (e.g.: a new
650
+ // cluster). Please always keep in mind that the use of sandbox technologies may change this
651
+ // behavior.
652
+ //
653
+ // If this is not set, we default to a merge window of 1000ms. To disable it, set the merge
654
+ // window to 0.
655
+ //
656
+ // .. note::
657
+ // Merging does not apply to cluster membership changes (e.g.: adds/removes); this is
658
+ // because merging those updates isn't currently safe. See
659
+ // https://github.com/envoyproxy/envoy/pull/3941.
660
+ google.protobuf.Duration update_merge_window = 4;
661
+
662
+ // If set to true, Envoy will :ref:`exclude <arch_overview_load_balancing_excluded>` new hosts
663
+ // when computing load balancing weights until they have been health checked for the first time.
664
+ // This will have no effect unless active health checking is also configured.
665
+ bool ignore_new_hosts_until_first_hc = 5;
666
+
667
+ // If set to ``true``, the cluster manager will drain all existing
668
+ // connections to upstream hosts whenever hosts are added or removed from the cluster.
669
+ bool close_connections_on_host_set_change = 6;
670
+
671
+ // Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)
672
+ ConsistentHashingLbConfig consistent_hashing_lb_config = 7;
673
+
674
+ // This controls what hosts are considered valid when using
675
+ // :ref:`host overrides <arch_overview_load_balancing_override_host>`, which is used by some
676
+ // filters to modify the load balancing decision.
677
+ //
678
+ // If this is unset then [UNKNOWN, HEALTHY, DEGRADED] will be applied by default. If this is
679
+ // set with an empty set of statuses then host overrides will be ignored by the load balancing.
680
+ core.v3.HealthStatusSet override_host_status = 8;
681
+ }
682
+
683
+ message RefreshRate {
684
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.Cluster.RefreshRate";
685
+
686
+ // Specifies the base interval between refreshes. This parameter is required and must be greater
687
+ // than zero and less than
688
+ // :ref:`max_interval <envoy_v3_api_field_config.cluster.v3.Cluster.RefreshRate.max_interval>`.
689
+ google.protobuf.Duration base_interval = 1 [(validate.rules).duration = {
690
+ required: true
691
+ gt {nanos: 1000000}
692
+ }];
693
+
694
+ // Specifies the maximum interval between refreshes. This parameter is optional, but must be
695
+ // greater than or equal to the
696
+ // :ref:`base_interval <envoy_v3_api_field_config.cluster.v3.Cluster.RefreshRate.base_interval>` if set. The default
697
+ // is 10 times the :ref:`base_interval <envoy_v3_api_field_config.cluster.v3.Cluster.RefreshRate.base_interval>`.
698
+ google.protobuf.Duration max_interval = 2 [(validate.rules).duration = {gt {nanos: 1000000}}];
699
+ }
700
+
701
+ message PreconnectPolicy {
702
+ // Indicates how many streams (rounded up) can be anticipated per-upstream for each
703
+ // incoming stream. This is useful for high-QPS or latency-sensitive services. Preconnecting
704
+ // will only be done if the upstream is healthy and the cluster has traffic.
705
+ //
706
+ // For example if this is 2, for an incoming HTTP/1.1 stream, 2 connections will be
707
+ // established, one for the new incoming stream, and one for a presumed follow-up stream. For
708
+ // HTTP/2, only one connection would be established by default as one connection can
709
+ // serve both the original and presumed follow-up stream.
710
+ //
711
+ // In steady state for non-multiplexed connections a value of 1.5 would mean if there were 100
712
+ // active streams, there would be 100 connections in use, and 50 connections preconnected.
713
+ // This might be a useful value for something like short lived single-use connections,
714
+ // for example proxying HTTP/1.1 if keep-alive were false and each stream resulted in connection
715
+ // termination. It would likely be overkill for long lived connections, such as TCP proxying SMTP
716
+ // or regular HTTP/1.1 with keep-alive. For long lived traffic, a value of 1.05 would be more
717
+ // reasonable, where for every 100 connections, 5 preconnected connections would be in the queue
718
+ // in case of unexpected disconnects where the connection could not be reused.
719
+ //
720
+ // If this value is not set, or set explicitly to one, Envoy will fetch as many connections
721
+ // as needed to serve streams in flight. This means in steady state if a connection is torn down,
722
+ // a subsequent streams will pay an upstream-rtt latency penalty waiting for a new connection.
723
+ //
724
+ // This is limited somewhat arbitrarily to 3 because preconnecting too aggressively can
725
+ // harm latency more than the preconnecting helps.
726
+ google.protobuf.DoubleValue per_upstream_preconnect_ratio = 1
727
+ [(validate.rules).double = {lte: 3.0 gte: 1.0}];
728
+
729
+ // Indicates how many streams (rounded up) can be anticipated across a cluster for each
730
+ // stream, useful for low QPS services. This is currently supported for a subset of
731
+ // deterministic non-hash-based load-balancing algorithms (weighted round robin, random).
732
+ // Unlike ``per_upstream_preconnect_ratio`` this preconnects across the upstream instances in a
733
+ // cluster, doing best effort predictions of what upstream would be picked next and
734
+ // pre-establishing a connection.
735
+ //
736
+ // Preconnecting will be limited to one preconnect per configured upstream in the cluster and will
737
+ // only be done if there are healthy upstreams and the cluster has traffic.
738
+ //
739
+ // For example if preconnecting is set to 2 for a round robin HTTP/2 cluster, on the first
740
+ // incoming stream, 2 connections will be preconnected - one to the first upstream for this
741
+ // cluster, one to the second on the assumption there will be a follow-up stream.
742
+ //
743
+ // If this value is not set, or set explicitly to one, Envoy will fetch as many connections
744
+ // as needed to serve streams in flight, so during warm up and in steady state if a connection
745
+ // is closed (and per_upstream_preconnect_ratio is not set), there will be a latency hit for
746
+ // connection establishment.
747
+ //
748
+ // If both this and preconnect_ratio are set, Envoy will make sure both predicted needs are met,
749
+ // basically preconnecting max(predictive-preconnect, per-upstream-preconnect), for each
750
+ // upstream.
751
+ //
752
+ // This is limited somewhat arbitrarily to 3 because preconnecting too aggressively can
753
+ // harm latency more than the preconnecting helps.
754
+ google.protobuf.DoubleValue predictive_preconnect_ratio = 2
755
+ [(validate.rules).double = {lte: 3.0 gte: 1.0}];
756
+ }
757
+
758
+ reserved 12, 15, 7, 11, 35;
759
+
760
+ reserved "hosts", "tls_context", "extension_protocol_options";
761
+
762
+ // Configuration to use different transport sockets for different endpoints. The entry of
763
+ // ``envoy.transport_socket_match`` in the :ref:`LbEndpoint.Metadata
764
+ // <envoy_v3_api_field_config.endpoint.v3.LbEndpoint.metadata>` is used to match against the
765
+ // transport sockets as they appear in the list. If a match is not found, the search continues in
766
+ // :ref:`LocalityLbEndpoints.Metadata
767
+ // <envoy_v3_api_field_config.endpoint.v3.LocalityLbEndpoints.metadata>`. The first :ref:`match
768
+ // <envoy_v3_api_msg_config.cluster.v3.Cluster.TransportSocketMatch>` is used. For example, with
769
+ // the following match
770
+ //
771
+ // .. code-block:: yaml
772
+ //
773
+ // transport_socket_matches:
774
+ // - name: "enableMTLS"
775
+ // match:
776
+ // acceptMTLS: true
777
+ // transport_socket:
778
+ // name: envoy.transport_sockets.tls
779
+ // config: { ... } # tls socket configuration
780
+ // - name: "defaultToPlaintext"
781
+ // match: {}
782
+ // transport_socket:
783
+ // name: envoy.transport_sockets.raw_buffer
784
+ //
785
+ // Connections to the endpoints whose metadata value under ``envoy.transport_socket_match``
786
+ // having "acceptMTLS"/"true" key/value pair use the "enableMTLS" socket configuration.
787
+ //
788
+ // If a :ref:`socket match <envoy_v3_api_msg_config.cluster.v3.Cluster.TransportSocketMatch>` with empty match
789
+ // criteria is provided, that always match any endpoint. For example, the "defaultToPlaintext"
790
+ // socket match in case above.
791
+ //
792
+ // If an endpoint metadata's value under ``envoy.transport_socket_match`` does not match any
793
+ // ``TransportSocketMatch``, the locality metadata is then checked for a match. Barring any
794
+ // matches in the endpoint or locality metadata, the socket configuration fallbacks to use the
795
+ // ``tls_context`` or ``transport_socket`` specified in this cluster.
796
+ //
797
+ // This field allows gradual and flexible transport socket configuration changes.
798
+ //
799
+ // The metadata of endpoints in EDS can indicate transport socket capabilities. For example,
800
+ // an endpoint's metadata can have two key value pairs as "acceptMTLS": "true",
801
+ // "acceptPlaintext": "true". While some other endpoints, only accepting plaintext traffic
802
+ // has "acceptPlaintext": "true" metadata information.
803
+ //
804
+ // Then the xDS server can configure the CDS to a client, Envoy A, to send mutual TLS
805
+ // traffic for endpoints with "acceptMTLS": "true", by adding a corresponding
806
+ // ``TransportSocketMatch`` in this field. Other client Envoys receive CDS without
807
+ // ``transport_socket_match`` set, and still send plain text traffic to the same cluster.
808
+ //
809
+ // This field can be used to specify custom transport socket configurations for health
810
+ // checks by adding matching key/value pairs in a health check's
811
+ // :ref:`transport socket match criteria <envoy_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>` field.
812
+ //
813
+ // [#comment:TODO(incfly): add a detailed architecture doc on intended usage.]
814
+ repeated TransportSocketMatch transport_socket_matches = 43;
815
+
816
+ // Optional matcher that selects a transport socket from
817
+ // :ref:`transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
818
+ //
819
+ // This matcher uses the generic xDS matcher framework to select a named transport socket
820
+ // based on various inputs available at transport socket selection time.
821
+ //
822
+ // Supported matching inputs:
823
+ //
824
+ // * ``endpoint_metadata``: Extract values from the selected endpoint's metadata.
825
+ // * ``locality_metadata``: Extract values from the endpoint's locality metadata.
826
+ // * ``transport_socket_filter_state``: Extract values from filter state that was explicitly shared from
827
+ // downstream to upstream via ``TransportSocketOptions``. This enables flexible
828
+ // downstream-connection-based matching, such as:
829
+ //
830
+ // - Network namespace matching.
831
+ // - Custom connection attributes.
832
+ // - Any data explicitly passed via filter state.
833
+ //
834
+ // .. note::
835
+ // Filter state sharing follows the same pattern as tunneling in Envoy. Filters must explicitly
836
+ // share data by setting filter state with the appropriate sharing mode. The filter state is
837
+ // then accessible via the ``transport_socket_filter_state`` input during transport socket selection.
838
+ //
839
+ // If this field is set, it takes precedence over legacy metadata-based selection
840
+ // performed by :ref:`transport_socket_matches
841
+ // <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>` alone.
842
+ // If the matcher does not yield a match, Envoy uses the default transport socket
843
+ // configured for the cluster.
844
+ //
845
+ // When using this field, each entry in
846
+ // :ref:`transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`
847
+ // must have a unique ``name``. The matcher outcome is expected to reference one of
848
+ // these names.
849
+ xds.type.matcher.v3.Matcher transport_socket_matcher = 59;
850
+
851
+ // Supplies the name of the cluster which must be unique across all clusters.
852
+ // The cluster name is used when emitting
853
+ // :ref:`statistics <config_cluster_manager_cluster_stats>` if :ref:`alt_stat_name
854
+ // <envoy_v3_api_field_config.cluster.v3.Cluster.alt_stat_name>` is not provided.
855
+ // Any ``:`` in the cluster name will be converted to ``_`` when emitting statistics.
856
+ string name = 1 [(validate.rules).string = {min_len: 1}];
857
+
858
+ // An optional alternative to the cluster name to be used for observability. This name is used
859
+ // for emitting stats for the cluster and access logging the cluster name. This will appear as
860
+ // additional information in configuration dumps of a cluster's current status as
861
+ // :ref:`observability_name <envoy_v3_api_field_admin.v3.ClusterStatus.observability_name>`
862
+ // and as an additional tag "upstream_cluster.name" while tracing.
863
+ //
864
+ // .. note::
865
+ // Any ``:`` in the name will be converted to ``_`` when emitting statistics. This should not be confused with
866
+ // :ref:`Router Filter Header <config_http_filters_router_x-envoy-upstream-alt-stat-name>`.
867
+ string alt_stat_name = 28 [(udpa.annotations.field_migrate).rename = "observability_name"];
868
+
869
+ oneof cluster_discovery_type {
870
+ // The :ref:`service discovery type <arch_overview_service_discovery_types>`
871
+ // to use for resolving the cluster.
872
+ DiscoveryType type = 2 [(validate.rules).enum = {defined_only: true}];
873
+
874
+ // The custom cluster type.
875
+ CustomClusterType cluster_type = 38;
876
+ }
877
+
878
+ // Configuration to use for EDS updates for the Cluster.
879
+ EdsClusterConfig eds_cluster_config = 3;
880
+
881
+ // The timeout for new network connections to hosts in the cluster.
882
+ // If not set, a default value of 5s will be used.
883
+ google.protobuf.Duration connect_timeout = 4 [(validate.rules).duration = {gt {}}];
884
+
885
+ // Soft limit on size of the cluster’s connections read and write buffers. If
886
+ // unspecified, an implementation defined default is applied (1MiB).
887
+ google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5
888
+ [(udpa.annotations.security).configure_for_untrusted_upstream = true];
889
+
890
+ // The :ref:`load balancer type <arch_overview_load_balancing_types>` to use
891
+ // when picking a host in the cluster.
892
+ LbPolicy lb_policy = 6 [(validate.rules).enum = {defined_only: true}];
893
+
894
+ // Setting this is required for specifying members of
895
+ // :ref:`STATIC<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STATIC>`,
896
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
897
+ // or :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>` clusters.
898
+ // This field supersedes the ``hosts`` field in the v2 API.
899
+ //
900
+ // .. attention::
901
+ //
902
+ // Setting this allows non-EDS cluster types to contain embedded EDS equivalent
903
+ // :ref:`endpoint assignments<envoy_v3_api_msg_config.endpoint.v3.ClusterLoadAssignment>`.
904
+ //
905
+ endpoint.v3.ClusterLoadAssignment load_assignment = 33;
906
+
907
+ // Optional :ref:`active health checking <arch_overview_health_checking>`
908
+ // configuration for the cluster. If no
909
+ // configuration is specified no health checking will be done and all cluster
910
+ // members will be considered healthy at all times.
911
+ repeated core.v3.HealthCheck health_checks = 8;
912
+
913
+ // Optional maximum requests for a single upstream connection. This parameter
914
+ // is respected by both the HTTP/1.1 and HTTP/2 connection pool
915
+ // implementations. If not specified, there is no limit. Setting this
916
+ // parameter to 1 will effectively disable keep alive.
917
+ //
918
+ // .. attention::
919
+ // This field has been deprecated in favor of the :ref:`max_requests_per_connection <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.max_requests_per_connection>` field.
920
+ google.protobuf.UInt32Value max_requests_per_connection = 9
921
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
922
+
923
+ // Optional :ref:`circuit breaking <arch_overview_circuit_break>` for the cluster.
924
+ CircuitBreakers circuit_breakers = 10;
925
+
926
+ // HTTP protocol options that are applied only to upstream HTTP connections.
927
+ // These options apply to all HTTP versions.
928
+ // This has been deprecated in favor of
929
+ // :ref:`upstream_http_protocol_options <envoy_v3_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>`
930
+ // in the :ref:`http_protocol_options <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message.
931
+ // upstream_http_protocol_options can be set via the cluster's
932
+ // :ref:`extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`.
933
+ // See :ref:`upstream_http_protocol_options
934
+ // <envoy_v3_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>`
935
+ // for example usage.
936
+ core.v3.UpstreamHttpProtocolOptions upstream_http_protocol_options = 46
937
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
938
+
939
+ // Additional options when handling HTTP requests upstream. These options will be applicable to
940
+ // both HTTP1 and HTTP2 requests.
941
+ // This has been deprecated in favor of
942
+ // :ref:`common_http_protocol_options <envoy_v3_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.common_http_protocol_options>`
943
+ // in the :ref:`http_protocol_options <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message.
944
+ // common_http_protocol_options can be set via the cluster's
945
+ // :ref:`extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`.
946
+ // See :ref:`upstream_http_protocol_options
947
+ // <envoy_v3_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>`
948
+ // for example usage.
949
+ core.v3.HttpProtocolOptions common_http_protocol_options = 29
950
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
951
+
952
+ // Additional options when handling HTTP1 requests.
953
+ // This has been deprecated in favor of http_protocol_options fields in the
954
+ // :ref:`http_protocol_options <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message.
955
+ // http_protocol_options can be set via the cluster's
956
+ // :ref:`extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`.
957
+ // See :ref:`upstream_http_protocol_options
958
+ // <envoy_v3_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>`
959
+ // for example usage.
960
+ core.v3.Http1ProtocolOptions http_protocol_options = 13
961
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
962
+
963
+ // Even if default HTTP2 protocol options are desired, this field must be
964
+ // set so that Envoy will assume that the upstream supports HTTP/2 when
965
+ // making new HTTP connection pool connections. Currently, Envoy only
966
+ // supports prior knowledge for upstream connections. Even if TLS is used
967
+ // with ALPN, ``http2_protocol_options`` must be specified. As an aside this allows HTTP/2
968
+ // connections to happen over plain text.
969
+ // This has been deprecated in favor of http2_protocol_options fields in the
970
+ // :ref:`http_protocol_options <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>`
971
+ // message. http2_protocol_options can be set via the cluster's
972
+ // :ref:`extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`.
973
+ // See :ref:`upstream_http_protocol_options
974
+ // <envoy_v3_api_field_extensions.upstreams.http.v3.HttpProtocolOptions.upstream_http_protocol_options>`
975
+ // for example usage.
976
+ core.v3.Http2ProtocolOptions http2_protocol_options = 14 [
977
+ deprecated = true,
978
+ (udpa.annotations.security).configure_for_untrusted_upstream = true,
979
+ (envoy.annotations.deprecated_at_minor_version) = "3.0"
980
+ ];
981
+
982
+ // The extension_protocol_options field is used to provide extension-specific protocol options
983
+ // for upstream connections. The key should match the extension filter name, such as
984
+ // "envoy.filters.network.thrift_proxy". See the extension's documentation for details on
985
+ // specific options.
986
+ // [#next-major-version: make this a list of typed extensions.]
987
+ // [#extension-category: envoy.upstream_options]
988
+ map<string, google.protobuf.Any> typed_extension_protocol_options = 36;
989
+
990
+ // If the DNS refresh rate is specified and the cluster type is either
991
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
992
+ // or :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`,
993
+ // this value is used as the cluster’s DNS refresh
994
+ // rate. The value configured must be at least 1ms. If this setting is not specified, the
995
+ // value defaults to 5000ms. For cluster types other than
996
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
997
+ // and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
998
+ // this setting is ignored.
999
+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1000
+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1001
+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1002
+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1003
+ google.protobuf.Duration dns_refresh_rate = 16 [
1004
+ deprecated = true,
1005
+ (validate.rules).duration = {gt {nanos: 1000000}},
1006
+ (envoy.annotations.deprecated_at_minor_version) = "3.0"
1007
+ ];
1008
+
1009
+ // DNS jitter can be optionally specified if the cluster type is either
1010
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
1011
+ // or :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`.
1012
+ // DNS jitter causes the cluster to refresh DNS entries later by a random amount of time to avoid a
1013
+ // stampede of DNS requests. This value sets the upper bound (exclusive) for the random amount.
1014
+ // There will be no jitter if this value is omitted. For cluster types other than
1015
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
1016
+ // and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
1017
+ // this setting is ignored.
1018
+ // This field is deprecated in favor of using the :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.
1022
+ google.protobuf.Duration dns_jitter = 58 [
1023
+ deprecated = true,
1024
+ (validate.rules).duration = {gte {}},
1025
+ (envoy.annotations.deprecated_at_minor_version) = "3.0"
1026
+ ];
1027
+
1028
+ // If the DNS failure refresh rate is specified and the cluster type is either
1029
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
1030
+ // or :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`,
1031
+ // this is used as the cluster’s DNS refresh rate when requests are failing. If this setting is
1032
+ // not specified, the failure refresh rate defaults to the DNS refresh rate. For cluster types
1033
+ // other than :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>` and
1034
+ // :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>` this setting is
1035
+ // ignored.
1036
+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1037
+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1038
+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1039
+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1040
+ RefreshRate dns_failure_refresh_rate = 44
1041
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1042
+
1043
+ // Optional configuration for setting cluster's DNS refresh rate. If the value is set to true,
1044
+ // cluster's DNS refresh rate will be set to resource record's TTL which comes from DNS
1045
+ // resolution.
1046
+ // This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1047
+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1048
+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1049
+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1050
+ bool respect_dns_ttl = 39
1051
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1052
+
1053
+ // The DNS IP address resolution policy. If this setting is not specified, the
1054
+ // value defaults to
1055
+ // :ref:`AUTO<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DnsLookupFamily.AUTO>`.
1056
+ // For logical and strict dns cluster, this field is deprecated in favor of using the
1057
+ // :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1058
+ // extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1059
+ // If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1060
+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1061
+ DnsLookupFamily dns_lookup_family = 17 [(validate.rules).enum = {defined_only: true}];
1062
+
1063
+ // If DNS resolvers are specified and the cluster type is either
1064
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
1065
+ // or :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`,
1066
+ // this value is used to specify the cluster’s dns resolvers.
1067
+ // If this setting is not specified, the value defaults to the default
1068
+ // resolver, which uses /etc/resolv.conf for configuration. For cluster types
1069
+ // other than
1070
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
1071
+ // and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
1072
+ // this setting is ignored.
1073
+ // This field is deprecated in favor of ``dns_resolution_config``
1074
+ // which aggregates all of the DNS resolver configuration in a single message.
1075
+ repeated core.v3.Address dns_resolvers = 18
1076
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1077
+
1078
+ // Always use TCP queries instead of UDP queries for DNS lookups.
1079
+ // This field is deprecated in favor of ``dns_resolution_config``
1080
+ // which aggregates all of the DNS resolver configuration in a single message.
1081
+ bool use_tcp_for_dns_lookups = 45
1082
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1083
+
1084
+ // DNS resolution configuration which includes the underlying dns resolver addresses and options.
1085
+ // This field is deprecated in favor of
1086
+ // :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.cluster.v3.Cluster.typed_dns_resolver_config>`.
1087
+ core.v3.DnsResolutionConfig dns_resolution_config = 53
1088
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1089
+
1090
+ // DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
1091
+ // or any other DNS resolver types and the related parameters.
1092
+ // For example, an object of
1093
+ // :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
1094
+ // can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
1095
+ // :ref:`dns_resolution_config <envoy_v3_api_field_config.cluster.v3.Cluster.dns_resolution_config>`
1096
+ // configuration.
1097
+ // During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
1098
+ // when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
1099
+ // When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
1100
+ // Also note that this field is deprecated for logical dns and strict dns clusters and will be ignored when
1101
+ // :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1102
+ // :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1103
+ // [#extension-category: envoy.network.dns_resolver]
1104
+ core.v3.TypedExtensionConfig typed_dns_resolver_config = 55;
1105
+
1106
+ // Optional configuration for having cluster readiness block on warm-up. Currently, only applicable for
1107
+ // :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
1108
+ // or :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`,
1109
+ // or :ref:`Redis Cluster<arch_overview_redis>`.
1110
+ // If true, cluster readiness blocks on warm-up. If false, the cluster will complete
1111
+ // initialization whether or not warm-up has completed. Defaults to true.
1112
+ google.protobuf.BoolValue wait_for_warm_on_init = 54;
1113
+
1114
+ // If specified, outlier detection will be enabled for this upstream cluster.
1115
+ // Each of the configuration values can be overridden via
1116
+ // :ref:`runtime values <config_cluster_manager_cluster_runtime_outlier_detection>`.
1117
+ OutlierDetection outlier_detection = 19;
1118
+
1119
+ // The interval for removing stale hosts from a cluster type
1120
+ // :ref:`ORIGINAL_DST<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.ORIGINAL_DST>`.
1121
+ // Hosts are considered stale if they have not been used
1122
+ // as upstream destinations during this interval. New hosts are added
1123
+ // to original destination clusters on demand as new connections are
1124
+ // redirected to Envoy, causing the number of hosts in the cluster to
1125
+ // grow over time. Hosts that are not stale (they are actively used as
1126
+ // destinations) are kept in the cluster, which allows connections to
1127
+ // them remain open, saving the latency that would otherwise be spent
1128
+ // on opening new connections. If this setting is not specified, the
1129
+ // value defaults to 5000ms. For cluster types other than
1130
+ // :ref:`ORIGINAL_DST<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.ORIGINAL_DST>`
1131
+ // this setting is ignored.
1132
+ google.protobuf.Duration cleanup_interval = 20 [(validate.rules).duration = {gt {}}];
1133
+
1134
+ // Optional configuration used to bind newly established upstream connections.
1135
+ // This overrides any bind_config specified in the bootstrap proto.
1136
+ // If the address and port are empty, no bind will be performed.
1137
+ core.v3.BindConfig upstream_bind_config = 21;
1138
+
1139
+ // Configuration for load balancing subsetting.
1140
+ LbSubsetConfig lb_subset_config = 22;
1141
+
1142
+ // Optional configuration for the load balancing algorithm selected by
1143
+ // LbPolicy. Currently only
1144
+ // :ref:`RING_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbPolicy.RING_HASH>`,
1145
+ // :ref:`MAGLEV<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbPolicy.MAGLEV>` and
1146
+ // :ref:`LEAST_REQUEST<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbPolicy.LEAST_REQUEST>`
1147
+ // has additional configuration options.
1148
+ // Specifying ring_hash_lb_config or maglev_lb_config or least_request_lb_config without setting the corresponding
1149
+ // LbPolicy will generate an error at runtime.
1150
+ oneof lb_config {
1151
+ // Optional configuration for the Ring Hash load balancing policy.
1152
+ RingHashLbConfig ring_hash_lb_config = 23;
1153
+
1154
+ // Optional configuration for the Maglev load balancing policy.
1155
+ MaglevLbConfig maglev_lb_config = 52;
1156
+
1157
+ // Optional configuration for the Original Destination load balancing policy.
1158
+ OriginalDstLbConfig original_dst_lb_config = 34;
1159
+
1160
+ // Optional configuration for the LeastRequest load balancing policy.
1161
+ LeastRequestLbConfig least_request_lb_config = 37;
1162
+
1163
+ // Optional configuration for the RoundRobin load balancing policy.
1164
+ RoundRobinLbConfig round_robin_lb_config = 56;
1165
+ }
1166
+
1167
+ // Common configuration for all load balancer implementations.
1168
+ CommonLbConfig common_lb_config = 27;
1169
+
1170
+ // Optional custom transport socket implementation to use for upstream connections.
1171
+ // To setup TLS, set a transport socket with name ``envoy.transport_sockets.tls`` and
1172
+ // :ref:`UpstreamTlsContexts <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.UpstreamTlsContext>` in the ``typed_config``.
1173
+ // If no transport socket configuration is specified, new connections
1174
+ // will be set up with plaintext.
1175
+ core.v3.TransportSocket transport_socket = 24;
1176
+
1177
+ // The Metadata field can be used to provide additional information about the
1178
+ // cluster. It can be used for stats, logging, and varying filter behavior.
1179
+ // Fields should use reverse DNS notation to denote which entity within Envoy
1180
+ // will need the information. For instance, if the metadata is intended for
1181
+ // the Router filter, the filter name should be specified as ``envoy.filters.http.router``.
1182
+ core.v3.Metadata metadata = 25;
1183
+
1184
+ // Determines how Envoy selects the protocol used to speak to upstream hosts.
1185
+ // This has been deprecated in favor of setting explicit protocol selection
1186
+ // in the :ref:`http_protocol_options
1187
+ // <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` message.
1188
+ // http_protocol_options can be set via the cluster's
1189
+ // :ref:`extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`.
1190
+ ClusterProtocolSelection protocol_selection = 26
1191
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1192
+
1193
+ // Optional options for upstream connections.
1194
+ UpstreamConnectionOptions upstream_connection_options = 30;
1195
+
1196
+ // If an upstream host becomes unhealthy (as determined by the configured health checks
1197
+ // or outlier detection), immediately close all connections to the failed host.
1198
+ //
1199
+ // .. note::
1200
+ //
1201
+ // This is currently only supported for connections created by tcp_proxy.
1202
+ //
1203
+ // .. note::
1204
+ //
1205
+ // The current implementation of this feature closes all connections immediately when
1206
+ // the unhealthy status is detected. If there are a large number of connections open
1207
+ // to an upstream host that becomes unhealthy, Envoy may spend a substantial amount of
1208
+ // time exclusively closing these connections, and not processing any other traffic.
1209
+ bool close_connections_on_host_health_failure = 31;
1210
+
1211
+ // If set to true, Envoy will ignore the health value of a host when processing its removal
1212
+ // from service discovery. This means that if active health checking is used, Envoy will *not*
1213
+ // wait for the endpoint to go unhealthy before removing it.
1214
+ bool ignore_health_on_host_removal = 32;
1215
+
1216
+ // An (optional) network filter chain, listed in the order the filters should be applied.
1217
+ // The chain will be applied to all outgoing connections that Envoy makes to the upstream
1218
+ // servers of this cluster.
1219
+ repeated Filter filters = 40;
1220
+
1221
+ // If this field is set and is supported by the client, it will supersede the value of
1222
+ // :ref:`lb_policy<envoy_v3_api_field_config.cluster.v3.Cluster.lb_policy>`.
1223
+ LoadBalancingPolicy load_balancing_policy = 41;
1224
+
1225
+ // [#not-implemented-hide:]
1226
+ // If present, tells the client where to send load reports via LRS. If not present, the
1227
+ // client will fall back to a client-side default, which may be either (a) don't send any
1228
+ // load reports or (b) send load reports for all clusters to a single default server
1229
+ // (which may be configured in the bootstrap file).
1230
+ //
1231
+ // Note that if multiple clusters point to the same LRS server, the client may choose to
1232
+ // create a separate stream for each cluster or it may choose to coalesce the data for
1233
+ // multiple clusters onto a single stream. Either way, the client must make sure to send
1234
+ // the data for any given cluster on no more than one stream.
1235
+ //
1236
+ // [#next-major-version: In the v3 API, we should consider restructuring this somehow,
1237
+ // maybe by allowing LRS to go on the ADS stream, or maybe by moving some of the negotiation
1238
+ // from the LRS stream here.]
1239
+ core.v3.ConfigSource lrs_server = 42;
1240
+
1241
+ // A list of metric names from :ref:`ORCA load reports <envoy_v3_api_msg_.xds.data.orca.v3.OrcaLoadReport>` to propagate to LRS.
1242
+ //
1243
+ // If not specified, then ORCA load reports will not be propagated to LRS.
1244
+ //
1245
+ // For map fields in the ORCA proto, the string will be of the form ``<map_field_name>.<map_key>``.
1246
+ // For example, the string ``named_metrics.foo`` will mean to look for the key ``foo`` in the ORCA
1247
+ // :ref:`named_metrics <envoy_v3_api_field_.xds.data.orca.v3.OrcaLoadReport.named_metrics>` field.
1248
+ //
1249
+ // The special map key ``*`` means to report all entries in the map (e.g., ``named_metrics.*`` means to
1250
+ // report all entries in the ORCA named_metrics field). Note that this should be used only with trusted
1251
+ // backends.
1252
+ //
1253
+ // The metric names in LRS will follow the same semantics as this field. In other words, if this field
1254
+ // contains ``named_metrics.foo``, then the LRS load report will include the data with that same string
1255
+ // as the key.
1256
+ repeated string lrs_report_endpoint_metrics = 57;
1257
+
1258
+ // If track_timeout_budgets is true, the :ref:`timeout budget histograms
1259
+ // <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
1260
+ // request. These show what percentage of a request's per try and global timeout was used. A value
1261
+ // of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
1262
+ // of 100 would indicate that the request took the entirety of the timeout given to it.
1263
+ //
1264
+ // .. attention::
1265
+ //
1266
+ // This field has been deprecated in favor of ``timeout_budgets``, part of
1267
+ // :ref:`track_cluster_stats <envoy_v3_api_field_config.cluster.v3.Cluster.track_cluster_stats>`.
1268
+ bool track_timeout_budgets = 47
1269
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
1270
+
1271
+ // Optional customization and configuration of upstream connection pool, and upstream type.
1272
+ //
1273
+ // Currently this field only applies for HTTP traffic but is designed for eventual use for custom
1274
+ // TCP upstreams.
1275
+ //
1276
+ // For HTTP traffic, Envoy will generally take downstream HTTP and send it upstream as upstream
1277
+ // HTTP, using the http connection pool and the codec from ``http2_protocol_options``
1278
+ //
1279
+ // For routes where CONNECT termination is configured, Envoy will take downstream CONNECT
1280
+ // requests and forward the CONNECT payload upstream over raw TCP using the tcp connection pool.
1281
+ //
1282
+ // The default pool used is the generic connection pool which creates the HTTP upstream for most
1283
+ // HTTP requests, and the TCP upstream if CONNECT termination is configured.
1284
+ //
1285
+ // If users desire custom connection pool or upstream behavior, for example terminating
1286
+ // CONNECT only if a custom filter indicates it is appropriate, the custom factories
1287
+ // can be registered and configured here.
1288
+ // [#extension-category: envoy.upstreams]
1289
+ core.v3.TypedExtensionConfig upstream_config = 48;
1290
+
1291
+ // Configuration to track optional cluster stats.
1292
+ TrackClusterStats track_cluster_stats = 49;
1293
+
1294
+ // Preconnect configuration for this cluster.
1295
+ PreconnectPolicy preconnect_policy = 50;
1296
+
1297
+ // If ``connection_pool_per_downstream_connection`` is true, the cluster will use a separate
1298
+ // connection pool for every downstream connection
1299
+ bool connection_pool_per_downstream_connection = 51;
1300
+ }
1301
+
1302
+ // Extensible load balancing policy configuration.
1303
+ //
1304
+ // Every LB policy defined via this mechanism will be identified via a unique name using reverse
1305
+ // DNS notation. If the policy needs configuration parameters, it must define a message for its
1306
+ // own configuration, which will be stored in the config field. The name of the policy will tell
1307
+ // clients which type of message they should expect to see in the config field.
1308
+ //
1309
+ // Note that there are cases where it is useful to be able to independently select LB policies
1310
+ // for choosing a locality and for choosing an endpoint within that locality. For example, a
1311
+ // given deployment may always use the same policy to choose the locality, but for choosing the
1312
+ // endpoint within the locality, some clusters may use weighted-round-robin, while others may
1313
+ // use some sort of session-based balancing.
1314
+ //
1315
+ // This can be accomplished via hierarchical LB policies, where the parent LB policy creates a
1316
+ // child LB policy for each locality. For each request, the parent chooses the locality and then
1317
+ // delegates to the child policy for that locality to choose the endpoint within the locality.
1318
+ //
1319
+ // To facilitate this, the config message for the top-level LB policy may include a field of
1320
+ // type LoadBalancingPolicy that specifies the child policy.
1321
+ message LoadBalancingPolicy {
1322
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.LoadBalancingPolicy";
1323
+
1324
+ message Policy {
1325
+ option (udpa.annotations.versioning).previous_message_type =
1326
+ "envoy.api.v2.LoadBalancingPolicy.Policy";
1327
+
1328
+ reserved 2, 1, 3;
1329
+
1330
+ reserved "config", "name", "typed_config";
1331
+
1332
+ // [#extension-category: envoy.load_balancing_policies]
1333
+ core.v3.TypedExtensionConfig typed_extension_config = 4;
1334
+ }
1335
+
1336
+ // Each client will iterate over the list in order and stop at the first policy that it
1337
+ // supports. This provides a mechanism for starting to use new LB policies that are not yet
1338
+ // supported by all clients.
1339
+ repeated Policy policies = 1;
1340
+ }
1341
+
1342
+ message UpstreamConnectionOptions {
1343
+ option (udpa.annotations.versioning).previous_message_type =
1344
+ "envoy.api.v2.UpstreamConnectionOptions";
1345
+
1346
+ enum FirstAddressFamilyVersion {
1347
+ // respect the native ranking of destination ip addresses returned from dns
1348
+ // resolution
1349
+ DEFAULT = 0;
1350
+
1351
+ V4 = 1;
1352
+
1353
+ V6 = 2;
1354
+ }
1355
+
1356
+ message HappyEyeballsConfig {
1357
+ // Specify the IP address family to attempt connection first in happy
1358
+ // eyeballs algorithm according to RFC8305#section-4.
1359
+ FirstAddressFamilyVersion first_address_family_version = 1;
1360
+
1361
+ // Specify the number of addresses of the first_address_family_version being
1362
+ // attempted for connection before the other address family.
1363
+ google.protobuf.UInt32Value first_address_family_count = 2 [(validate.rules).uint32 = {gte: 1}];
1364
+ }
1365
+
1366
+ // If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.
1367
+ core.v3.TcpKeepalive tcp_keepalive = 1;
1368
+
1369
+ // If enabled, associates the interface name of the local address with the upstream connection.
1370
+ // This can be used by extensions during processing of requests. The association mechanism is
1371
+ // implementation specific. Defaults to false due to performance concerns.
1372
+ bool set_local_interface_name_on_upstream_connections = 2;
1373
+
1374
+ // Configurations for happy eyeballs algorithm.
1375
+ // Add configs for first_address_family_version and first_address_family_count
1376
+ // when sorting destination ip addresses.
1377
+ HappyEyeballsConfig happy_eyeballs_config = 3;
1378
+ }
1379
+
1380
+ message TrackClusterStats {
1381
+ // If timeout_budgets is true, the :ref:`timeout budget histograms
1382
+ // <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
1383
+ // request. These show what percentage of a request's per try and global timeout was used. A value
1384
+ // of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
1385
+ // of 100 would indicate that the request took the entirety of the timeout given to it.
1386
+ bool timeout_budgets = 1;
1387
+
1388
+ // If request_response_sizes is true, then the :ref:`histograms
1389
+ // <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes
1390
+ // of requests and responses will be published. Additionally, number of headers in the requests and responses will be tracked.
1391
+ bool request_response_sizes = 2;
1392
+
1393
+ // If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
1394
+ // output.
1395
+ //
1396
+ // This does not currently output correct stats during a hot-restart.
1397
+ //
1398
+ // This is not currently implemented by all stat sinks.
1399
+ //
1400
+ // These stats do not honor filtering or tag extraction rules in :ref:`StatsConfig
1401
+ // <envoy_v3_api_msg_config.metrics.v3.StatsConfig>` (but fixed-value tags are supported). Admin
1402
+ // endpoint filtering is supported.
1403
+ //
1404
+ // This may not be used at the same time as
1405
+ // :ref:`load_stats_config <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.load_stats_config>`.
1406
+ bool per_endpoint_stats = 3;
1407
+ }