aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2017-04-24 08:49:06 -0700
committerGravatar GitHub <noreply@github.com>2017-04-24 08:49:06 -0700
commit18548b8a0b2b703380e0c9525eb143027eaab9f3 (patch)
treeee098045cc41b72d740de19d13edb093ee9ea688 /doc
parent7e0e18d21e996c1bed242bca8eacb559527f95e3 (diff)
parente5db8412f20ab454eac6b38c8d65d48456b86f63 (diff)
Merge pull request #10258 from markdroth/service_config_lb_semantics
Fix semantics of LB policy selection.
Diffstat (limited to 'doc')
-rw-r--r--doc/service_config.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/doc/service_config.md b/doc/service_config.md
index ecc23817d1..8039fcad09 100644
--- a/doc/service_config.md
+++ b/doc/service_config.md
@@ -13,12 +13,21 @@ The service config is a JSON string of the following form:
```
{
// Load balancing policy name.
- // Supported values are 'round_robin' and 'grpclb'.
- // Optional; if unset, the default behavior is pick the first available
- // backend.
- // Note that if the resolver returns only balancer addresses and no
- // backend addresses, gRPC will always use the 'grpclb' policy,
- // regardless of what this field is set to.
+ // Currently, the only selectable client-side policy provided with gRPC
+ // is 'round_robin', but third parties may add their own policies.
+ // This field is optional; if unset, the default behavior is to pick
+ // the first available backend.
+ // If the policy name is set via the client API, that value overrides
+ // the value specified here.
+ //
+ // Note that if the resolver returns at least one balancer address (as
+ // opposed to backend addresses), gRPC will use grpclb (see
+ // https://github.com/grpc/grpc/blob/master/doc/load-balancing.md),
+ // regardless of what LB policy is requested either here or via the
+ // client API. However, if the resolver returns at least one backend
+ // address in addition to the balancer address(es), the client may fall
+ // back to the requested policy if it is unable to reach any of the
+ // grpclb load balancers.
'loadBalancingPolicy': string,
// Per-method configuration. Optional.