From 464d63b8902e5e937ddbe7fcb028ece6ed126ea6 Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Tue, 8 Nov 2016 15:43:00 +0100 Subject: [PATCH 1/3] Minor tidying of the Consul documentation --- .../docs/providers/consul/d/keys.html.markdown | 7 ++++--- .../consul/r/agent_service.html.markdown | 7 ++++--- .../consul/r/catalog_entry.html.markdown | 12 ++++++------ .../docs/providers/consul/r/keys.html.markdown | 18 +++++++++--------- .../docs/providers/consul/r/node.html.markdown | 7 ++++--- .../providers/consul/r/prepared_query.markdown | 2 +- .../providers/consul/r/service.html.markdown | 8 +++++--- 7 files changed, 33 insertions(+), 28 deletions(-) diff --git a/website/source/docs/providers/consul/d/keys.html.markdown b/website/source/docs/providers/consul/d/keys.html.markdown index 1e84393752..5172474b6a 100644 --- a/website/source/docs/providers/consul/d/keys.html.markdown +++ b/website/source/docs/providers/consul/d/keys.html.markdown @@ -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.` - 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 diff --git a/website/source/docs/providers/consul/r/agent_service.html.markdown b/website/source/docs/providers/consul/r/agent_service.html.markdown index edf7524dd3..8d1976c7d5 100644 --- a/website/source/docs/providers/consul/r/agent_service.html.markdown +++ b/website/source/docs/providers/consul/r/agent_service.html.markdown @@ -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. diff --git a/website/source/docs/providers/consul/r/catalog_entry.html.markdown b/website/source/docs/providers/consul/r/catalog_entry.html.markdown index 552a6a6693..0ab56c168a 100644 --- a/website/source/docs/providers/consul/r/catalog_entry.html.markdown +++ b/website/source/docs/providers/consul/r/catalog_entry.html.markdown @@ -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`. diff --git a/website/source/docs/providers/consul/r/keys.html.markdown b/website/source/docs/providers/consul/r/keys.html.markdown index c0cdc1653b..b11d758b3a 100644 --- a/website/source/docs/providers/consul/r/keys.html.markdown +++ b/website/source/docs/providers/consul/r/keys.html.markdown @@ -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 diff --git a/website/source/docs/providers/consul/r/node.html.markdown b/website/source/docs/providers/consul/r/node.html.markdown index d8cc322bbe..8713185dab 100644 --- a/website/source/docs/providers/consul/r/node.html.markdown +++ b/website/source/docs/providers/consul/r/node.html.markdown @@ -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 diff --git a/website/source/docs/providers/consul/r/prepared_query.markdown b/website/source/docs/providers/consul/r/prepared_query.markdown index a8c6cd4124..f0073b2338 100644 --- a/website/source/docs/providers/consul/r/prepared_query.markdown +++ b/website/source/docs/providers/consul/r/prepared_query.markdown @@ -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 diff --git a/website/source/docs/providers/consul/r/service.html.markdown b/website/source/docs/providers/consul/r/service.html.markdown index e1bc235634..9efe4cb3db 100644 --- a/website/source/docs/providers/consul/r/service.html.markdown +++ b/website/source/docs/providers/consul/r/service.html.markdown @@ -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. From 2f61c89c1011763b86c3c3782cdd06f2e6b59b54 Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Tue, 8 Nov 2016 16:07:43 +0100 Subject: [PATCH 2/3] Fixed weird cnp --- website/source/docs/providers/consul/d/keys.html.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/source/docs/providers/consul/d/keys.html.markdown b/website/source/docs/providers/consul/d/keys.html.markdown index 5172474b6a..8267bc29cc 100644 --- a/website/source/docs/providers/consul/d/keys.html.markdown +++ b/website/source/docs/providers/consul/d/keys.html.markdown @@ -9,8 +9,7 @@ description: |- # consul\_keys 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. +This is a powerful way dynamically set values in templates. ## Example Usage From b0e9a3f39b2d2675a471610c464dba3ed535ae08 Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Tue, 8 Nov 2016 16:08:46 +0100 Subject: [PATCH 3/3] Fixed comma typo --- .../source/docs/providers/consul/r/catalog_entry.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/providers/consul/r/catalog_entry.html.markdown b/website/source/docs/providers/consul/r/catalog_entry.html.markdown index 0ab56c168a..5a994f76df 100644 --- a/website/source/docs/providers/consul/r/catalog_entry.html.markdown +++ b/website/source/docs/providers/consul/r/catalog_entry.html.markdown @@ -34,7 +34,7 @@ The following arguments are supported: * `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