Documentation
Reference
API
API components
failover.proto

failover.proto

Package: gloo.solo.io Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/v1/failover.proto

Failover

Failover configuration for an upstream.

Failover allows for optional fallback endpoints in the case that the primary set of endpoints is deemed unhealthy. As failover requires knowledge of the health of each set of endpoints, active or passive health checks must be configured on an upstream using failover in order for it to work properly.

Failover closely resembles the Envoy config which this is translated to, with one notable exception. The priorities are not defined on the LocalityLbEndpoints but rather inferred from the list of PrioritizedLocality. More information on envoy prioritization can be found here. In practice this means that the priority of a given set of LocalityLbEndpoints is determined by its index in the list, first being 0 through n-1.

"prioritizedLocalities": []gloo.solo.io.Failover.PrioritizedLocality
"policy": .gloo.solo.io.Failover.Policy
Field Type Description
prioritizedLocalities []gloo.solo.io.Failover.PrioritizedLocality PrioritizedLocality is an implicitly prioritized list of lists of LocalityLbEndpoints. The priority of each list of LocalityLbEndpoints is determined by its index in the list.
policy .gloo.solo.io.Failover.Policy Load balancing policy settings.

PrioritizedLocality 

"localityEndpoints": []gloo.solo.io.LocalityLbEndpoints
Field Type Description
localityEndpoints []gloo.solo.io.LocalityLbEndpoints

Policy 

"overprovisioningFactor": .google.protobuf.UInt32Value
Field Type Description
overprovisioningFactor .google.protobuf.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.

LocalityLbEndpoints

A group of endpoints belonging to a Locality. One can have multiple LocalityLbEndpoints for a locality, but this is generally only done if the different groups need to have different load balancing weights or different priorities.

"locality": .gloo.solo.io.Locality
"lbEndpoints": []gloo.solo.io.LbEndpoint
"loadBalancingWeight": .google.protobuf.UInt32Value
Field Type Description
locality .gloo.solo.io.Locality Identifies where the parent upstream hosts run.
lbEndpoints []gloo.solo.io.LbEndpoint The group of endpoints belonging to the locality specified. Note: If any address is DNS resolvable than lb_endpoints[].load_balancing_weight is not allowed on any of this locality’s endpoints.
loadBalancingWeight .google.protobuf.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. To enable locality weighted load balancing, load_balancer_config.locality_weighted_lb_config must be set as well.

LbEndpoint

An Endpoint that Envoy can route traffic to.

"address": string
"port": int
"healthCheckConfig": .gloo.solo.io.LbEndpoint.HealthCheckConfig
"upstreamSslConfig": .gloo.solo.io.UpstreamSslConfig
"loadBalancingWeight": .google.protobuf.UInt32Value
"metadata": map<string, .google.protobuf.Struct>
Field Type Description
address string Address (hostname or IP).
port int Port the instance is listening on.
healthCheckConfig .gloo.solo.io.LbEndpoint.HealthCheckConfig The optional health check configuration is used as configuration for the health checker to contact the health checked host. This takes into effect only for upstreams with active health checking enabled.
upstreamSslConfig .gloo.solo.io.UpstreamSslConfig
loadBalancingWeight .google.protobuf.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.
metadata map<string, .google.protobuf.Struct> Additional metadata to add to the endpoint. This metadata can be used in upstream HTTP filters or other specific Envoy configurations. The following keys are added by K8sGateway Edge and are ignored if set: - “envoy.transport_socket_match” - “io.solo.health_checkers.advanced_http”.

HealthCheckConfig

The optional health check configuration.

"portValue": int
"hostname": string
"path": string
"method": string
Field Type Description
portValue int 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. Setting this to a non-empty value allows overriding the cluster level configuration for a specific endpoint.
path string Path to use when health checking this failover endpoint. Default is empty path.
method string Method to use when health checking this failover endpoint. Defaults to GET.

Locality

Identifies location of where either Envoy runs or where upstream hosts run.

"region": string
"zone": string
"subZone": string
Field Type Description
region string Region this zone belongs to.
zone string Defines the local service zone where Envoy is running. The meaning of zone is context dependent, e.g. Availability Zone (AZ) <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>_ on AWS, Zone <https://cloud.google.com/compute/docs/regions-zones/>_ on GCP, etc.
subZone string When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.
extensions.protofault.proto