#2087 add docs for consul_node and consul_service

This commit is contained in:
Max Englander 2016-03-27 04:12:38 +00:00
parent 296f8be10a
commit 4fe7db9441
2 changed files with 84 additions and 0 deletions

View File

@ -0,0 +1,37 @@
---
layout: "consul"
page_title: "Consul: consul_node"
sidebar_current: "docs-consul-resource-node"
description: |-
Provides access to Node data in Consul. This can be used to define a node.
---
# consul\_node
Provides access to Node data in Consul. This can be used to define a node. Currently, defining health checks is not supported.
## Example Usage
```
resource "consul_node" "foobar" {
address = "192.168.10.10"
name = "foobar"
}
```
## Argument Reference
The following arguments are supported:
* `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
referenced in the catalog.
## Attributes Reference
The following attributes are exported:
* `address` - The address of the service.
* `name` - The name of the service.

View File

@ -0,0 +1,47 @@
---
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.
---
# consul\_service
A high-level resource for creating a Service in Consul. Currently, defining health checks for a service is not supported.
## Example Usage
```
resource "consul_service" "google" {
address = "www.google.com"
name = "google"
port = 80
tags = ["tag0", "tag1"]
}
```
## Argument Reference
The following arguments are supported:
* `address` - (Optional) The address of the service. Defaults to the
address of the agent.
* `name` - (Required) The name of the service.
* `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.
* `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.