Skip to content

Commit

Permalink
docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
brianshumate committed Oct 22, 2016
1 parent c02256e commit db4fff4
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 15 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,3 +168,7 @@

- Update supported versions
- Fix up unarchive task quoting

## v1.2.12

- Update documentation
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Consul

![](https://travis-ci.org/brianshumate/ansible-consul.svg?branch=master)
[![Build Status](https://travis-ci.org/brianshumate/ansible-consul.svg?branch=master)](https://travis-ci.org/brianshumate/ansible-consul)
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-brianshumate.nomad-blue.svg)](https://galaxy.ansible.com/brianshumate/docker/)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/brianshumate/ansible-consul.svg)](http://isitmaintained.com/project/brianshumate/ansible-consul "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/brianshumate/ansible-consul.svg)](http://isitmaintained.com/project/brianshumate/ansible-consul "Percentage of issues still open")

This Ansible role performs a basic [Consul](https://consul.io/) installation,
including filesystem structure, example configuration, and Consul UI
installation.
This Ansible role performs basic [Consul](https://consul.io/) installation,
including filesystem structure, and example configuration.

It can also bootstrap a minimal development or evaluation cluster of 3 server
agents running in a Vagrant and VirtualBox based environment. See
Expand Down Expand Up @@ -52,8 +54,11 @@ The role specifies variables in `defaults/main.yml` and `vars/*.yml`.

### OS Distribution Variables

The Consul binary works on most Linux platforms and is not distribution
specific. Some distributions require installation of specific OS packages with different nomenclature, so this role has support for major Linux distributions.
The `consul` binary works on most Linux platforms and is not distribution
specific. However, some distributions require installation of specific OS
packages with different naming, so this role was built with support for
popular Linux distributions and defines these variables to deal with the
differences acros distros:

| Name | Default Value | Description |
| -------------- | ------------- | -----------------------------------|
Expand All @@ -76,14 +81,13 @@ specific. Some distributions require installation of specific OS packages with d

## Dependencies

None
Ansible requires GNU tar and this role performs some local use of the
unarchive module, so ensure that your system has `gtar` installed.

## Example Playbook


After you have reviewed and altered any necessary variables, and created a
host inventory file, basic Consul installation is possible using the
included `site.yml` playbook example:
Basic nomad installation is possible using the included `site.yml` playbook:

```
ansible-playbook -i hosts site.yml
Expand All @@ -102,7 +106,7 @@ Be aware that for clustering, the included `site.yml` does the following:
2. Reconfigures bootstrap node to run without bootstrap-expect setting
3. Restarts bootstrap node

### NEW
### DNSMasq Support

The role now includes support for DNS forwarding with dnsmasq.

Expand Down Expand Up @@ -134,7 +138,7 @@ consul3.node.consul. 0 IN A 10.1.42.230
;; Query time: 42 msec
;; SERVER: 10.1.42.210#53(10.1.42.210)
;; WHEN: Sun Aug 7 18:06:32 2016
;;
;;
```

### Vagrant and VirtualBox
Expand All @@ -152,5 +156,5 @@ BSD

## Contributors

Special thanks to the folks listed in [CONTRIBUTORS.md](https://github.com/brianshumate/ansible-consul/blob/master/CONTRIBUTORS.md) for their
Special thanks to the folks listed in [CONTRIBUTORS.md](https://github.com/brianshumate/ansible-consul/blob/master/CONTRIBUTORS.md) for their
contributions to this project.
5 changes: 3 additions & 2 deletions examples/README_VAGRANT.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ ansible-galaxy install brianshumate.consul

You'll want to make sure you have write access to `/etc/ansible/roles/` since
that is where the role will be installed by default, or define your own
Ansible role path by creating a `$HOME/.ansible.cfg` file with these contents:
Ansible role path by creating a `$HOME/.ansible.cfg` or even `./anisible.cfg`
file with these contents:

```
[defaults]
Expand Down Expand Up @@ -83,7 +84,7 @@ steps to get up and running:
consul3 10.1.42.230:8300 10.1.42.230:8300 leader true
```

By default, this project will install Debian based cluster nodes. If you
By default, this project will install Debian 8 based cluster nodes. If you
prefer, it can also install CentOS 7 based nodes by changing the command
in step 4 to the following:

Expand Down

0 comments on commit db4fff4

Please sign in to comment.