lb api: moving load balancing policy specific configuration to extension configuration (#23967)
Signed-off-by: wbpcode <wangbaiping@corp.netease.com> Mirrored from https://github.com/envoyproxy/envoy @ 50ac04b41af595f1df9a925146bd5314201ca425pull/626/head
data-plane-api(Azure Pipelines)
2 years ago
parent
734ef4e0e9
commit
194681eadd
15 changed files with 193 additions and 18 deletions
@ -0,0 +1,13 @@ |
||||
# DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py. |
||||
|
||||
load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package") |
||||
|
||||
licenses(["notice"]) # Apache 2 |
||||
|
||||
api_proto_package( |
||||
deps = [ |
||||
"//envoy/config/core/v3:pkg", |
||||
"//envoy/type/v3:pkg", |
||||
"@com_github_cncf_udpa//udpa/annotations:pkg", |
||||
], |
||||
) |
||||
@ -0,0 +1,115 @@ |
||||
syntax = "proto3"; |
||||
|
||||
package envoy.extensions.load_balancing_policies.common.v3; |
||||
|
||||
import "envoy/config/core/v3/base.proto"; |
||||
import "envoy/type/v3/percent.proto"; |
||||
|
||||
import "google/protobuf/duration.proto"; |
||||
import "google/protobuf/wrappers.proto"; |
||||
|
||||
import "udpa/annotations/status.proto"; |
||||
import "validate/validate.proto"; |
||||
|
||||
option java_package = "io.envoyproxy.envoy.extensions.load_balancing_policies.common.v3"; |
||||
option java_outer_classname = "CommonProto"; |
||||
option java_multiple_files = true; |
||||
option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/load_balancing_policies/common/v3;commonv3"; |
||||
option (udpa.annotations.file_status).package_version_status = ACTIVE; |
||||
|
||||
// [#protodoc-title: Common configuration for two or more load balancing policy extensions] |
||||
// [#not-implemented-hide:] |
||||
|
||||
message LocalityLbConfig { |
||||
// Configuration for :ref:`zone aware routing |
||||
// <arch_overview_load_balancing_zone_aware_routing>`. |
||||
message ZoneAwareLbConfig { |
||||
// Configures percentage of requests that will be considered for zone aware routing |
||||
// if zone aware routing is configured. If not specified, the default is 100%. |
||||
// * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`. |
||||
// * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`. |
||||
type.v3.Percent routing_enabled = 1; |
||||
|
||||
// Configures minimum upstream cluster size required for zone aware routing |
||||
// If upstream cluster size is less than specified, zone aware routing is not performed |
||||
// even if zone aware routing is configured. If not specified, the default is 6. |
||||
// * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`. |
||||
// * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`. |
||||
google.protobuf.UInt64Value min_cluster_size = 2; |
||||
|
||||
// If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic |
||||
// mode<arch_overview_load_balancing_panic_threshold>`. Instead, the cluster will fail all |
||||
// requests as if all hosts are unhealthy. This can help avoid potentially overwhelming a |
||||
// failing service. |
||||
bool fail_traffic_on_panic = 3; |
||||
} |
||||
|
||||
// Configuration for :ref:`locality weighted load balancing |
||||
// <arch_overview_load_balancing_locality_weighted_lb>` |
||||
message LocalityWeightedLbConfig { |
||||
} |
||||
|
||||
oneof locality_config_specifier { |
||||
option (validate.required) = true; |
||||
|
||||
// Configuration for local zone aware load balancing. |
||||
ZoneAwareLbConfig zone_aware_lb_config = 1; |
||||
|
||||
// Enable locality weighted load balancing. |
||||
LocalityWeightedLbConfig locality_weighted_lb_config = 2; |
||||
} |
||||
} |
||||
|
||||
// Configuration for :ref:`slow start mode <arch_overview_load_balancing_slow_start>`. |
||||
message SlowStartConfig { |
||||
// Represents the size of slow start window. |
||||
// If set, the newly created host remains in slow start mode starting from its creation time |
||||
// for the duration of slow start window. |
||||
google.protobuf.Duration slow_start_window = 1; |
||||
|
||||
// This parameter controls the speed of traffic increase over the slow start window. Defaults to 1.0, |
||||
// so that endpoint would get linearly increasing amount of traffic. |
||||
// When increasing the value for this parameter, the speed of traffic ramp-up increases non-linearly. |
||||
// The value of aggression parameter should be greater than 0.0. |
||||
// By tuning the parameter, is possible to achieve polynomial or exponential shape of ramp-up curve. |
||||
// |
||||
// During slow start window, effective weight of an endpoint would be scaled with time factor and aggression: |
||||
// ``new_weight = weight * max(min_weight_percent, time_factor ^ (1 / aggression))``, |
||||
// where ``time_factor=(time_since_start_seconds / slow_start_time_seconds)``. |
||||
// |
||||
// As time progresses, more and more traffic would be sent to endpoint, which is in slow start window. |
||||
// Once host exits slow start, time_factor and aggression no longer affect its weight. |
||||
config.core.v3.RuntimeDouble aggression = 2; |
||||
|
||||
// Configures the minimum percentage of origin weight that avoids too small new weight, |
||||
// which may cause endpoints in slow start mode receive no traffic in slow start window. |
||||
// If not specified, the default is 10%. |
||||
type.v3.Percent min_weight_percent = 3; |
||||
} |
||||
|
||||
// Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.) |
||||
message ConsistentHashingLbConfig { |
||||
// If set to ``true``, the cluster will use hostname instead of the resolved |
||||
// 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. |
||||
bool use_hostname_for_hashing = 1; |
||||
|
||||
// Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150 |
||||
// no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster. |
||||
// If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200. |
||||
// Minimum is 100. |
||||
// |
||||
// Applies to both Ring Hash and Maglev load balancers. |
||||
// |
||||
// This is implemented based on the method described in the paper https://arxiv.org/abs/1608.01350. For the specified |
||||
// ``hash_balance_factor``, requests to any upstream host are capped at ``hash_balance_factor/100`` times the average number of requests |
||||
// across the cluster. When a request arrives for an upstream host that is currently serving at its max capacity, linear probing |
||||
// is used to identify an eligible host. Further, the linear probe is implemented using a random jump in hosts ring/table to identify |
||||
// the eligible host (this technique is as described in the paper https://arxiv.org/abs/1908.08762 - the random jump avoids the |
||||
// cascading overflow effect when choosing the next host in the ring/table). |
||||
// |
||||
// If weights are specified on the hosts, they are respected. |
||||
// |
||||
// This is an O(N) algorithm, unlike other load balancers. Using a lower ``hash_balance_factor`` results in more hosts |
||||
// being probed, so use a higher value if you require better performance. |
||||
google.protobuf.UInt32Value hash_balance_factor = 2 [(validate.rules).uint32 = {gte: 100}]; |
||||
} |
||||
Loading…
Reference in new issue