diff --git a/README.rst b/README.rst index cc2eb48..353bd74 100644 --- a/README.rst +++ b/README.rst @@ -1,20 +1,35 @@ +======= haproxy ======= -haproxy -------- +Install, configure and run ``haproxy``. -Install, configure and run haproxy based on: +.. note:: -- haproxy.install -- haproxy.config -- haproxy.service + See the full `Salt Formulas installation and usage instructions + `_. + +Available states +================ + +.. contents:: + :local: Use the supplied haproxy.cfg for a flat file approach, or the jinja template and the pillar for a salt approach. -haproxy.config --------------- +``haproxy`` +----------- + +Install, configure and run ``haproxy`` service. + +``haproxy.install`` +------------------- + +Install ``haproxy`` from packages. + +``haproxy.config`` +------------------ Currently, only a handful of options can be set using the pillar: @@ -55,4 +70,10 @@ Currently, only a handful of options can be set using the pillar: + 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 + + check: set to check to enable checking + + +``haproxy.service`` +------------------- + +Make sure ``haproxy`` service is running.