Minor tidying of the Consul documentation
This commit is contained in:
parent
2c2c02ab62
commit
464d63b890
|
@ -8,8 +8,9 @@ description: |-
|
|||
|
||||
# consul\_keys
|
||||
|
||||
`consul_keys` reads values from the Consul key/value store.
|
||||
This is a powerful way dynamically set values in templates.
|
||||
The `consul_keys` resource reads values from the Consul key/value store.
|
||||
This is a powerful way to This is a powerful way dynamically set values
|
||||
in templates.dynamically set values in templates.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
@ -56,7 +57,7 @@ The `key` block supports the following:
|
|||
or written to.
|
||||
|
||||
* `default` - (Optional) This is the default value to set for `var.<name>`
|
||||
if the key does not exist in Consul. Defaults to the empty string.
|
||||
if the key does not exist in Consul. Defaults to an empty string.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
|
|
|
@ -8,7 +8,9 @@ description: |-
|
|||
|
||||
# consul\_agent\_service
|
||||
|
||||
Provides access to Agent Service data in Consul. This can be used to define a service associated with a particular agent. Currently, defining health checks for an agent service is not supported.
|
||||
Provides access to the agent service data in Consul. This can be used to
|
||||
define a service associated with a particular agent. Currently, defining
|
||||
health checks for an agent service is not supported.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
@ -34,14 +36,13 @@ The following arguments are supported:
|
|||
|
||||
* `tags` - (Optional) A list of values that are opaque to Consul,
|
||||
but can be used to distinguish between services or nodes.
|
||||
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `address` - The address of the service.
|
||||
* `id` - The id of the service, defaults to the value of `name`.
|
||||
* `id` - The ID of the service, defaults to the value of `name`.
|
||||
* `name` - The name of the service.
|
||||
* `port` - The port of the service.
|
||||
* `tags` - The tags of the service.
|
||||
|
|
|
@ -8,7 +8,8 @@ description: |-
|
|||
|
||||
# consul\_catalog\_entry
|
||||
|
||||
Provides access to Catalog data in Consul. This can be used to define a node or a service. Currently, defining health checks is not supported.
|
||||
Provides access to Catalog data in Consul. This can be used to define a
|
||||
node or a service. Currently, defining health checks is not supported.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
@ -30,14 +31,14 @@ resource "consul_catalog_entry" "app" {
|
|||
|
||||
The following arguments are supported:
|
||||
|
||||
* `address` - (Required) The address of the node being added to
|
||||
* `address` - (Required) The address of the node being added to,
|
||||
or referenced in the catalog.
|
||||
|
||||
* `node` - (Required) The name of the node being added to or
|
||||
* `node` - (Required) The name of the node being added to or,
|
||||
referenced in the catalog.
|
||||
|
||||
* `service` - (Optional) A service to optionally associated with
|
||||
the node. Supported values documented below.
|
||||
the node. Supported values are documented below.
|
||||
|
||||
The `service` block supports the following:
|
||||
|
||||
|
@ -48,11 +49,10 @@ The `service` block supports the following:
|
|||
* `port` - (Optional) The port of the service.
|
||||
* `tags` - (Optional) A list of values that are opaque to Consul,
|
||||
but can be used to distinguish between services or nodes.
|
||||
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `address` - The address of the service.
|
||||
* `node` - The id of the service, defaults to the value of `name`.
|
||||
* `node` - The ID of the service, defaults to the value of `name`.
|
||||
|
|
|
@ -8,15 +8,15 @@ description: |-
|
|||
|
||||
# consul\_keys
|
||||
|
||||
`consul_keys` writes sets of individual values into Consul.
|
||||
The `consul_keys` resource writes sets of individual values into Consul.
|
||||
This is a powerful way to expose infrastructure details to clients.
|
||||
|
||||
This resource manages individual keys, and thus it can create, update and
|
||||
delete the keys explicitly given. However, It is not able to detect and remove
|
||||
additional keys that have been added by non-Terraform means. To manage
|
||||
*all* keys sharing a common prefix, and thus have Terraform remove errant keys
|
||||
not present in the configuration, consider using the `consul_key_prefix`
|
||||
resource instead.
|
||||
This resource manages individual keys, and thus it can create, update
|
||||
and delete the keys explicitly given. However, it is not able to detect
|
||||
and remove additional keys that have been added by non-Terraform means.
|
||||
To manage *all* keys sharing a common prefix, and thus have Terraform
|
||||
remove errant keys not present in the configuration, consider using the
|
||||
`consul_key_prefix` resource instead.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
@ -60,11 +60,11 @@ The `key` block supports the following:
|
|||
|
||||
### Deprecated `key` arguments
|
||||
|
||||
Prior to Terraform 0.7 this resource was used both to read *and* write the
|
||||
Prior to Terraform 0.7, this resource was used both to read *and* write the
|
||||
Consul key/value store. The read functionality has moved to the `consul_keys`
|
||||
*data source*, whose documentation can be found via the navigation.
|
||||
|
||||
The pre-0.7 interface for reading is still supported for backward compatibility,
|
||||
The pre-0.7 interface for reading keys is still supported for backward compatibility,
|
||||
but will be removed in a future version of Terraform.
|
||||
|
||||
## Attributes Reference
|
||||
|
|
|
@ -8,7 +8,8 @@ description: |-
|
|||
|
||||
# consul\_node
|
||||
|
||||
Provides access to Node data in Consul. This can be used to define a node. Currently, defining health checks is not supported.
|
||||
Provides access to Node data in Consul. This can be used to define a
|
||||
node. Currently, defining health checks is not supported.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
@ -23,10 +24,10 @@ resource "consul_node" "foobar" {
|
|||
|
||||
The following arguments are supported:
|
||||
|
||||
* `address` - (Required) The address of the node being added to
|
||||
* `address` - (Required) The address of the node being added to,
|
||||
or referenced in the catalog.
|
||||
|
||||
* `name` - (Required) The name of the node being added to or
|
||||
* `name` - (Required) The name of the node being added to, or
|
||||
referenced in the catalog.
|
||||
|
||||
## Attributes Reference
|
||||
|
|
|
@ -63,7 +63,7 @@ The following arguments are supported:
|
|||
|
||||
* `service` - (Required) The name of the service to query.
|
||||
|
||||
* `only_passing` - (Optional) When true, the prepared query will only
|
||||
* `only_passing` - (Optional) When `true`, the prepared query will only
|
||||
return nodes with passing health checks in the result.
|
||||
|
||||
* `near` - (Optional) Allows specifying the name of a node to sort results
|
||||
|
|
|
@ -3,12 +3,13 @@ layout: "consul"
|
|||
page_title: "Consul: consul_service"
|
||||
sidebar_current: "docs-consul-resource-service"
|
||||
description: |-
|
||||
A high-level resource for creating a Service in Consul. Since Consul requires clients to register services with either the catalog or an agent, `consul_service` may register with either the catalog or an agent, depending on the configuration of `consul_service`. For now, `consul_service` always registers services with the agent running at the address defined in the `consul` resource. Health checks are not currently supported.
|
||||
A high-level resource for creating a Service in Consul. Since Consul requires clients to register services with either the catalog or an agent, `consul_service` may register with either the catalog or an agent, depending on the configuration of `consul_service`. For now, `consul_service` always registers services with the agent running at the address defined in the `consul` resource. Health checks are not currently supported.
|
||||
---
|
||||
|
||||
# consul\_service
|
||||
|
||||
A high-level resource for creating a Service in Consul. Currently, defining health checks for a service is not supported.
|
||||
A high-level resource for creating a Service in Consul. Currently,
|
||||
defining health checks for a service is not supported.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
@ -25,7 +26,8 @@ resource "consul_service" "google" {
|
|||
|
||||
The following arguments are supported:
|
||||
|
||||
* `service_id` - (Optional, string) The id of the service, defaults to the value of `name` if not supplied.
|
||||
* `service_id` - (Optional, string) The ID of the service, defaults to the value of `name`
|
||||
if not supplied.
|
||||
|
||||
* `address` - (Optional, string) The address of the service. Defaults to the
|
||||
address of the agent.
|
||||
|
|
Loading…
Reference in New Issue