Skip to content

Commit 56311ae

Browse files
[protobuf] Update protobuf definitions to v1.24.0 (#259)
Signed-off-by: envoy-bot <[email protected]>
1 parent 418ba09 commit 56311ae

File tree

99 files changed

+979
-671
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+979
-671
lines changed

api/src/main/proto/envoy/admin/v3/clusters.proto

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ message Clusters {
3030
}
3131

3232
// Details an individual cluster's current status.
33-
// [#next-free-field: 8]
33+
// [#next-free-field: 9]
3434
message ClusterStatus {
3535
option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v2alpha.ClusterStatus";
3636

@@ -84,6 +84,9 @@ message ClusterStatus {
8484

8585
// Observability name of the cluster.
8686
string observability_name = 7;
87+
88+
// The :ref:`EDS service name <envoy_v3_api_field_config.cluster.v3.Cluster.EdsClusterConfig.service_name>` if the cluster is an EDS cluster.
89+
string eds_service_name = 8;
8790
}
8891

8992
// Current state of a particular host.

api/src/main/proto/envoy/admin/v3/listeners.proto

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,5 @@ message ListenerStatus {
3737

3838
// The additional addresses the listener is listening on as specified via the :ref:`additional_addresses <envoy_v3_api_field_config.listener.v3.Listener.additional_addresses>`
3939
// configuration.
40-
// [#not-implemented-hide:]
4140
repeated config.core.v3.Address additional_local_addresses = 3;
4241
}

api/src/main/proto/envoy/admin/v3/server_info.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ option java_multiple_files = true;
1515
option go_package = "github.com/envoyproxy/go-control-plane/envoy/admin/v3;adminv3";
1616
option (udpa.annotations.file_status).package_version_status = ACTIVE;
1717

18-
// [#protodoc-title: Server State]
18+
// [#protodoc-title: Server state]
1919

2020
// Proto representation of the value returned by /server_info, containing
2121
// server version/server status information.

api/src/main/proto/envoy/api/v2/cluster/outlier_detection.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ option (udpa.annotations.file_status).package_version_status = FROZEN;
2424
// more information on outlier detection.
2525
// [#next-free-field: 21]
2626
message OutlierDetection {
27-
// The number of consecutive 5xx responses or local origin errors that are mapped
28-
// to 5xx error codes before a consecutive 5xx ejection
29-
// occurs. Defaults to 5.
27+
// The number of consecutive server-side error responses (for HTTP traffic,
28+
// 5xx responses; for TCP traffic, connection failures; for Redis, failure to
29+
// respond PONG; etc.) before a consecutive 5xx ejection occurs. Defaults to 5.
3030
google.protobuf.UInt32Value consecutive_5xx = 1;
3131

3232
// The time interval between ejection analysis sweeps. This can result in

api/src/main/proto/envoy/api/v2/route/route_components.proto

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -859,8 +859,9 @@ message RouteAction {
859859
// Indicates that during forwarding, the host header will be swapped with
860860
// the hostname of the upstream host chosen by the cluster manager. This
861861
// option is applicable only when the destination cluster for a route is of
862-
// type *strict_dns* or *logical_dns*. Setting this to true with other cluster
863-
// types has no effect.
862+
// type ``STRICT_DNS``, ``LOGICAL_DNS`` or ``STATIC``. For ``STATIC`` clusters, the
863+
// hostname attribute of the endpoint must be configured. Setting this to true
864+
// with other cluster types has no effect.
864865
google.protobuf.BoolValue auto_host_rewrite = 7;
865866

866867
// Indicates that during forwarding, the host header will be swapped with the content of given

api/src/main/proto/envoy/config/bootstrap/v3/bootstrap.proto

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
4141
// <config_overview_bootstrap>` for more detail.
4242

4343
// Bootstrap :ref:`configuration overview <config_overview_bootstrap>`.
44-
// [#next-free-field: 35]
44+
// [#next-free-field: 36]
4545
message Bootstrap {
4646
option (udpa.annotations.versioning).previous_message_type =
4747
"envoy.config.bootstrap.v2.Bootstrap";
@@ -335,6 +335,13 @@ message Bootstrap {
335335
// If the value is not specified, Google RE2 will be used by default.
336336
// [#extension-category: envoy.regex_engines]
337337
core.v3.TypedExtensionConfig default_regex_engine = 34;
338+
339+
// Optional XdsResourcesDelegate configuration, which allows plugging custom logic into both
340+
// fetch and load events during xDS processing.
341+
// If a value is not specified, no XdsResourcesDelegate will be used.
342+
// TODO(abeyad): Add public-facing documentation.
343+
// [#not-implemented-hide:]
344+
core.v3.TypedExtensionConfig xds_delegate_extension = 35;
338345
}
339346

340347
// Administration interface :ref:`operations documentation

api/src/main/proto/envoy/config/cluster/v3/cluster.proto

Lines changed: 64 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ message Cluster {
209209

210210
// Optionally divide the endpoints in this cluster into subsets defined by
211211
// endpoint metadata and selected by route and weighted cluster metadata.
212-
// [#next-free-field: 8]
212+
// [#next-free-field: 9]
213213
message LbSubsetConfig {
214214
option (udpa.annotations.versioning).previous_message_type =
215215
"envoy.api.v2.Cluster.LbSubsetConfig";
@@ -225,6 +225,52 @@ message Cluster {
225225
DEFAULT_SUBSET = 2;
226226
}
227227

228+
enum LbSubsetMetadataFallbackPolicy {
229+
// No fallback. Route metadata will be used as-is.
230+
METADATA_NO_FALLBACK = 0;
231+
232+
// A special metadata key ``fallback_list`` will be used to provide variants of metadata to try.
233+
// Value of ``fallback_list`` key has to be a list. Every list element has to be a struct - it will
234+
// be merged with route metadata, overriding keys that appear in both places.
235+
// ``fallback_list`` entries will be used in order until a host is found.
236+
//
237+
// ``fallback_list`` key itself is removed from metadata before subset load balancing is performed.
238+
//
239+
// Example:
240+
//
241+
// for metadata:
242+
//
243+
// .. code-block:: yaml
244+
//
245+
// version: 1.0
246+
// fallback_list:
247+
// - version: 2.0
248+
// hardware: c64
249+
// - hardware: c32
250+
// - version: 3.0
251+
//
252+
// at first, metadata:
253+
//
254+
// .. code-block:: json
255+
//
256+
// {"version": "2.0", "hardware": "c64"}
257+
//
258+
// will be used for load balancing. If no host is found, metadata:
259+
//
260+
// .. code-block:: json
261+
//
262+
// {"version": "1.0", "hardware": "c32"}
263+
//
264+
// is next to try. If it still results in no host, finally metadata:
265+
//
266+
// .. code-block:: json
267+
//
268+
// {"version": "3.0"}
269+
//
270+
// is used.
271+
FALLBACK_LIST = 1;
272+
}
273+
228274
// Specifications for subsets.
229275
message LbSubsetSelector {
230276
option (udpa.annotations.versioning).previous_message_type =
@@ -260,10 +306,7 @@ message Cluster {
260306
// Selects a mode of operation in which each subset has only one host. This mode uses the same rules for
261307
// choosing a host, but updating hosts is faster, especially for large numbers of hosts.
262308
//
263-
// If a match is found to a host, that host will be used regardless of priority levels, unless the host is unhealthy.
264-
//
265-
// Currently, this mode is only supported if ``subset_selectors`` has only one entry, and ``keys`` contains
266-
// only one entry.
309+
// If a match is found to a host, that host will be used regardless of priority levels.
267310
//
268311
// When this mode is enabled, configurations that contain more than one host with the same metadata value for the single key in ``keys``
269312
// will use only one of the hosts with the given key; no requests will be routed to the others. The cluster gauge
@@ -349,6 +392,16 @@ message Cluster {
349392
// endpoint metadata if the endpoint metadata matches the value exactly OR it is a list value
350393
// and any of the elements in the list matches the criteria.
351394
bool list_as_any = 7;
395+
396+
// Fallback mechanism that allows to try different route metadata until a host is found.
397+
// If load balancing process, including all its mechanisms (like
398+
// :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
399+
// fails to select a host, this policy decides if and how the process is repeated using another metadata.
400+
//
401+
// The value defaults to
402+
// :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
403+
LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8
404+
[(validate.rules).enum = {defined_only: true}];
352405
}
353406

354407
// Configuration for :ref:`slow start mode <arch_overview_load_balancing_slow_start>`.
@@ -462,8 +515,8 @@ message Cluster {
462515
// Specific configuration for the :ref:`Maglev<arch_overview_load_balancing_types_maglev>`
463516
// load balancing policy.
464517
message MaglevLbConfig {
465-
// The table size for Maglev hashing. The Maglev aims for minimal disruption rather than an absolute guarantee.
466-
// Minimal disruption means that when the set of upstreams changes, a connection will likely be sent to the same
518+
// The table size for Maglev hashing. Maglev aims for "minimal disruption" rather than an absolute guarantee.
519+
// Minimal disruption means that when the set of upstream hosts change, a connection will likely be sent to the same
467520
// upstream as it was before. Increasing the table size reduces the amount of disruption.
468521
// The table size must be prime number limited to 5000011. If it is not specified, the default is 65537.
469522
google.protobuf.UInt64Value table_size = 1 [(validate.rules).uint64 = {lte: 5000011}];
@@ -493,6 +546,10 @@ message Cluster {
493546
// The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
494547
// 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.
495548
string http_header_name = 2;
549+
550+
// The port to override for the original dst address. This port
551+
// will take precedence over filter state and header override ports
552+
google.protobuf.UInt32Value upstream_port_override = 3 [(validate.rules).uint32 = {lte: 65535}];
496553
}
497554

498555
// Common configuration for all load balancer implementations.
@@ -1167,15 +1224,6 @@ message LoadBalancingPolicy {
11671224
repeated Policy policies = 1;
11681225
}
11691226

1170-
// An extensible structure containing the address Envoy should bind to when
1171-
// establishing upstream connections.
1172-
message UpstreamBindConfig {
1173-
option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.UpstreamBindConfig";
1174-
1175-
// The address Envoy should bind to when establishing upstream connections.
1176-
core.v3.Address source_address = 1;
1177-
}
1178-
11791227
message UpstreamConnectionOptions {
11801228
option (udpa.annotations.versioning).previous_message_type =
11811229
"envoy.api.v2.UpstreamConnectionOptions";

api/src/main/proto/envoy/config/cluster/v3/outlier_detection.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ message OutlierDetection {
2424
option (udpa.annotations.versioning).previous_message_type =
2525
"envoy.api.v2.cluster.OutlierDetection";
2626

27-
// The number of consecutive 5xx responses or local origin errors that are mapped
28-
// to 5xx error codes before a consecutive 5xx ejection
29-
// occurs. Defaults to 5.
27+
// The number of consecutive server-side error responses (for HTTP traffic,
28+
// 5xx responses; for TCP traffic, connection failures; for Redis, failure to
29+
// respond PONG; etc.) before a consecutive 5xx ejection occurs. Defaults to 5.
3030
google.protobuf.UInt32Value consecutive_5xx = 1;
3131

3232
// The time interval between ejection analysis sweeps. This can result in

api/src/main/proto/envoy/config/common/key_value/v3/config.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ option java_multiple_files = true;
1515
option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/common/key_value/v3;key_valuev3";
1616
option (udpa.annotations.file_status).package_version_status = ACTIVE;
1717

18-
// [#protodoc-title: Key Value Store storage plugin]
18+
// [#protodoc-title: Key/value store storage plugin]
1919

2020
// This shared configuration for Envoy key value stores.
2121
message KeyValueStoreConfig {

api/src/main/proto/envoy/config/common/mutation_rules/v3/mutation_rules.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ option java_multiple_files = true;
1414
option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/common/mutation_rules/v3;mutation_rulesv3";
1515
option (udpa.annotations.file_status).package_version_status = ACTIVE;
1616

17-
// [#protodoc-title: Header Mutation Rules]
17+
// [#protodoc-title: Header mutation rules]
1818

1919
// The HeaderMutationRules structure specifies what headers may be
2020
// manipulated by a processing filter. This set of rules makes it

0 commit comments

Comments
 (0)