luxolus/open-consul
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

Cluster Peering Prepared Query Failover Documentation (#13846)

Browse source 
Add documentation for cluster peering prepared query failover
This commit is contained in:
Eric Haberkorn 2022-08-12 11:06:16 -04:00 committed by GitHub
parent cc885101e5
commit 21b5aade56
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
website/content/api-docs/query.mdx
View file

@ -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 handling the query to the servers in the remote datacenter is used to
determine the priority. determine the priority.
- `Datacenters` `(array<string>: nil)` - Specifies a fixed list of remote - `Datacenters` `(array<string>: nil)` - Specifies a fixed list of WAN federated
datacenters to forward the query to if there are no healthy nodes in the 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 local datacenter. Datacenters are queried in the order given in the
list. If this option is combined with `NearestN`, then the `NearestN` list. If this option is combined with `NearestN`, then the `NearestN`
queries will be performed first, followed by the list given by queries will be performed first, followed by the list given by
`Datacenters`. A given datacenter will only be queried one time during a `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 failover, even if it is selected by both `NearestN` and is listed in
`Datacenters`. `Datacenters`. Use `Targets` to failover to cluster peers.
- `Targets` `(array<Target>: 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<string>: nil)` - Specifies a list of check IDs that - `IgnoreCheckIDs` `(array<string>: nil)` - Specifies a list of check IDs that
should be ignored when filtering unhealthy instances. This is mostly useful should be ignored when filtering unhealthy instances. This is mostly useful