Browse Source

docs(readme): update readme

tags/v0.2.1
Nicolas Rodriguez 5 years ago
parent
commit
0193e228ea
1 changed files with 4 additions and 4 deletions
  1. +4
    -4
      docs/README.rst

+ 4
- 4
docs/README.rst View File

Please see :ref:`How to contribute <CONTRIBUTING>` for more details. Please see :ref:`How to contribute <CONTRIBUTING>` for more details.


Available states Available states
================
----------------


.. contents:: .. contents::
:local: :local:


``syslog_ng`` ``syslog_ng``
-------------
^^^^^^^^^^^^^
Installs and configures the syslog_ng package. Installs and configures the syslog_ng package.


``syslog_ng.packages`` ``syslog_ng.packages``
----------------------
^^^^^^^^^^^^^^^^^^^^^^
Installs the syslog_ng package and optional packages which may provide additional functionalities. Installs the syslog_ng package and optional packages which may provide additional functionalities.


``syslog_ng.config`` ``syslog_ng.config``
--------------------
^^^^^^^^^^^^^^^^^^^^
This state manages the file ``syslog_ng.conf`` under ``/etc/syslog-ng`` (template found in "syslog_ng/files"). The configuration is populated by values in "syslog_ng/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar. This state manages the file ``syslog_ng.conf`` under ``/etc/syslog-ng`` (template found in "syslog_ng/files"). The configuration is populated by values in "syslog_ng/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.


Testing Testing

Loading…
Cancel
Save