Skip to content

Commit 554aebd

Browse files
authored
chore: Update protobuf files (#6)
* envoy-proto-collect: update submodules * envoy-types: collect updated protos * envoy-types: update generated files
1 parent 5e8d8eb commit 554aebd

38 files changed

+878
-579
lines changed
Submodule googleapis updated 183 files

envoy-proto-collect/submodules/xds

envoy-types/proto/data-plane-api/envoy/admin/v3/config_dump_shared.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ enum ClientResourceStatus {
5353

5454
// Client received this resource and replied with NACK.
5555
NACKED = 4;
56+
57+
// Client received an error from the control plane. The attached config
58+
// dump is the most recent accepted one. If no config is accepted yet,
59+
// the attached config dump will be empty.
60+
RECEIVED_ERROR = 5;
61+
62+
// Client timed out waiting for the resource from the control plane.
63+
TIMEOUT = 6;
5664
}
5765

5866
message UpdateFailureState {

envoy-types/proto/data-plane-api/envoy/config/accesslog/v3/accesslog.proto

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -166,35 +166,38 @@ message TraceableFilter {
166166
"envoy.config.filter.accesslog.v2.TraceableFilter";
167167
}
168168

169-
// Filters for random sampling of requests.
169+
// Filters requests based on runtime-configurable sampling rates.
170170
message RuntimeFilter {
171171
option (udpa.annotations.versioning).previous_message_type =
172172
"envoy.config.filter.accesslog.v2.RuntimeFilter";
173173

174-
// Runtime key to get an optional overridden numerator for use in the
175-
// ``percent_sampled`` field. If found in runtime, this value will replace the
176-
// default numerator.
174+
// Specifies a key used to look up a custom sampling rate from the runtime configuration. If a value is found for this
175+
// key, it will override the default sampling rate specified in ``percent_sampled``.
177176
string runtime_key = 1 [(validate.rules).string = {min_len: 1}];
178177

179-
// The default sampling percentage. If not specified, defaults to 0% with
180-
// denominator of 100.
178+
// Defines the default sampling percentage when no runtime override is present. If not specified, the default is
179+
// **0%** (with a denominator of 100).
181180
type.v3.FractionalPercent percent_sampled = 2;
182181

183-
// By default, sampling pivots on the header
184-
// :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being
185-
// present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`
186-
// is present, the filter will consistently sample across multiple hosts based
187-
// on the runtime key value and the value extracted from
188-
// :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is
189-
// missing, or ``use_independent_randomness`` is set to true, the filter will
190-
// randomly sample based on the runtime key value alone.
191-
// ``use_independent_randomness`` can be used for logging kill switches within
192-
// complex nested :ref:`AndFilter
193-
// <envoy_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter
194-
// <envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to
195-
// reason about from a probability perspective (i.e., setting to true will
196-
// cause the filter to behave like an independent random variable when
197-
// composed within logical operator filters).
182+
// Controls how sampling decisions are made.
183+
//
184+
// - Default behavior (``false``):
185+
//
186+
// * Uses the :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` as a consistent sampling pivot.
187+
// * When :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is present, sampling will be consistent
188+
// across multiple hosts based on both the ``runtime_key`` and
189+
// :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`.
190+
// * Useful for tracking related requests across a distributed system.
191+
//
192+
// - When set to ``true`` or :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is missing:
193+
//
194+
// * Sampling decisions are made randomly based only on the ``runtime_key``.
195+
// * Useful in complex filter configurations (like nested
196+
// :ref:`AndFilter<envoy_v3_api_msg_config.accesslog.v3.AndFilter>`/
197+
// :ref:`OrFilter<envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks) where independent probability
198+
// calculations are desired.
199+
// * Can be used to implement logging kill switches with predictable probability distributions.
200+
//
198201
bool use_independent_randomness = 3;
199202
}
200203

envoy-types/proto/data-plane-api/envoy/config/cluster/v3/cluster.proto

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -967,8 +967,15 @@ message Cluster {
967967
// :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
968968
// and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
969969
// this setting is ignored.
970-
google.protobuf.Duration dns_refresh_rate = 16
971-
[(validate.rules).duration = {gt {nanos: 1000000}}];
970+
// This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
971+
// extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
972+
// If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
973+
// :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
974+
google.protobuf.Duration dns_refresh_rate = 16 [
975+
deprecated = true,
976+
(validate.rules).duration = {gt {nanos: 1000000}},
977+
(envoy.annotations.deprecated_at_minor_version) = "3.0"
978+
];
972979

973980
// DNS jitter can be optionally specified if the cluster type is either
974981
// :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
@@ -979,7 +986,15 @@ message Cluster {
979986
// :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`
980987
// and :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>`
981988
// this setting is ignored.
982-
google.protobuf.Duration dns_jitter = 58 [(validate.rules).duration = {gte {}}];
989+
// This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
990+
// extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
991+
// If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
992+
// :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
993+
google.protobuf.Duration dns_jitter = 58 [
994+
deprecated = true,
995+
(validate.rules).duration = {gte {}},
996+
(envoy.annotations.deprecated_at_minor_version) = "3.0"
997+
];
983998

984999
// If the DNS failure refresh rate is specified and the cluster type is either
9851000
// :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>`,
@@ -989,16 +1004,31 @@ message Cluster {
9891004
// other than :ref:`STRICT_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.STRICT_DNS>` and
9901005
// :ref:`LOGICAL_DNS<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DiscoveryType.LOGICAL_DNS>` this setting is
9911006
// ignored.
992-
RefreshRate dns_failure_refresh_rate = 44;
1007+
// This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1008+
// extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1009+
// If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1010+
// :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1011+
RefreshRate dns_failure_refresh_rate = 44
1012+
[deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
9931013

9941014
// Optional configuration for setting cluster's DNS refresh rate. If the value is set to true,
9951015
// cluster's DNS refresh rate will be set to resource record's TTL which comes from DNS
9961016
// resolution.
997-
bool respect_dns_ttl = 39;
1017+
// This field is deprecated in favor of using the :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1018+
// extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1019+
// If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1020+
// :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
1021+
bool respect_dns_ttl = 39
1022+
[deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
9981023

9991024
// The DNS IP address resolution policy. If this setting is not specified, the
10001025
// value defaults to
10011026
// :ref:`AUTO<envoy_v3_api_enum_value_config.cluster.v3.Cluster.DnsLookupFamily.AUTO>`.
1027+
// For logical and strict dns cluster, this field is deprecated in favor of using the
1028+
// :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>`
1029+
// extension point and configuring it with :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
1030+
// If :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1031+
// :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`, this field will be ignored.
10021032
DnsLookupFamily dns_lookup_family = 17 [(validate.rules).enum = {defined_only: true}];
10031033

10041034
// If DNS resolvers are specified and the cluster type is either
@@ -1038,6 +1068,9 @@ message Cluster {
10381068
// During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
10391069
// when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
10401070
// When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
1071+
// Also note that this field is deprecated for logical dns and strict dns clusters and will be ignored when
1072+
// :ref:`cluster_type<envoy_v3_api_field_config.cluster.v3.Cluster.cluster_type>` is configured with
1073+
// :ref:`DnsCluster<envoy_v3_api_msg_extensions.clusters.dns.v3.DnsCluster>`.
10411074
// [#extension-category: envoy.network.dns_resolver]
10421075
core.v3.TypedExtensionConfig typed_dns_resolver_config = 55;
10431076

envoy-types/proto/data-plane-api/envoy/config/core/v3/base.proto

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -317,12 +317,31 @@ message RuntimeFeatureFlag {
317317
string runtime_key = 2 [(validate.rules).string = {min_len: 1}];
318318
}
319319

320+
// Please use :ref:`KeyValuePair <envoy_api_msg_config.core.v3.KeyValuePair>` instead.
321+
// [#not-implemented-hide:]
320322
message KeyValue {
323+
// The key of the key/value pair.
324+
string key = 1 [
325+
deprecated = true,
326+
(validate.rules).string = {min_len: 1 max_bytes: 16384},
327+
(envoy.annotations.deprecated_at_minor_version) = "3.0"
328+
];
329+
330+
// The value of the key/value pair.
331+
//
332+
// The ``bytes`` type is used. This means if JSON or YAML is used to to represent the
333+
// configuration, the value must be base64 encoded. This is unfriendly for users in most
334+
// use scenarios of this message.
335+
//
336+
bytes value = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
337+
}
338+
339+
message KeyValuePair {
321340
// The key of the key/value pair.
322341
string key = 1 [(validate.rules).string = {min_len: 1 max_bytes: 16384}];
323342

324343
// The value of the key/value pair.
325-
bytes value = 2;
344+
google.protobuf.Value value = 2;
326345
}
327346

328347
// Key/value pair plus option to control append behavior. This is used to specify
@@ -353,8 +372,18 @@ message KeyValueAppend {
353372
OVERWRITE_IF_EXISTS = 3;
354373
}
355374

356-
// Key/value pair entry that this option to append or overwrite.
357-
KeyValue entry = 1 [(validate.rules).message = {required: true}];
375+
// The single key/value pair record to be appended or overridden. This field must be set.
376+
KeyValuePair record = 3;
377+
378+
// Key/value pair entry that this option to append or overwrite. This field is deprecated
379+
// and please use :ref:`record <envoy_v3_api_field_config.core.v3.KeyValueAppend.record>`
380+
// as replacement.
381+
// [#not-implemented-hide:]
382+
KeyValue entry = 1 [
383+
deprecated = true,
384+
(validate.rules).message = {skip: true},
385+
(envoy.annotations.deprecated_at_minor_version) = "3.0"
386+
];
358387

359388
// Describes the action taken to append/overwrite the given value for an existing
360389
// key or to only add this key if it's absent.
@@ -363,10 +392,12 @@ message KeyValueAppend {
363392

364393
// Key/value pair to append or remove.
365394
message KeyValueMutation {
366-
// Key/value pair to append or overwrite. Only one of ``append`` or ``remove`` can be set.
395+
// Key/value pair to append or overwrite. Only one of ``append`` or ``remove`` can be set or
396+
// the configuration will be rejected.
367397
KeyValueAppend append = 1;
368398

369-
// Key to remove. Only one of ``append`` or ``remove`` can be set.
399+
// Key to remove. Only one of ``append`` or ``remove`` can be set or the configuration will be
400+
// rejected.
370401
string remove = 2 [(validate.rules).string = {max_bytes: 16384}];
371402
}
372403

envoy-types/proto/data-plane-api/envoy/config/rbac/v3/rbac.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,8 +220,10 @@ message Policy {
220220
// metadata should be sourced from, rather than only matching against dynamic metadata.
221221
//
222222
// The matcher can be configured to look up metadata from:
223+
//
223224
// * Dynamic metadata: Runtime metadata added by filters during request processing
224225
// * Route metadata: Static metadata configured on the route entry
226+
//
225227
message SourcedMetadata {
226228
// Metadata matcher configuration that defines what metadata to match against. This includes the filter name,
227229
// metadata key path, and expected value.

0 commit comments

Comments
 (0)