Current File : //lib/python2.7/site-packages/salt/runners/state.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l m Z e j
e � Z d d d � Z e j j j e d � Z d d � Z e j j j e d � Z d d � Z d
d d d d d d d � Z e j j j e d � Z e j j j e d
� Z d e d d � Z d e d d � Z d
d e d d d d � Z e j j j e d � Z d d e d e d d � Z! d S( u!
Execute orchestration functions
i ( t absolute_importt print_functiont unicode_literalsN( t SaltInvocationErrorc C@ s- t j j t � } | j d | | | � d S( u�
Set up a state id pause, this instructs a running state to pause at a given
state id. This needs to pass in the jid of the running state and can
optionally pass in a duration in seconds.
u state.pauseN( t saltt miniont MasterMiniont __opts__t functions( t jidt state_idt durationR ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt pause s u set_pausec C@ s* t j j t � } | j d | | � d S( u<
Remove a pause from a jid, allowing it to continue
u state.resumeN( R R R R R ( R R
R ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt resume s u rm_pausec C@ s* t j j t � } | j d | | � d S( uA
Set up a state run to die before executing the given state id,
this instructs a running state to safely exit at a given
state id. This needs to pass in the jid of the running state.
If a state_id is not passed then the jid referenced will be safely exited
at the beginning of the next state run.
u state.soft_killN( R R R R R ( R R
R ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt soft_kill+ s u basec C@ sI | d k r+ t | t � r+ t d � � n d t d <t j j t � } | d k rl d t k rl t d } n | d k r� d t k r� t d } n | d k r� t j j j
t � } n | j d | | | d | d | d | d
| d | d | �} i i | | j d
6d 6d d 6}
t
d |
d � } | r;d |
d <n
d |
d <|
S( u}
.. versionadded:: 0.17.0
Execute a state run from the master, used as a powerful orchestration
system.
.. seealso:: More Orchestrate documentation
* :ref:`Full Orchestrate Tutorial <orchestrate-runner>`
* :py:mod:`Docs for the master-side state module <salt.states.saltmod>`
CLI Examples:
.. code-block:: bash
salt-run state.orchestrate webserver
salt-run state.orchestrate webserver saltenv=dev test=True
salt-run state.orchestrate webserver saltenv=dev pillarenv=aws
.. versionchanged:: 2014.1.1
Runner renamed from ``state.sls`` to ``state.orchestrate``
.. versionchanged:: 2014.7.0
Runner uses the pillar variable
.. versionchanged:: develop
Runner uses the pillar_enc variable that allows renderers to render the pillar.
This is usable when supplying the contents of a file as pillar, and the file contains
gpg-encrypted entries.
.. seealso:: GPG renderer documentation
CLI Examples:
.. code-block:: bash
salt-run state.orchestrate webserver pillar_enc=gpg pillar="$(cat somefile.json)"
u- Pillar data must be formatted as a dictionaryu localu file_clientu pillarenvu saltenvu state.slst pillart saltenvt pillarenvt
pillar_enct __pub_jidt orchestration_jidu idu datau highstateu outputteru state.check_resulti u retcodei N( t Nonet
isinstancet dictR R R R R t utilsR t gen_jidR t optst __utils__( t modsR t testt excludeR R R R R t runningt rett res( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt orchestrate7 s6 2
"
u orchu slsc K@ s� | d
k r+ t | t � r+ t d � � n d t d <t j j t � } | j d | | d d
d t d | | �} i | | j
d 6} t j i | d 6d
d 6d � | S( u�
Execute a single state orchestration routine
.. versionadded:: 2015.5.0
CLI Example:
.. code-block:: bash
salt-run state.orchestrate_single fun=salt.wheel name=key.list_all
u- Pillar data must be formatted as a dictionaryu localu file_clientu state.singleR t queueR u idu datau highstateu outputteru progressN(
R R R R R R R R R t FalseR t
__jid_event__t
fire_event( t funt nameR R# R t kwargsR R R ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt orchestrate_single� s
c
K@ s� | d
k r+ t | t � r+ t d � � n d t d <t j j t � } | j d | d d
d t d | | �} i | | j
d 6} t j i | d 6d
d 6d � | S( u�
Execute a single state orchestration routine
.. versionadded:: 2015.5.0
CLI Example:
.. code-block:: bash
salt-run state.orchestrate_high '{
stage_one:
{salt.state: [{tgt: "db*"}, {sls: postgres_setup}]},
stage_two:
{salt.state: [{tgt: "web*"}, {sls: apache_setup}, {
require: [{salt: stage_one}],
}]},
}'
u- Pillar data must be formatted as a dictionaryu localu file_clientu
state.highR R# R u idu datau highstateu outputteru progressN(
R R R R R R R R R R$ R R% R& ( t dataR R# R R) R R R ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt orchestrate_high� s
c
C@ s� | d
k r+ t | t � r+ t d � � n d t d <t j j t � } | j d | | | d | d | d | d | �} i | | j d 6} | S( u�
Display the state data from a specific sls, or list of sls files, after
being render using the master minion.
Note, the master minion adds a "_master" suffix to it's minion id.
.. seealso:: The state.show_sls module function
CLI Example:
.. code-block:: bash
salt-run state.orch_show_sls my-orch-formula.my-orch-state 'pillar={ nodegroup: ng1 }'
u- Pillar data must be formatted as a dictionaryu localu file_clientu state.show_slsR R R R u idN(
R R R R R R R R R R (
R R R R# R R R R R R ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt orchestrate_show_sls� s
u
orch_show_slsu *i����u masterc
C@ sG t j j t d d � } | d d | d | d | d | d | d | � S(
uS
Watch Salt's event bus and block until the given tag is matched
.. versionadded:: 2014.7.0
.. versionchanged:: 2019.2.0
``tagmatch`` can now be either a glob or regular expression.
This is useful for utilizing Salt's event bus from shell scripts or for
taking simple actions directly from the CLI.
Enable debug logging to see ignored events.
:param tagmatch: the event is written to stdout for each tag that matches
this glob or regular expression.
:param count: this number is decremented for each event that matches the
``tagmatch`` parameter; pass ``-1`` to listen forever.
:param quiet: do not print to stdout; just block
:param sock_dir: path to the Salt master's event socket file.
:param pretty: Output the JSON all on a single line if ``False`` (useful
for shell tools); pretty-print the JSON output if ``True``.
:param node: Watch the minion-side or master-side event bus.
.. versionadded:: 2016.3.0
CLI Examples:
.. code-block:: bash
# Reboot a minion and run highstate when it comes back online
salt 'jerry' system.reboot && \\
salt-run state.event 'salt/minion/jerry/start' count=1 quiet=True && \\
salt 'jerry' state.highstate
# Reboot multiple minions and run highstate when all are back online
salt -L 'kevin,stewart,dave' system.reboot && \\
salt-run state.event 'salt/minion/*/start' count=3 quiet=True && \\
salt -L 'kevin,stewart,dave' state.highstate
# Watch the event bus forever in a shell while-loop.
salt-run state.event | while read -r tag data; do
echo $tag
echo $data | jq --color-output .
done
.. seealso::
See :blob:`tests/eventlisten.sh` for an example of usage within a shell
script.
u stateu state.eventt tagmatcht countt quiett sock_dirt prettyt nodeN( R t loadert raw_modR R ( R. R/ R0 R1 R2 R3 t statemod( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt event� s 6
(" t __doc__t
__future__R R R t loggingt salt.loaderR t salt.utils.eventt salt.utils.functoolst salt.utils.jidt salt.exceptionsR t getLoggert __name__t LOGGERR R R t functoolst alias_functiont set_pauseR
t rm_pauseR R" t orcht slsR$ R* R, R- t
orch_show_slsR7 ( ( ( s6 /usr/lib/python2.7/site-packages/salt/runners/state.pyt <module> sJ
M % !
Mini Shell