saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

More docs updates

Browse source 
Added the same links to returner and renderer docs as I did for grains,
states, and modules last night.
This commit is contained in:
Erik Johnson 2012-12-19 14:35:43 -06:00
parent 5890ca8733
commit 7415755653
2 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/ref/renderers/index.rst
View file

@ -98,12 +98,19 @@ accepts as input and what it returns as output.
Writing Renderers
-----------------
Writing a renderer is easy, all that is required is that a Python module
is placed in the rendered directory and that the module implements the
render function. The render function will be passed the path of the SLS file.
In the render function, parse the passed file and return the data structure
Writing a renderer is easy, all that is required is that a Python module is
placed in the rendered directory and that the module implements the ``render``
function. The ``render`` function will be passed the path of the SLS file. In
the ``render`` function, parse the passed file and return the data structure
derived from the file. You can place your custom renderers in a ``_renderers``
directory in your file root (``/srv/salt/``).
directory within the :conf_master:`file_roots` specified by the master config
file. These custom renderers are distributed when `state.highstate`_ is run, or
by executing the `saltutil.sync_renderers`_ or `saltutil.sync_all`_ functions.
.. _`state.highstate`: https://salt.readthedocs.org/en/latest/ref/modules/all/salt.modules.state.html#salt.modules.state.highstate
.. _`saltutil.sync_renderers`: https://salt.readthedocs.org/en/latest/ref/modules/all/salt.modules.saltutil.html#salt.modules.saltutil.sync_renderers
.. _`saltutil.sync_all`: https://salt.readthedocs.org/en/latest/ref/modules/all/salt.modules.saltutil.html#salt.modules.saltutil.sync_all
Examples
--------

10
doc/ref/returners/index.rst
View file

@ -72,6 +72,16 @@ A simple returner is implemented here:
This simple example of a returner set to send the data to a redis server
serializes the data as json and sets it in redis.
You can place your custom returners in a ``_returners`` directory within the
:conf_master:`file_roots` specified by the master config file. These custom
returners are distributed when `state.highstate`_ is run, or by executing the
`saltutil.sync_returners`_ or `saltutil.sync_all`_ functions.
.. _`state.highstate`: https://salt.readthedocs.org/en/latest/ref/modules/all/salt.modules.state.html#salt.modules.state.highstate
.. _`saltutil.sync_returners`: https://salt.readthedocs.org/en/latest/ref/modules/all/salt.modules.saltutil.html#salt.modules.saltutil.sync_returners
.. _`saltutil.sync_all`: https://salt.readthedocs.org/en/latest/ref/modules/all/salt.modules.saltutil.html#salt.modules.saltutil.sync_all
Examples
--------