From d29bedeeb9698913340681d782866a9f8383ca81 Mon Sep 17 00:00:00 2001
From: John Keates <john@keates.nl>
Date: Tue, 24 Feb 2015 22:24:26 +0100
Subject: [PATCH] Tiny readme fixup fixup (yes, that's a fixup for a fixup)

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c379dc0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+haproxy
+=======
+---
+
+haproxy
+-------
+
+Install, configure and run haproxy based on:
+
+- haproxy.install
+- haproxy.config
+- haproxy.service
+
+Use the supplied haproxy.cfg for a flat file approach,
+or the jinja template and the pillar for a salt approach.
+
+haproxy.config
+--------------
+
+Currently, only a handful of options can be set using the pillar:
+
+- Global
+  - stats: enable stats, curently only via a unix socket which can be set to a path
+  - user: sets the user haproxy shall run as
+  - group: sets the group haproxy shall run as
+  - chroot: allows you to turn on chroot and set a directory
+  - daemon: allows you to turn daemon mode on and off
+
+- Default
+  - log: set the default log
+  - mode: sets the mode (i.e. http)
+  - retries: sets the number of retries
+  - options: an array of options that is simply looped with no special treatment
+  - timeouts: an array of timeouts that is simply looped with no special treatment
+  - errorfiles: an array of k:v errorfiles to point to the correct file matching an HTTP error code
+
+- Frontend
+  Frontend(s) is a list of the frontends you desire to have in your haproxy setup
+  Per frontend you can set:
+  - name: the name haproxy will use for the frontend
+  - bind: the bind string: this allows you to set the IP, Port and other paramters for the bind
+  - reqadd: an array of reqadd statements. Looped over and put in the configuration, no parsing
+  - default_backend: sets the default backend
+  - acls: a list of acls, not parsed, simply looped and put in to the configuration
+  - use_backends: a list of use_backend statements, looped over, not parsed
+
+- Backend
+  Backend(s) is a list of the backends you desire to have in your haproxy setup
+  Per backend you can set:
+  - name: set the backend name, used in the frontend references by haproxy
+  - balance: set the balance type, string
+  - redirect: if set, can be used to redirect; simply a string, not parsed
+  - servers: a list of servers this backend will contact, is looped over
+    - per server you can set:
+      - name: name of the server for haproxy
+      - host: the host to be contacted
+      - port: the port to contact the server on
+      - check: set to check to enable checking
\ No newline at end of file