Complete the docs for Consul Prepared Query.

While here add an additional example of a standard prepared query in
addition to the prepared query template that was already present.
This commit is contained in:
Sean Chittenden 2016-12-10 12:22:51 +11:00
parent 1f5b940f3f
commit df7a15fff9
No known key found for this signature in database
GPG Key ID: 4EBC9DC16C2E5E16
1 changed files with 37 additions and 1 deletions

View File

@ -17,6 +17,33 @@ queries in your Consul cluster using Terraform.
## Example Usage
```
# Creates a prepared query myquery.query.consul that finds the nearest
# healthy myapp.service.consul instance that has the active tag and not
# the standby tag.
resource "consul_prepared_query" "myapp-query" {
name = "myquery"
datacenter = "us-central1"
token = "abcd"
stored_token = "wxyz"
only_passing = true
near = "_agent"
service = "myapp"
tags = ["active","!standby"]
failover {
nearest_n = 3
datacenters = ["us-west1", "us-east-2", "asia-east1"]
}
dns {
ttl = "30s"
}
}
# Creates a Prepared Query Template that matches *-near-self.query.consul
# and finds the nearest service that matches the glob character (e.g.
# foo-near-self.query.consul will find the nearest healthy foo.service.consul).
resource "consul_prepared_query" "service-near-self" {
datacenter = "nyc1"
token = "abcd"
@ -40,7 +67,6 @@ resource "consul_prepared_query" "service-near-self" {
dns {
ttl = "5m"
}
}
```
@ -63,6 +89,16 @@ The following arguments are supported:
* `service` - (Required) The name of the service to query.
* `session` - (Optional) The name of the Consul session to tie this query's
lifetime to. This is an advanced parameter that should not be used without a
complete understanding of Consul sessions and the implications of their use
(it is recommended to leave this blank in nearly all cases). If this
parameter is omitted the query will not expire.
* `tags` - (Optional) The list of required and/or disallowed tags. If a tag is
in this list it must be present. If the tag is preceded with a "!" then it is
disallowed.
* `only_passing` - (Optional) When `true`, the prepared query will only
return nodes with passing health checks in the result.