1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
|
.. _guide:
User Guide
==========
This part of the documentation covers step-by-step instructions for getting
the most out of **haproxyadmin**. It begins by introducing operations related
to HAProxy process and then focus on providing the most frequent operations
for frontends, backends and servers. In all examples HAProxy is configured
with 4 processes, see example `HAProxy configuration`_.
A :class:`HAProxy <.HAProxy>` object with the name ``hap`` needs to be created
prior running the code mentioned in the following sections:
.. code:: python
>>> from haproxyadmin import haproxy
>>> hap = haproxy.HAProxy(socket_dir='/run/haproxy')
.. warning:: Make sure you have appropriate privillage to write in the socket files.
.. toctree::
:maxdepth: 2
haproxy
frontend
backend
server
.. _HAProxy configuration: https://raw.githubusercontent.com/unixsurfer/haproxyadmin/master/tools/haproxy.cfg
|