Updated README to conform to standard
This commit is contained in:
parent
7e671303cb
commit
e44d9e11e7
56
README.rst
56
README.rst
@ -2,23 +2,53 @@ munin
|
|||||||
=====
|
=====
|
||||||
``munin`` is a monioring application with a master/node architecture. The master periodically connects to each node and collects information from it. The nodes each run a ``munin-node`` service that listens for these connections.
|
``munin`` is a monioring application with a master/node architecture. The master periodically connects to each node and collects information from it. The nodes each run a ``munin-node`` service that listens for these connections.
|
||||||
|
|
||||||
States
|
.. note::
|
||||||
======
|
|
||||||
``munin.master``
|
|
||||||
Installs the munin master package. The master runs as a cronjob, not a service. The distro packages normally automatically create those.
|
|
||||||
``munin.master.config`` (includes ``munin.master``)
|
|
||||||
Generates a config file for the munin master based on pillar data.
|
|
||||||
``munin.node``
|
|
||||||
Installs the munin node package and enables the node service.
|
|
||||||
``munin.node.config`` (includes ``munin.node``)
|
|
||||||
Generates a config file for the munin node based on pillar data.
|
|
||||||
``munin.tls``
|
|
||||||
Installs the Perl package Net::SSLEay so munin can use TLS.
|
|
||||||
|
|
||||||
Also, if the private key, certificate, or CA certificate are specified (as in ``pillar.example``), then the appropriate files are created. Note that it is up to the user to correctly specify the location of these files in their master and node config files.
|
See the full `Salt Formulas installation and usage instructions
|
||||||
|
<http://docs.saltstack.com/topics/conventions/formulas.html>`_.
|
||||||
|
|
||||||
|
Available states
|
||||||
|
================
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
|
||||||
|
``munin.master``
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Installs the munin master package.
|
||||||
|
|
||||||
|
The master runs as a cronjob, not a service. The distro packages normally automatically create those.
|
||||||
|
|
||||||
|
``munin.master.config``
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Includes ``munin.master``.
|
||||||
|
|
||||||
|
Generates a config file for the munin master based on pillar data.
|
||||||
|
|
||||||
|
``munin.node``
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Installs the munin node package and enables the node service.
|
||||||
|
|
||||||
|
``munin.node.config``
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Includes ``munin.node``.
|
||||||
|
|
||||||
|
Generates a config file for the munin node based on pillar data.
|
||||||
|
|
||||||
|
``munin.tls``
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Installs the Perl package Net::SSLEay so munin can use TLS.
|
||||||
|
|
||||||
|
Also, if the private key, certificate, or CA certificate are specified (as in ``pillar.example``), then the appropriate files are created. Note that it is up to the user to correctly specify the location of these files in their master and node config files.
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
|
|
||||||
The ``pillar.example`` has example pillar data for both the master and node, though ``munin.master.config`` only uses data from ``munin_master`` and ``munin.node.config`` only uses data from ``munin_node``.
|
The ``pillar.example`` has example pillar data for both the master and node, though ``munin.master.config`` only uses data from ``munin_master`` and ``munin.node.config`` only uses data from ``munin_node``.
|
||||||
|
|
||||||
Master Config
|
Master Config
|
||||||
|
Loading…
Reference in New Issue
Block a user