failover_policy.proto

Package : resilience.policy.gloo.solo.io

Top

failover_policy.proto

Table of Contents

FailoverPolicySpec

FailoverPolicy is used to enable failover routing for traffic being sent to selected destinations. When traffic is being routed to a backing service within a selected virtual destination, if that backing service is detected as being in an unhealthy state, traffic will be re-routed to another healthy backing service by locality as specified in the FailoverPolicy config. FailoverPolicy can be used to reroute traffic across clusters when the local instance of a destination service fails. This requires that the backing destinations of the selected virtual destination belong to meshes in the same TrustDomain. FailoverPolicies are applied at the Destination level.
Note: If an OutlierDetectionPolicy is not configured for the same destinations, we will apply our default.

Field Type Label Description
applyToDestinations []common.gloo.solo.io.DestinationSelector repeated select the virtual destinations where the policy will be applied if left empty, will apply to all destinations in the workspace.
config resilience.policy.gloo.solo.io.FailoverPolicySpec.Config The details of the failover policy to apply to the selected virtual destinations.
You can exclude this if you wish to enable the locality load balancer settings without mappings.

FailoverPolicySpec.Config

Field Type Label Description
localityMappings []resilience.policy.gloo.solo.io.FailoverPolicySpec.Config.LocalityMappings repeated Mappings between localities to provide failover for traffic across regions, zones, and subzones.
You can exclude this if you wish to enable the locality load balancer settings without mappings.

FailoverPolicySpec.Config.LocalityMappings

Field Type Label Description
from resilience.policy.gloo.solo.io.FailoverPolicySpec.Config.LocalityMappings.OriginatingLocality Originating locality of the client workload.
to []resilience.policy.gloo.solo.io.FailoverPolicySpec.Config.LocalityMappings.DestinationLocality repeated The list of Destination localities that can be routed to if the instance local to the client workload is not available.

FailoverPolicySpec.Config.LocalityMappings.DestinationLocality

A geographic location defined by a region, zone, and sub-zone along with the weight for the destination.

Field Type Label Description
region string The locality's region.
zone string (Optional) The locality's zone.
subZone string (Optional) The locality's sub-zone.
weight google.protobuf.UInt32Value (Optional) Weight for destination locality. All weights must add up to 100. If not provided, we will determine the weight based on other destination locality weights.

FailoverPolicySpec.Config.LocalityMappings.OriginatingLocality

A geographic location defined by a region, zone, and sub-zone.

Field Type Label Description
region string The locality's region.
zone string (Optional) The locality's zone.
subZone string (Optional) The locality's sub-zone.

FailoverPolicyStatus

reflects the status of the FailoverPolicy

Field Type Label Description
global common.gloo.solo.io.GenericGlobalStatus
workspaces []resilience.policy.gloo.solo.io.FailoverPolicyStatus.WorkspacesEntry repeated The status of the resource in each workspace that it exists in.
selectedDestinationPorts []common.gloo.solo.io.DestinationReference repeated Destination ports selected by the policy

FailoverPolicyStatus.WorkspacesEntry

Field Type Label Description
key string
value common.gloo.solo.io.WorkspaceStatus