Improve description of consul_catalog_entry (#12162)

The other resources for this provider are similarly misleading (they read like data sources).

Also adding undocumented properties of the resource.
This commit is contained in:
Brian Lalor 2017-03-07 07:49:39 -05:00 committed by Paul Stack
parent d2f728e6cd
commit 0b868099b0
1 changed files with 8 additions and 3 deletions

View File

@ -3,13 +3,13 @@ layout: "consul"
page_title: "Consul: consul_catalog_entry"
sidebar_current: "docs-consul-resource-catalog-entry"
description: |-
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.
Registers a node or service with the Consul Catalog. Currently, defining health checks is not supported.
---
# 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.
Registers a node or service with the [Consul Catalog](https://www.consul.io/docs/agent/http/catalog.html#catalog_register).
Currently, defining health checks is not supported.
## Example Usage
@ -41,6 +41,11 @@ The following arguments are supported:
* `service` - (Optional) A service to optionally associated with
the node. Supported values are documented below.
* `datacenter` - (Optional) The datacenter to use. This overrides the
datacenter in the provider setup and the agent's default datacenter.
* `token` - (Optional) ACL token.
The `service` block supports the following:
* `address` - (Optional) The address of the service. Defaults to the