Update website docs
This commit is contained in:
parent
ae8c609f10
commit
5707ac9d17
|
@ -169,54 +169,55 @@ LoadBalancer = {
|
||||||
|
|
||||||
- `LoadBalancer` `(LoadBalancer`) - Determines the load balancing policy and
|
- `LoadBalancer` `(LoadBalancer`) - Determines the load balancing policy and
|
||||||
configuration for services issuing requests to this upstream.
|
configuration for services issuing requests to this upstream.
|
||||||
This option is available in Consul versions 1.8.4 and newer.
|
This option is available in Consul versions 1.9.0 and newer.
|
||||||
|
|
||||||
- `EnvoyLBConfig` `(EnvoyLBConfig)` - Envoy proxy specific load balancing configuration
|
- `Policy` `(string: "")` - The load balancing policy used to select a host.
|
||||||
for this upstream.
|
One of: `random`, `round_robin`, `least_request`, `ring_hash`, `maglev`.
|
||||||
|
|
||||||
- `Policy` `(string: "")` - The load balancing policy used to select a host.
|
- `RingHashConfig` `(RingHashConfig)` - Configuration for the `ring_hash`
|
||||||
One of: `random`, `round_robin`, `least_request`, `ring_hash`, `maglev`.
|
policy type.
|
||||||
|
|
||||||
- `RingHashConfig` `(RingHashConfig)` - Configuration for the `ring_hash`
|
|
||||||
policy type.
|
|
||||||
|
|
||||||
- `MinimumRingRize` `(int: 1024)` - Determines the minimum number of entries
|
|
||||||
in the hash ring.
|
|
||||||
|
|
||||||
- `MaximumRingRize` `(int: 8192)` - Determines the maximum number of entries
|
|
||||||
in the hash ring.
|
|
||||||
|
|
||||||
- `LeastRequestConfig` `(LeastRequestConfig)` - Configuration for the `least_request`
|
- `MinimumRingRize` `(int: 1024)` - Determines the minimum number of entries
|
||||||
policy type.
|
in the hash ring.
|
||||||
|
|
||||||
- `ChoiceCount` `(int: 2)` - Determines the number of random healthy hosts
|
|
||||||
from which to select the one with the least requests.
|
|
||||||
|
|
||||||
- `HashPolicies` `(array<HashPolicies>)` - a list of hash policies to use for
|
- `MaximumRingRize` `(int: 8192)` - Determines the maximum number of entries
|
||||||
hashing load balancing algorithms. Hash policies are evaluated individually
|
in the hash ring.
|
||||||
and combined such that identical lists result in the same hash.
|
|
||||||
If no hash policies are present, or none are successfully evaluated,
|
- `LeastRequestConfig` `(LeastRequestConfig)` - Configuration for the `least_request`
|
||||||
then a random backend host will be selected.
|
policy type.
|
||||||
|
|
||||||
|
- `ChoiceCount` `(int: 2)` - Determines the number of random healthy hosts
|
||||||
|
from which to select the one with the least requests.
|
||||||
|
|
||||||
|
- `HashPolicies` `(array<HashPolicies>)` - a list of hash policies to use for
|
||||||
|
hashing load balancing algorithms. Hash policies are evaluated individually
|
||||||
|
and combined such that identical lists result in the same hash.
|
||||||
|
If no hash policies are present, or none are successfully evaluated,
|
||||||
|
then a random backend host will be selected.
|
||||||
|
|
||||||
|
- `Field` `(string: "")` - The attribute type to hash on.
|
||||||
|
Must be one of `header`,`cookie`, or `query_parameter`.
|
||||||
|
Cannot be specified along with `SourceAddress`.
|
||||||
|
|
||||||
- `Field` `(string: "")` - The attribute type to hash on.
|
- `FieldValue` `(string: "")` - The value to hash.
|
||||||
Must be one of `header`,`cookie`, or `query_parameter`.
|
ie. header name, cookie name, URL query parameter name.
|
||||||
Cannot be specified along with `SourceAddress`.
|
Cannot be specified along with `SourceAddress`.
|
||||||
|
|
||||||
- `FieldValue` `(string: "")` - The value to hash.
|
- `CookieConfig` `(CookieConfig)` - Additional configuration for the "cookie" hash policy type.
|
||||||
ie. header name, cookie name, URL query parameter name.
|
This is specified to have Envoy generate a cookie for a client on its first request.
|
||||||
Cannot be specified along with `SourceAddress`.
|
|
||||||
|
- `TTL` `(duration: 0s)` - TTL for generated cookies.
|
||||||
- `CookieConfig` `(CookieConfig)` - Additional configuration for the "cookie" hash policy type.
|
|
||||||
This is specified to have Envoy generate a cookie for a client on its first request.
|
- `Path` `(string: "")` - The path to set for the cookie.
|
||||||
|
|
||||||
- `SourceIP` `(bool: false)` - Determines whether the hash should be of the source IP
|
- `SourceIP` `(bool: false)` - Determines whether the hash should be of the source IP
|
||||||
address rather than of a field and field value.
|
address rather than of a field and field value.
|
||||||
Cannot be specified along with `Field` or `FieldValue`.
|
Cannot be specified along with `Field` or `FieldValue`.
|
||||||
|
|
||||||
- `Terminal` `(bool: false)` - Will short circuit the computation of the hash
|
- `Terminal` `(bool: false)` - Will short circuit the computation of the hash
|
||||||
when multiple hash policies are present. If a hash is computed when a
|
when multiple hash policies are present. If a hash is computed when a
|
||||||
Terminal policy is evaluated, then that hash will be used and subsequent
|
Terminal policy is evaluated, then that hash will be used and subsequent
|
||||||
hash policies will be ignored.
|
hash policies will be ignored.
|
||||||
|
|
||||||
## Service Subsets
|
## Service Subsets
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue