Endpoint configuration (proto)

Endpoint discovery architecture overview

config.endpoint.v3.ClusterLoadAssignment

[config.endpoint.v3.ClusterLoadAssignment proto]

Each route from RDS will map to a single cluster or traffic split across clusters using weights expressed in the RDS WeightedCluster.

With EDS, each cluster is treated independently from a LB perspective, with LB taking place between the Localities within a cluster and at a finer granularity between the hosts within a locality. The percentage of traffic for each endpoint is determined by both its load_balancing_weight, and the load_balancing_weight of its locality. First, a locality will be selected, then an endpoint within that locality will be chose based on its weight.

{
  "cluster_name": ...,
  "endpoints": [],
  "policy": {...}
}

cluster_name: (string, REQUIRED) Name of the cluster. This will be the service_name value if specified in the cluster EdsClusterConfig.

endpoints: (repeated config.endpoint.v3.LocalityLbEndpoints) List of endpoints to load balance to.

policy: (config.endpoint.v3.ClusterLoadAssignment.Policy) Load balancing policy settings.

config.endpoint.v3.ClusterLoadAssignment.Policy

[config.endpoint.v3.ClusterLoadAssignment.Policy proto]

Load balancing policy settings.

{
  "drop_overloads": [],
  "overprovisioning_factor": {...},
  "endpoint_stale_after": {...},
  "weighted_priority_health": ...
}

drop_overloads

(repeated config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload) Action to trim the overall incoming traffic to protect the upstream hosts. This action allows protection in case the hosts are unable to recover from an outage, or unable to autoscale or unable to handle incoming traffic volume for any reason.

At the client each category is applied one after the other to generate the ‘actual’ drop percentage on all outgoing traffic. For example:

{ "drop_overloads": [
    { "category": "throttle", "drop_percentage": 60 }
    { "category": "lb", "drop_percentage": 50 }
]}

The actual drop percentages applied to the traffic at the clients will be: “throttle”_drop = 60% “lb”_drop = 20% // 50% of the remaining ‘actual’ load, which is 40%. actual_outgoing_load = 20% // remaining after applying all categories.

Envoy supports only one element and will NACK if more than one element is present. Other xDS-capable data planes will not necessarily have this limitation.

overprovisioning_factor

(UInt32Value) Priority levels and localities are considered overprovisioned with this factor (in percentage). This means that we don’t consider a priority level or locality unhealthy until the fraction of healthy hosts multiplied by the overprovisioning factor drops below 100. With the default value 140(1.4), Envoy doesn’t consider a priority level or a locality unhealthy until their percentage of healthy hosts drops below 72%. For example:

{ "overprovisioning_factor": 100 }

Read more at priority levels and localities.

endpoint_stale_after: (Duration) The max time until which the endpoints from this assignment can be used. If no new assignments are received before this time expires the endpoints are considered stale and should be marked unhealthy. Defaults to 0 which means endpoints never go stale.

weighted_priority_health

(bool) If true, use the load balancing weight of healthy and unhealthy hosts to determine the health of the priority level. If false, use the number of healthy and unhealthy hosts to determine the health of the priority level, or in other words assume each host has a weight of 1 for this calculation.

Note: this is not currently implemented for locality weighted load balancing.

config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload

[config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload proto]

{
  "category": ...,
  "drop_percentage": {...}
}

category: (string, REQUIRED) Identifier for the policy specifying the drop.

drop_percentage: (type.v3.FractionalPercent) Percentage of traffic that should be dropped for the category.