From d281c89ad08fc0966f115134f621eea79e96b8c9 Mon Sep 17 00:00:00 2001 From: Eric Haberkorn Date: Fri, 12 Aug 2022 11:06:16 -0400 Subject: [PATCH] Cluster Peering Prepared Query Failover Documentation (#13846) Add documentation for cluster peering prepared query failover --- website/content/api-docs/query.mdx | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/website/content/api-docs/query.mdx b/website/content/api-docs/query.mdx index 85ee3c8b38..54a148e9ad 100644 --- a/website/content/api-docs/query.mdx +++ b/website/content/api-docs/query.mdx @@ -193,14 +193,25 @@ The table below shows this endpoint's support for handling the query to the servers in the remote datacenter is used to determine the priority. - - `Datacenters` `(array: nil)` - Specifies a fixed list of remote - datacenters to forward the query to if there are no healthy nodes in the + - `Datacenters` `(array: nil)` - Specifies a fixed list of WAN federated + datacenters to forward the query to when there are no healthy nodes in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined with `NearestN`, then the `NearestN` queries will be performed first, followed by the list given by `Datacenters`. A given datacenter will only be queried one time during a failover, even if it is selected by both `NearestN` and is listed in - `Datacenters`. + `Datacenters`. Use `Targets` to failover to cluster peers. + + - `Targets` `(array: nil)` - Specifies a sequential list of remote + datacenters and cluster peers to failover to if there are no healthy + service instances in the local datacenter. + This option cannot be used with `NearestN` or `Datacenters`. + + - `PeerName` `(string: "")` - Specifies a [cluster peer](/docs/connect/cluster-peering) to use for + failover. + + - `Datacenter` `(string: "")` - Specifies a WAN federated datacenter to forward the + query to. - `IgnoreCheckIDs` `(array: nil)` - Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful