From 5707ac9d17a946781b70315e3b8ddded8d1e7abb Mon Sep 17 00:00:00 2001 From: freddygv Date: Fri, 11 Sep 2020 10:50:57 -0600 Subject: [PATCH] Update website docs --- .../agent/config-entries/service-resolver.mdx | 89 ++++++++++--------- 1 file changed, 45 insertions(+), 44 deletions(-) diff --git a/website/pages/docs/agent/config-entries/service-resolver.mdx b/website/pages/docs/agent/config-entries/service-resolver.mdx index c5a27b533..531749441 100644 --- a/website/pages/docs/agent/config-entries/service-resolver.mdx +++ b/website/pages/docs/agent/config-entries/service-resolver.mdx @@ -169,54 +169,55 @@ LoadBalancer = { - `LoadBalancer` `(LoadBalancer`) - Determines the load balancing policy and 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 - for this upstream. - - - `Policy` `(string: "")` - The load balancing policy used to select a host. - One of: `random`, `round_robin`, `least_request`, `ring_hash`, `maglev`. - - - `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. + - `Policy` `(string: "")` - The load balancing policy used to select a host. + One of: `random`, `round_robin`, `least_request`, `ring_hash`, `maglev`. + + - `RingHashConfig` `(RingHashConfig)` - Configuration for the `ring_hash` + policy type. - - `LeastRequestConfig` `(LeastRequestConfig)` - Configuration for the `least_request` - policy type. - - - `ChoiceCount` `(int: 2)` - Determines the number of random healthy hosts - from which to select the one with the least requests. + - `MinimumRingRize` `(int: 1024)` - Determines the minimum number of entries + in the hash ring. - - `HashPolicies` `(array)` - 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. + - `MaximumRingRize` `(int: 8192)` - Determines the maximum number of entries + in the hash ring. + + - `LeastRequestConfig` `(LeastRequestConfig)` - Configuration for the `least_request` + policy type. + + - `ChoiceCount` `(int: 2)` - Determines the number of random healthy hosts + from which to select the one with the least requests. + + - `HashPolicies` `(array)` - 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. - Must be one of `header`,`cookie`, or `query_parameter`. - Cannot be specified along with `SourceAddress`. - - - `FieldValue` `(string: "")` - The value to hash. - ie. header name, cookie name, URL query parameter name. - Cannot be specified along with `SourceAddress`. - - - `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. - - - `SourceIP` `(bool: false)` - Determines whether the hash should be of the source IP - address rather than of a field and field value. - Cannot be specified along with `Field` or `FieldValue`. - - - `Terminal` `(bool: false)` - Will short circuit the computation of the hash - 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 - hash policies will be ignored. + - `FieldValue` `(string: "")` - The value to hash. + ie. header name, cookie name, URL query parameter name. + Cannot be specified along with `SourceAddress`. + + - `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. + + - `TTL` `(duration: 0s)` - TTL for generated cookies. + + - `Path` `(string: "")` - The path to set for the cookie. + + - `SourceIP` `(bool: false)` - Determines whether the hash should be of the source IP + address rather than of a field and field value. + Cannot be specified along with `Field` or `FieldValue`. + + - `Terminal` `(bool: false)` - Will short circuit the computation of the hash + 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 + hash policies will be ignored. ## Service Subsets