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,662 @@
1
+ syntax = "proto3";
2
+
3
+ package envoy.config.core.v3;
4
+
5
+ import "envoy/config/core/v3/address.proto";
6
+ import "envoy/config/core/v3/backoff.proto";
7
+ import "envoy/config/core/v3/http_uri.proto";
8
+ import "envoy/type/v3/percent.proto";
9
+ import "envoy/type/v3/semantic_version.proto";
10
+
11
+ import "google/protobuf/any.proto";
12
+ import "google/protobuf/struct.proto";
13
+ import "google/protobuf/wrappers.proto";
14
+
15
+ import "xds/core/v3/context_params.proto";
16
+
17
+ import "envoy/annotations/deprecation.proto";
18
+ import "udpa/annotations/migrate.proto";
19
+ import "udpa/annotations/status.proto";
20
+ import "udpa/annotations/versioning.proto";
21
+ import "validate/validate.proto";
22
+
23
+ option java_package = "io.envoyproxy.envoy.config.core.v3";
24
+ option java_outer_classname = "BaseProto";
25
+ option java_multiple_files = true;
26
+ option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3";
27
+ option (udpa.annotations.file_status).package_version_status = ACTIVE;
28
+
29
+ // [#protodoc-title: Common types]
30
+
31
+ // Envoy supports :ref:`upstream priority routing
32
+ // <arch_overview_http_routing_priority>` both at the route and the virtual
33
+ // cluster level. The current priority implementation uses different connection
34
+ // pool and circuit breaking settings for each priority level. This means that
35
+ // even for HTTP/2 requests, two physical connections will be used to an
36
+ // upstream host. In the future Envoy will likely support true HTTP/2 priority
37
+ // over a single upstream connection.
38
+ enum RoutingPriority {
39
+ DEFAULT = 0;
40
+ HIGH = 1;
41
+ }
42
+
43
+ // HTTP request method.
44
+ enum RequestMethod {
45
+ METHOD_UNSPECIFIED = 0;
46
+ GET = 1;
47
+ HEAD = 2;
48
+ POST = 3;
49
+ PUT = 4;
50
+ DELETE = 5;
51
+ CONNECT = 6;
52
+ OPTIONS = 7;
53
+ TRACE = 8;
54
+ PATCH = 9;
55
+ }
56
+
57
+ // Identifies the direction of the traffic relative to the local Envoy.
58
+ enum TrafficDirection {
59
+ // Default option is unspecified.
60
+ UNSPECIFIED = 0;
61
+
62
+ // The transport is used for incoming traffic.
63
+ INBOUND = 1;
64
+
65
+ // The transport is used for outgoing traffic.
66
+ OUTBOUND = 2;
67
+ }
68
+
69
+ // Identifies location of where either Envoy runs or where upstream hosts run.
70
+ message Locality {
71
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.Locality";
72
+
73
+ // Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
74
+ string region = 1;
75
+
76
+ // Defines the local service zone where Envoy is running. Though optional, it
77
+ // should be set if discovery service routing is used and the discovery
78
+ // service exposes :ref:`zone data <envoy_v3_api_field_config.endpoint.v3.LocalityLbEndpoints.locality>`,
79
+ // either in this message or via :option:`--service-zone`. The meaning of zone
80
+ // is context dependent, e.g. `Availability Zone (AZ)
81
+ // <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>`_
82
+ // on AWS, `Zone <https://cloud.google.com/compute/docs/regions-zones/>`_ on
83
+ // GCP, etc.
84
+ string zone = 2;
85
+
86
+ // When used for locality of upstream hosts, this field further splits zone
87
+ // into smaller chunks of sub-zones so they can be load balanced
88
+ // independently.
89
+ string sub_zone = 3;
90
+ }
91
+
92
+ // BuildVersion combines SemVer version of extension with free-form build information
93
+ // (i.e. 'alpha', 'private-build') as a set of strings.
94
+ message BuildVersion {
95
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.BuildVersion";
96
+
97
+ // SemVer version of extension.
98
+ type.v3.SemanticVersion version = 1;
99
+
100
+ // Free-form build information.
101
+ // Envoy defines several well known keys in the source/common/version/version.h file
102
+ google.protobuf.Struct metadata = 2;
103
+ }
104
+
105
+ // Version and identification for an Envoy extension.
106
+ // [#next-free-field: 7]
107
+ message Extension {
108
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.Extension";
109
+
110
+ // This is the name of the Envoy filter as specified in the Envoy
111
+ // configuration, e.g. envoy.filters.http.router, com.acme.widget.
112
+ string name = 1;
113
+
114
+ // Category of the extension.
115
+ // Extension category names use reverse DNS notation. For instance "envoy.filters.listener"
116
+ // for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from
117
+ // acme.com vendor.
118
+ // [#comment:TODO(yanavlasov): Link to the doc with existing envoy category names.]
119
+ string category = 2;
120
+
121
+ // [#not-implemented-hide:] Type descriptor of extension configuration proto.
122
+ // [#comment:TODO(yanavlasov): Link to the doc with existing configuration protos.]
123
+ // [#comment:TODO(yanavlasov): Add tests when PR #9391 lands.]
124
+ string type_descriptor = 3
125
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
126
+
127
+ // The version is a property of the extension and maintained independently
128
+ // of other extensions and the Envoy API.
129
+ // This field is not set when extension did not provide version information.
130
+ BuildVersion version = 4;
131
+
132
+ // Indicates that the extension is present but was disabled via dynamic configuration.
133
+ bool disabled = 5;
134
+
135
+ // Type URLs of extension configuration protos.
136
+ repeated string type_urls = 6;
137
+ }
138
+
139
+ // Identifies a specific Envoy instance. The node identifier is presented to the
140
+ // management server, which may use this identifier to distinguish per Envoy
141
+ // configuration for serving.
142
+ // [#next-free-field: 13]
143
+ message Node {
144
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.Node";
145
+
146
+ reserved 5;
147
+
148
+ reserved "build_version";
149
+
150
+ // An opaque node identifier for the Envoy node. This also provides the local
151
+ // service node name. It should be set if any of the following features are
152
+ // used: :ref:`statsd <arch_overview_statistics>`, :ref:`CDS
153
+ // <config_cluster_manager_cds>`, and :ref:`HTTP tracing
154
+ // <arch_overview_tracing>`, either in this message or via
155
+ // :option:`--service-node`.
156
+ string id = 1;
157
+
158
+ // Defines the local service cluster name where Envoy is running. Though
159
+ // optional, it should be set if any of the following features are used:
160
+ // :ref:`statsd <arch_overview_statistics>`, :ref:`health check cluster
161
+ // verification
162
+ // <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.service_name_matcher>`,
163
+ // :ref:`runtime override directory <envoy_v3_api_msg_config.bootstrap.v3.Runtime>`,
164
+ // :ref:`user agent addition
165
+ // <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.add_user_agent>`,
166
+ // :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`,
167
+ // :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing
168
+ // <arch_overview_tracing>`, either in this message or via
169
+ // :option:`--service-cluster`.
170
+ string cluster = 2;
171
+
172
+ // Opaque metadata extending the node identifier. Envoy will pass this
173
+ // directly to the management server.
174
+ google.protobuf.Struct metadata = 3;
175
+
176
+ // Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
177
+ // other fields in this message). For example, the xDS client may have a shard identifier that
178
+ // changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
179
+ // dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
180
+ // parameter then appears in this field during future discovery requests.
181
+ map<string, xds.core.v3.ContextParams> dynamic_parameters = 12;
182
+
183
+ // Locality specifying where the Envoy instance is running.
184
+ Locality locality = 4;
185
+
186
+ // Free-form string that identifies the entity requesting config.
187
+ // E.g. "envoy" or "grpc"
188
+ string user_agent_name = 6;
189
+
190
+ oneof user_agent_version_type {
191
+ // Free-form string that identifies the version of the entity requesting config.
192
+ // E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
193
+ string user_agent_version = 7;
194
+
195
+ // Structured version of the entity requesting config.
196
+ BuildVersion user_agent_build_version = 8;
197
+ }
198
+
199
+ // List of extensions and their versions supported by the node.
200
+ repeated Extension extensions = 9;
201
+
202
+ // Client feature support list. These are well known features described
203
+ // in the Envoy API repository for a given major version of an API. Client features
204
+ // use reverse DNS naming scheme, for example ``com.acme.feature``.
205
+ // See :ref:`the list of features <client_features>` that xDS client may
206
+ // support.
207
+ repeated string client_features = 10;
208
+
209
+ // Known listening ports on the node as a generic hint to the management server
210
+ // for filtering :ref:`listeners <config_listeners>` to be returned. For example,
211
+ // if there is a listener bound to port 80, the list can optionally contain the
212
+ // SocketAddress ``(0.0.0.0,80)``. The field is optional and just a hint.
213
+ repeated Address listening_addresses = 11
214
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
215
+ }
216
+
217
+ // Metadata provides additional inputs to filters based on matched listeners,
218
+ // filter chains, routes and endpoints. It is structured as a map, usually from
219
+ // filter name (in reverse DNS format) to metadata specific to the filter. Metadata
220
+ // key-values for a filter are merged as connection and request handling occurs,
221
+ // with later values for the same key overriding earlier values.
222
+ //
223
+ // An example use of metadata is providing additional values to
224
+ // http_connection_manager in the envoy.http_connection_manager.access_log
225
+ // namespace.
226
+ //
227
+ // Another example use of metadata is to per service config info in cluster metadata, which may get
228
+ // consumed by multiple filters.
229
+ //
230
+ // For load balancing, Metadata provides a means to subset cluster endpoints.
231
+ // Endpoints have a Metadata object associated and routes contain a Metadata
232
+ // object to match against. There are some well defined metadata used today for
233
+ // this purpose:
234
+ //
235
+ // * ``{"envoy.lb": {"canary": <bool> }}`` This indicates the canary status of an
236
+ // endpoint and is also used during header processing
237
+ // (x-envoy-upstream-canary) and for stats purposes.
238
+ // [#next-major-version: move to type/metadata/v2]
239
+ message Metadata {
240
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.Metadata";
241
+
242
+ // Key is the reverse DNS filter name, e.g. com.acme.widget. The ``envoy.*``
243
+ // namespace is reserved for Envoy's built-in filters.
244
+ // If both ``filter_metadata`` and
245
+ // :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>`
246
+ // fields are present in the metadata with same keys,
247
+ // only ``typed_filter_metadata`` field will be parsed.
248
+ map<string, google.protobuf.Struct> filter_metadata = 1
249
+ [(validate.rules).map = {keys {string {min_len: 1}}}];
250
+
251
+ // Key is the reverse DNS filter name, e.g. com.acme.widget. The ``envoy.*``
252
+ // namespace is reserved for Envoy's built-in filters.
253
+ // The value is encoded as google.protobuf.Any.
254
+ // If both :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
255
+ // and ``typed_filter_metadata`` fields are present in the metadata with same keys,
256
+ // only ``typed_filter_metadata`` field will be parsed.
257
+ map<string, google.protobuf.Any> typed_filter_metadata = 2
258
+ [(validate.rules).map = {keys {string {min_len: 1}}}];
259
+ }
260
+
261
+ // Runtime derived uint32 with a default when not specified.
262
+ message RuntimeUInt32 {
263
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.RuntimeUInt32";
264
+
265
+ // Default value if runtime value is not available.
266
+ uint32 default_value = 2;
267
+
268
+ // Runtime key to get value for comparison. This value is used if defined.
269
+ string runtime_key = 3;
270
+ }
271
+
272
+ // Runtime derived percentage with a default when not specified.
273
+ message RuntimePercent {
274
+ // Default value if runtime value is not available.
275
+ type.v3.Percent default_value = 1;
276
+
277
+ // Runtime key to get value for comparison. This value is used if defined.
278
+ string runtime_key = 2;
279
+ }
280
+
281
+ // Runtime derived double with a default when not specified.
282
+ message RuntimeDouble {
283
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.RuntimeDouble";
284
+
285
+ // Default value if runtime value is not available.
286
+ double default_value = 1;
287
+
288
+ // Runtime key to get value for comparison. This value is used if defined.
289
+ string runtime_key = 2;
290
+ }
291
+
292
+ // Runtime derived bool with a default when not specified.
293
+ message RuntimeFeatureFlag {
294
+ option (udpa.annotations.versioning).previous_message_type =
295
+ "envoy.api.v2.core.RuntimeFeatureFlag";
296
+
297
+ // Default value if runtime value is not available.
298
+ google.protobuf.BoolValue default_value = 1 [(validate.rules).message = {required: true}];
299
+
300
+ // Runtime key to get value for comparison. This value is used if defined. The boolean value must
301
+ // be represented via its
302
+ // `canonical JSON encoding <https://developers.google.com/protocol-buffers/docs/proto3#json>`_.
303
+ string runtime_key = 2;
304
+ }
305
+
306
+ // Please use :ref:`KeyValuePair <envoy_api_msg_config.core.v3.KeyValuePair>` instead.
307
+ // [#not-implemented-hide:]
308
+ message KeyValue {
309
+ // The key of the key/value pair.
310
+ string key = 1 [
311
+ deprecated = true,
312
+ (validate.rules).string = {min_len: 1 max_bytes: 16384},
313
+ (envoy.annotations.deprecated_at_minor_version) = "3.0"
314
+ ];
315
+
316
+ // The value of the key/value pair.
317
+ //
318
+ // The ``bytes`` type is used. This means if JSON or YAML is used to to represent the
319
+ // configuration, the value must be base64 encoded. This is unfriendly for users in most
320
+ // use scenarios of this message.
321
+ //
322
+ bytes value = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
323
+ }
324
+
325
+ message KeyValuePair {
326
+ // The key of the key/value pair.
327
+ string key = 1 [(validate.rules).string = {min_len: 1 max_bytes: 16384}];
328
+
329
+ // The value of the key/value pair.
330
+ google.protobuf.Value value = 2;
331
+ }
332
+
333
+ // Key/value pair plus option to control append behavior. This is used to specify
334
+ // key/value pairs that should be appended to a set of existing key/value pairs.
335
+ message KeyValueAppend {
336
+ // Describes the supported actions types for key/value pair append action.
337
+ enum KeyValueAppendAction {
338
+ // If the key already exists, this action will result in the following behavior:
339
+ //
340
+ // - Comma-concatenated value if multiple values are not allowed.
341
+ // - New value added to the list of values if multiple values are allowed.
342
+ //
343
+ // If the key doesn't exist then this will add pair with specified key and value.
344
+ APPEND_IF_EXISTS_OR_ADD = 0;
345
+
346
+ // This action will add the key/value pair if it doesn't already exist. If the
347
+ // key already exists then this will be a no-op.
348
+ ADD_IF_ABSENT = 1;
349
+
350
+ // This action will overwrite the specified value by discarding any existing
351
+ // values if the key already exists. If the key doesn't exist then this will add
352
+ // the pair with specified key and value.
353
+ OVERWRITE_IF_EXISTS_OR_ADD = 2;
354
+
355
+ // This action will overwrite the specified value by discarding any existing
356
+ // values if the key already exists. If the key doesn't exist then this will
357
+ // be no-op.
358
+ OVERWRITE_IF_EXISTS = 3;
359
+ }
360
+
361
+ // The single key/value pair record to be appended or overridden. This field must be set.
362
+ KeyValuePair record = 3;
363
+
364
+ // Key/value pair entry that this option to append or overwrite. This field is deprecated
365
+ // and please use :ref:`record <envoy_v3_api_field_config.core.v3.KeyValueAppend.record>`
366
+ // as replacement.
367
+ // [#not-implemented-hide:]
368
+ KeyValue entry = 1 [
369
+ deprecated = true,
370
+ (validate.rules).message = {skip: true},
371
+ (envoy.annotations.deprecated_at_minor_version) = "3.0"
372
+ ];
373
+
374
+ // Describes the action taken to append/overwrite the given value for an existing
375
+ // key or to only add this key if it's absent.
376
+ KeyValueAppendAction action = 2 [(validate.rules).enum = {defined_only: true}];
377
+ }
378
+
379
+ // Key/value pair to append or remove.
380
+ message KeyValueMutation {
381
+ // Key/value pair to append or overwrite. Only one of ``append`` or ``remove`` can be set or
382
+ // the configuration will be rejected.
383
+ KeyValueAppend append = 1;
384
+
385
+ // Key to remove. Only one of ``append`` or ``remove`` can be set or the configuration will be
386
+ // rejected.
387
+ string remove = 2 [(validate.rules).string = {max_bytes: 16384}];
388
+ }
389
+
390
+ // Query parameter name/value pair.
391
+ message QueryParameter {
392
+ // The key of the query parameter. Case sensitive.
393
+ string key = 1 [(validate.rules).string = {min_len: 1}];
394
+
395
+ // The value of the query parameter.
396
+ string value = 2;
397
+ }
398
+
399
+ // Header name/value pair.
400
+ message HeaderValue {
401
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.HeaderValue";
402
+
403
+ // Header name.
404
+ string key = 1
405
+ [(validate.rules).string =
406
+ {min_len: 1 max_bytes: 16384 well_known_regex: HTTP_HEADER_NAME strict: false}];
407
+
408
+ // Header value.
409
+ //
410
+ // The same :ref:`format specifier <config_access_log_format>` as used for
411
+ // :ref:`HTTP access logging <config_access_log>` applies here, however
412
+ // unknown header values are replaced with the empty string instead of ``-``.
413
+ // Header value is encoded as string. This does not work for non-utf8 characters.
414
+ // Only one of ``value`` or ``raw_value`` can be set.
415
+ string value = 2 [
416
+ (validate.rules).string = {max_bytes: 16384 well_known_regex: HTTP_HEADER_VALUE strict: false},
417
+ (udpa.annotations.field_migrate).oneof_promotion = "value_type"
418
+ ];
419
+
420
+ // Header value is encoded as bytes which can support non-utf8 characters.
421
+ // Only one of ``value`` or ``raw_value`` can be set.
422
+ bytes raw_value = 3 [
423
+ (validate.rules).bytes = {min_len: 0 max_len: 16384},
424
+ (udpa.annotations.field_migrate).oneof_promotion = "value_type"
425
+ ];
426
+ }
427
+
428
+ // Header name/value pair plus option to control append behavior.
429
+ message HeaderValueOption {
430
+ option (udpa.annotations.versioning).previous_message_type =
431
+ "envoy.api.v2.core.HeaderValueOption";
432
+
433
+ // Describes the supported actions types for header append action.
434
+ enum HeaderAppendAction {
435
+ // If the header already exists, this action will result in:
436
+ //
437
+ // - Comma-concatenated for predefined inline headers.
438
+ // - Duplicate header added in the ``HeaderMap`` for other headers.
439
+ //
440
+ // If the header doesn't exist then this will add new header with specified key and value.
441
+ APPEND_IF_EXISTS_OR_ADD = 0;
442
+
443
+ // This action will add the header if it doesn't already exist. If the header
444
+ // already exists then this will be a no-op.
445
+ ADD_IF_ABSENT = 1;
446
+
447
+ // This action will overwrite the specified value by discarding any existing values if
448
+ // the header already exists. If the header doesn't exist then this will add the header
449
+ // with specified key and value.
450
+ OVERWRITE_IF_EXISTS_OR_ADD = 2;
451
+
452
+ // This action will overwrite the specified value by discarding any existing values if
453
+ // the header already exists. If the header doesn't exist then this will be no-op.
454
+ OVERWRITE_IF_EXISTS = 3;
455
+ }
456
+
457
+ // Header name/value pair that this option applies to.
458
+ HeaderValue header = 1 [(validate.rules).message = {required: true}];
459
+
460
+ // Should the value be appended? If true (default), the value is appended to
461
+ // existing values. Otherwise it replaces any existing values.
462
+ // This field is deprecated and please use
463
+ // :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>` as replacement.
464
+ //
465
+ // .. note::
466
+ // The :ref:`external authorization service <envoy_v3_api_msg_service.auth.v3.CheckResponse>` and
467
+ // :ref:`external processor service <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>` have
468
+ // default value (``false``) for this field.
469
+ google.protobuf.BoolValue append = 2
470
+ [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
471
+
472
+ // Describes the action taken to append/overwrite the given value for an existing header
473
+ // or to only add this header if it's absent.
474
+ // Value defaults to :ref:`APPEND_IF_EXISTS_OR_ADD
475
+ // <envoy_v3_api_enum_value_config.core.v3.HeaderValueOption.HeaderAppendAction.APPEND_IF_EXISTS_OR_ADD>`.
476
+ HeaderAppendAction append_action = 3 [(validate.rules).enum = {defined_only: true}];
477
+
478
+ // Is the header value allowed to be empty? If false (default), custom headers with empty values are dropped,
479
+ // otherwise they are added.
480
+ bool keep_empty_value = 4;
481
+ }
482
+
483
+ // Wrapper for a set of headers.
484
+ message HeaderMap {
485
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.HeaderMap";
486
+
487
+ // A list of header names and their values.
488
+ repeated HeaderValue headers = 1;
489
+ }
490
+
491
+ // A directory that is watched for changes, e.g. by inotify on Linux. Move/rename
492
+ // events inside this directory trigger the watch.
493
+ message WatchedDirectory {
494
+ // Directory path to watch.
495
+ string path = 1 [(validate.rules).string = {min_len: 1}];
496
+ }
497
+
498
+ // Data source consisting of a file, an inline value, or an environment variable.
499
+ // [#next-free-field: 6]
500
+ message DataSource {
501
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.DataSource";
502
+
503
+ oneof specifier {
504
+ option (validate.required) = true;
505
+
506
+ // Local filesystem data source.
507
+ string filename = 1 [(validate.rules).string = {min_len: 1}];
508
+
509
+ // Bytes inlined in the configuration.
510
+ bytes inline_bytes = 2;
511
+
512
+ // String inlined in the configuration.
513
+ string inline_string = 3;
514
+
515
+ // Environment variable data source.
516
+ string environment_variable = 4 [(validate.rules).string = {min_len: 1}];
517
+ }
518
+
519
+ // Watched directory that is watched for file changes. If this is set explicitly, the file
520
+ // specified in the ``filename`` field will be reloaded when relevant file move events occur.
521
+ //
522
+ // .. note::
523
+ // This field only makes sense when the ``filename`` field is set.
524
+ //
525
+ // .. note::
526
+ // Envoy only updates when the file is replaced by a file move, and not when the file is
527
+ // edited in place.
528
+ //
529
+ // .. note::
530
+ // Not all use cases of ``DataSource`` support watching directories. It depends on the
531
+ // specific usage of the ``DataSource``. See the documentation of the parent message for
532
+ // details.
533
+ WatchedDirectory watched_directory = 5;
534
+ }
535
+
536
+ // The message specifies the retry policy of remote data source when fetching fails.
537
+ // [#next-free-field: 7]
538
+ message RetryPolicy {
539
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.RetryPolicy";
540
+
541
+ // See :ref:`RetryPriority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.
542
+ message RetryPriority {
543
+ string name = 1 [(validate.rules).string = {min_len: 1}];
544
+
545
+ oneof config_type {
546
+ google.protobuf.Any typed_config = 2;
547
+ }
548
+ }
549
+
550
+ // See :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.
551
+ message RetryHostPredicate {
552
+ string name = 1 [(validate.rules).string = {min_len: 1}];
553
+
554
+ oneof config_type {
555
+ google.protobuf.Any typed_config = 2;
556
+ }
557
+ }
558
+
559
+ // Specifies parameters that control :ref:`retry backoff strategy <envoy_v3_api_msg_config.core.v3.BackoffStrategy>`.
560
+ // This parameter is optional, in which case the default base interval is 1000 milliseconds. The
561
+ // default maximum interval is 10 times the base interval.
562
+ BackoffStrategy retry_back_off = 1;
563
+
564
+ // Specifies the allowed number of retries. This parameter is optional and
565
+ // defaults to 1.
566
+ google.protobuf.UInt32Value num_retries = 2
567
+ [(udpa.annotations.field_migrate).rename = "max_retries"];
568
+
569
+ // For details, see :ref:`retry_on <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_on>`.
570
+ string retry_on = 3;
571
+
572
+ // For details, see :ref:`retry_priority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.
573
+ RetryPriority retry_priority = 4;
574
+
575
+ // For details, see :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.
576
+ repeated RetryHostPredicate retry_host_predicate = 5;
577
+
578
+ // For details, see :ref:`host_selection_retry_max_attempts <envoy_v3_api_field_config.route.v3.RetryPolicy.host_selection_retry_max_attempts>`.
579
+ int64 host_selection_retry_max_attempts = 6;
580
+ }
581
+
582
+ // The message specifies how to fetch data from remote and how to verify it.
583
+ message RemoteDataSource {
584
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.RemoteDataSource";
585
+
586
+ // The HTTP URI to fetch the remote data.
587
+ HttpUri http_uri = 1 [(validate.rules).message = {required: true}];
588
+
589
+ // SHA256 string for verifying data.
590
+ string sha256 = 2 [(validate.rules).string = {min_len: 1}];
591
+
592
+ // Retry policy for fetching remote data.
593
+ RetryPolicy retry_policy = 3;
594
+ }
595
+
596
+ // Async data source which support async data fetch.
597
+ message AsyncDataSource {
598
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.AsyncDataSource";
599
+
600
+ oneof specifier {
601
+ option (validate.required) = true;
602
+
603
+ // Local async data source.
604
+ DataSource local = 1;
605
+
606
+ // Remote async data source.
607
+ RemoteDataSource remote = 2;
608
+ }
609
+ }
610
+
611
+ // Configuration for transport socket in :ref:`listeners <config_listeners>` and
612
+ // :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>`. If the configuration is
613
+ // empty, a default transport socket implementation and configuration will be
614
+ // chosen based on the platform and existence of tls_context.
615
+ message TransportSocket {
616
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.TransportSocket";
617
+
618
+ reserved 2;
619
+
620
+ reserved "config";
621
+
622
+ // The name of the transport socket to instantiate. The name must match a supported transport
623
+ // socket implementation.
624
+ string name = 1 [(validate.rules).string = {min_len: 1}];
625
+
626
+ // Implementation specific configuration which depends on the implementation being instantiated.
627
+ // See the supported transport socket implementations for further documentation.
628
+ oneof config_type {
629
+ google.protobuf.Any typed_config = 3;
630
+ }
631
+ }
632
+
633
+ // Runtime derived FractionalPercent with defaults for when the numerator or denominator is not
634
+ // specified via a runtime key.
635
+ //
636
+ // .. note::
637
+ //
638
+ // Parsing of the runtime key's data is implemented such that it may be represented as a
639
+ // :ref:`FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>` proto represented as JSON/YAML
640
+ // and may also be represented as an integer with the assumption that the value is an integral
641
+ // percentage out of 100. For instance, a runtime key lookup returning the value "42" would parse
642
+ // as a ``FractionalPercent`` whose numerator is 42 and denominator is HUNDRED.
643
+ message RuntimeFractionalPercent {
644
+ option (udpa.annotations.versioning).previous_message_type =
645
+ "envoy.api.v2.core.RuntimeFractionalPercent";
646
+
647
+ // Default value if the runtime value's for the numerator/denominator keys are not available.
648
+ type.v3.FractionalPercent default_value = 1 [(validate.rules).message = {required: true}];
649
+
650
+ // Runtime key for a YAML representation of a FractionalPercent.
651
+ string runtime_key = 2;
652
+ }
653
+
654
+ // Identifies a specific ControlPlane instance that Envoy is connected to.
655
+ message ControlPlane {
656
+ option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.ControlPlane";
657
+
658
+ // An opaque control plane identifier that uniquely identifies an instance
659
+ // of control plane. This can be used to identify which control plane instance,
660
+ // the Envoy is connected to.
661
+ string identifier = 1;
662
+ }