Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
brianshumate committed Nov 1, 2016
1 parent f7ee9db commit f0e2071
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,7 @@
- Update/validate CentOS 7 box
- Update documentation
- Updated failure cases for CentOS

## v1.3.4

- Update documentation
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ software and versions:

## Role Variables

The role defines variables in `defaults/main.yml`:
The role defines variables in `defaults/main.yml` and in the hosts
inventory file (see below):

| Name | Default Value | Description |
| -------------- | ------------- | -----------------------------------|
Expand Down Expand Up @@ -64,6 +65,26 @@ The role defines variables in `defaults/main.yml`:
| `consul_atlas_infrastructure` | Environment variable | Atlas infrastructure name |
| `consul_atlas_token` | environment variable | Atlas token |

### Host Inventory Variable

This role also uses a host inventory variable to define the server's role
when forming a cluster. One server should be designated as the bootstrap
server that uses the `bootstrap_expect` configuration directive, and the other
servers will connect to this server.

| Name | Default Value | Description |
| -------------- | ------------- | -----------------------------------|
| `consul_node_role` | NONE | Consul server role, one of: *bootstrap*, *server*, or *client* |

Here is an example of how the hosts inventory could be defined for a simple
cluster of 3 servers:

```
consul1.local consul_node_role=bootstrap
consul2.local consul_node_role=server
consul3.local consul_node_role=server
```

### OS Distribution Variables

The `consul` binary works on most Linux platforms and is not distribution
Expand Down
2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.3.3
v1.3.4

0 comments on commit f0e2071

Please sign in to comment.