Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
H
haproxy-formula
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
salt
haproxy-formula
Commits
870474e5
Unverified
Commit
870474e5
authored
5 years ago
by
Imran Iqbal
Browse files
Options
Downloads
Patches
Plain Diff
docs(readme): merge with original `README`
parent
98076d3b
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.rst
+0
-82
0 additions, 82 deletions
README.rst
docs/README.rst
+49
-4
49 additions, 4 deletions
docs/README.rst
with
49 additions
and
86 deletions
README.rst
deleted
100644 → 0
+
0
−
82
View file @
98076d3b
=======
haproxy
=======
Install, configure and run ``haproxy``.
.. note::
See the full `Salt Formulas installation and usage instructions
<http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
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``
-----------
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:
- Global
+ stats: enable stats, currently only via a unix socket which can be set to a path with custom permissions and optional extra bind arguments
+ 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
+ redirect: add a redirect line, an unparsed string like in the backend
+ 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
+ blocks: a list of block statements, 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
- For global, default, frontend, listener, backend and server it is possible to use the "extra" option for more rare settings not mentioned above.
``haproxy.service``
-------------------
Make sure ``haproxy`` service is running.
This diff is collapsed.
Click to expand it.
docs/README.rst
+
49
−
4
View file @
870474e5
.. _readme:
haproxy-formula
===============
=
===============
|img_travis| |img_sr|
...
...
@@ -14,8 +14,7 @@ haproxy-formula
:scale: 100%
:target: https://github.com/semantic-release/semantic-release
A SaltStack formula that is empty. It has dummy content to help with a quick
start on a new formula and it serves as a style guide.
Install, configure and run ``haproxy``.
.. contents:: **Table of Contents**
:depth: 1
...
...
@@ -46,7 +45,8 @@ Please see `How to contribute <https://github.com/saltstack-formulas/.github/blo
Special notes
-------------
None
Use the supplied haproxy.cfg for a flat file approach,
or the jinja template and the pillar for a salt approach.
Available states
----------------
...
...
@@ -74,6 +74,51 @@ This state will install the haproxy package only.
This state will configure the haproxy service and has a dependency on ``haproxy.install``
via include list.
Currently, only a handful of options can be set using the pillar:
- Global
+ stats: enable stats, currently only via a unix socket which can be set to a path with custom permissions and optional extra bind arguments
+ 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
+ redirect: add a redirect line, an unparsed string like in the backend
+ 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
+ blocks: a list of block statements, 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
- For global, default, frontend, listener, backend and server it is possible to use the "extra" option for more rare settings not mentioned above.
``haproxy.service``
^^^^^^^^^^^^^^^^^^^^
...
...
This diff is collapsed.
Click to expand it.
Dennis Ahrens
@ahrensde
mentioned in commit
dfce6574
·
5 years ago
mentioned in commit
dfce6574
mentioned in commit dfce657454a286a20bdbb289b965597172c0fc98
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment