Added several Orchestrate cross-references and details

This commit is contained in:
Seth House 2014-11-14 12:47:11 -05:00
parent c31bcb3fac
commit 2364ba2e20
2 changed files with 38 additions and 19 deletions

View File

@ -79,6 +79,11 @@ def orchestrate(mods, saltenv='base', test=None, exclude=None, pillar=None):
Execute a state run from the master, used as a powerful orchestration
system.
.. seealso:: More Orchestrate documentation
* :ref:`Full Orchestrate Tutorial <orchestrate-tutorial>`
* :py:mod:`Docs for the master-side state module <salt.states.saltmod>`
CLI Examples:
.. code-block:: bash

View File

@ -3,27 +3,14 @@
Control the Salt command interface
==================================
The Salt state is used to control the salt command interface. This state is
intended for use primarily from the state runner from the master.
This state is intended for use from the Salt Master. It provides access to
sending commands down to minions as well as access to executing master-side
modules. These state functions wrap Salt's :ref:`Python API <python-api>`.
The salt.state declaration can call out a highstate or a list of sls:
.. seealso:: More Orchestrate documentation
.. code-block:: yaml
webservers:
salt.state:
- tgt: 'web*'
- sls:
- apache
- django
- core
- saltenv: prod
databases:
salt.state:
- tgt: role:database
- tgt_type: grain
- highstate: True
* :ref:`Full Orchestrate Tutorial <orchestrate-tutorial>`
* :py:func:`The Orchestrate runner <salt.runners.state.orchestrate>`
'''
# Import python libs
@ -127,6 +114,33 @@ def state(
WARNING: This flag is potentially dangerous. It is designed
for use when multiple state runs can safely be run at the same
Do not use this flag for performance optimization.
Examples:
Run a list of sls files via :py:func:`state.sls <salt.state.sls>` on target
minions:
.. code-block:: yaml
webservers:
salt.state:
- tgt: 'web*'
- sls:
- apache
- django
- core
- saltenv: prod
Run a full :py:func:`state.highstate <salt.state.highstate>` on target
mininons.
.. code-block:: yaml
databases:
salt.state:
- tgt: role:database
- tgt_type: grain
- highstate: True
'''
cmd_kw = {'arg': [], 'kwarg': {}, 'ret': ret, 'timeout': timeout}