0
0
mirror of https://github.com/saltstack-formulas/sysctl-formula.git synced 2024-11-27 23:07:54 +01:00
sysctl-formula/README.rst
Wolodja Wentland cb2822f0f4 Switch to cleaner pillar structure
This commit allows users to specify sysctl parameters in an easier
format than the one that was used before. It moves settings out of the
'lookup' pillar namespace in a backward compatible manner and is
modelled after the old 'params2' approach.

It also introduces a simplified scheme, in which parameters can be
specified as key-value pairs, which makes for cleaner pillars if there
is no need to specify a custom configuration file.
2016-04-26 16:37:07 +02:00

38 lines
993 B
ReStructuredText

==============
sysctl-formula
==============
This formula ensures that a sysctl parameter is present on the system
based on configuration in pillars.
Values are written to ``/etc/sysctl.d/99-salt.conf`` or ``/etc/sysctl.conf`` for
systemd or sysvinit systems respectively. This can be overriden by explicitly
passing the ``config`` parameter.
.. 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:
``sysctl``
----------
Meta-state that includes both the ``sysctl.package`` and ``sysctl.param`` states.
``sysctl.package``
------------------
Ensures that the ``sysctl`` program is available.
``sysctl.param``
----------------
Sets sysctl values from configuration in pillars data using
`sysctl.present <https://docs.saltstack.com/en/latest/ref/states/all/salt.states.sysctl.html#salt.states.sysctl.present>`_.