Endpoints¶

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

api/v2/endpoint/endpoint_components.proto

config.endpoint.v3.Endpoint¶

Upstream host identifier.

{
  "address": "{...}",
  "health_check_config": "{...}",
  "hostname": "..."
}

address: (config.core.v3.Address) The upstream host address.

Attention

The form of host address depends on the given cluster type. For STATIC or EDS, it is expected to be a direct IP address (or something resolvable by the specified resolver in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname, and will be resolved via DNS.

health_check_config: (config.endpoint.v3.Endpoint.HealthCheckConfig) The optional health check configuration is used as configuration for the health checker to contact the health checked host.

Attention

This takes into effect only for upstream clusters with active health checking enabled.

hostname: (string) The hostname associated with this endpoint. This hostname is not used for routing or address resolution. If provided, it will be associated with the endpoint, and can be used for features that require a hostname, like auto_host_rewrite.

config.endpoint.v3.Endpoint.HealthCheckConfig¶

[config.endpoint.v3.Endpoint.HealthCheckConfig proto]

The optional health check configuration.

{
  "port_value": "...",
  "hostname": "..."
}

port_value

(uint32) Optional alternative health check port value.

By default the health check address port of an upstream host is the same as the host’s serving address port. This provides an alternative health check port. Setting this with a non-zero value allows an upstream host to have different health check address port.

hostname: (string) By default, the host header for L7 health checks is controlled by cluster level configuration (see: host and authority). Setting this to a non-empty value allows overriding the cluster level configuration for a specific endpoint.

config.endpoint.v3.LbEndpoint¶

[config.endpoint.v3.LbEndpoint proto]

An Endpoint that Envoy can route traffic to.

{
  "endpoint": "{...}",
  "health_status": "...",
  "metadata": "{...}",
  "load_balancing_weight": "{...}"
}

endpoint: (config.endpoint.v3.Endpoint) Upstream host identifier or a named reference.

health_status: (config.core.v3.HealthStatus) Optional health status when known and supplied by EDS server.

metadata: (config.core.v3.Metadata) The endpoint metadata specifies values that may be used by the load balancer to select endpoints in a cluster for a given request. The filter name should be specified as envoy.lb. An example boolean key-value pair is canary, providing the optional canary status of the upstream host. This may be matched against in a route’s RouteAction metadata_match field to subset the endpoints considered in cluster load balancing.

load_balancing_weight: (UInt32Value) The optional load balancing weight of the upstream host; at least 1. Envoy uses the load balancing weight in some of the built in load balancers. The load balancing weight for an endpoint is divided by the sum of the weights of all endpoints in the endpoint’s locality to produce a percentage of traffic for the endpoint. This percentage is then further weighted by the endpoint’s locality’s load balancing weight from LocalityLbEndpoints. If unspecified, each host is presumed to have equal weight in a locality. The sum of the weights of all endpoints in the endpoint’s locality must not exceed uint32_t maximal value (4294967295).

config.endpoint.v3.LocalityLbEndpoints¶

[config.endpoint.v3.LocalityLbEndpoints proto]

A group of endpoints belonging to a Locality. One can have multiple LocalityLbEndpoints for a locality, but only if they have different priorities.

{
  "locality": "{...}",
  "lb_endpoints": [],
  "load_balancer_endpoints": "{...}",
  "leds_cluster_locality_config": "{...}",
  "load_balancing_weight": "{...}",
  "priority": "..."
}

locality: (config.core.v3.Locality) Identifies location of where the upstream hosts run.

lb_endpoints: (repeated config.endpoint.v3.LbEndpoint) The group of endpoints belonging to the locality specified.

load_balancing_weight

(UInt32Value) Optional: Per priority/region/zone/sub_zone weight; at least 1. The load balancing weight for a locality is divided by the sum of the weights of all localities at the same priority level to produce the effective percentage of traffic for the locality. The sum of the weights of all localities at the same priority level must not exceed uint32_t maximal value (4294967295).

Locality weights are only considered when locality weighted load balancing is configured. These weights are ignored otherwise. If no weights are specified when locality weighted load balancing is enabled, the locality is assigned no load.

priority

(uint32) Optional: the priority for this LocalityLbEndpoints. If unspecified this will default to the highest priority (0).

Under usual circumstances, Envoy will only select endpoints for the highest priority (0). In the event all endpoints for a particular priority are unavailable/unhealthy, Envoy will fail over to selecting endpoints for the next highest priority group.

Priorities should range from 0 (highest) to N (lowest) without skipping.