Skip to content

Commit 0652b3b

Browse files
committed
Clarify README
1 parent e169da4 commit 0652b3b

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,38 @@
11
haproxy
22
========
33

4-
Will install haproxy and configure it.
4+
Installs and configures [HAProxy 1.5](http://www.haproxy.org/).
55

6-
Requirements
7-
------------
6+
Features
7+
--------
88

9-
Only tested on CentOS, Ubuntu and SmartOS for now.
10-
Some features are only possible with haproxy 1.5 (like the compresion flags).
11-
This role will install the public repository to install haproxy 1.5 on ubuntu. Or it will install the EPEL repository on CentOS.
9+
* Supports CentOS, Debian, Ubuntu, and SmartOS.
10+
* Installs HAProxy 1.5 from official repositories on Debian, Ubuntu, and SmartOS.
11+
* Installs EPEL repository on CentOS.
1212

1313
Role Variables
1414
--------------
1515

16-
There is a main dictionary that needs to be set named `haproxy`.
17-
This dictionary has 4 main sections :
18-
- global
19-
- defaults
20-
- frontends
21-
- backends
16+
* `haproxy_global`
2217

23-
Each section has the most used parameters that I can think of. This role does not have (yet) full coverage of the main haproxy project. Feel free to submit a pull request if something is missing for you.
18+
Global HAProxy settings.
19+
* `haproxy_defaults`
2420

25-
Example Playbook
26-
-------------------------
21+
Default settings for frontends, backends, and listen proxies.
22+
* `haproxy_backends`
2723

28-
I *highly* suggest that you use a seperate variable file for this role (using the `vars_files` directive), but you can use it in the main playbook if you insist:
24+
A list of HAProxy backends.
25+
* `haproxy_frontends`
26+
27+
A list of HAProxy frontends.
28+
* `haproxy_listen`
29+
30+
A list of listen proxies.
31+
32+
See [`vars/main.yml`](vars/main.yml) for a complete list of configurable .
33+
34+
Example
35+
-------
2936

3037
```yaml
3138
- hosts: loadbalancers
@@ -45,9 +52,6 @@ I *highly* suggest that you use a seperate variable file for this role (using th
4552
ip: '192.168.1.100'
4653
```
4754
48-
See [the full example](https://github.com/Pheromone/ansible-haproxy/blob/master/vars/main.yml) to see all options.
49-
50-
5155
License
5256
-------
5357

0 commit comments

Comments
 (0)