Current File : //lib/python2.7/site-packages/salt/modules/event.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
Z d d l Z d d l
Z d d l Z d d l Z d d l m Z d g Z e j e � Z d � Z d d � Z d � Z d d e e e e d � Z d S(
uh
Use the :ref:`Salt Event System <events>` to fire events from the
master to the minion and vice-versa.
i ( t absolute_importt print_functiont unicode_literalsN( t sixu *c C@ s> t g t j | � D]$ \ } } | | k r | | f ^ q � S( uQ
Return a dictionary of only the subset of keys/values specified in keys
( t dictR t iteritems( t keyst master_dictt kt v( ( s6 /usr/lib/python2.7/site-packages/salt/modules/event.pyt _dict_subset s c
C@ s t j d d � s* t j d d � d k rQ t j d t � rQ t j d | � t St d d k r� t j j j j
t � } i t d d 6| d 6| d 6d
d 6} z) y | j | � Wn t k
r� n XWd | j
� Xt S| s� t j d
� d k rmd t k r?d j d t j j j t d � d t j d d � � t d <n t � } t } d t k rx3 t d D] } | j | � qeWn | j t d � t j j t � } i t d d 6| d 6| d 6| j d � d 6d
d 6} t | t � r�| j | � n xo | D]g } t j j j j
t d | �} z5 y | j | � t } Wn t k
rUt } n XWd | j
� Xq�W| SyE t j j j t d t �j i | d 6| d 6d d 6d d 6d � SWnI t k
r�t j � \ }
} } t j! |
| | � }
t j" |
� t SXd S( u�
Fire an event off up to the master server
CLI Example:
.. code-block:: bash
salt '*' event.fire_master '{"data":"my event data"}' 'tag'
u localu file_clientu use_master_when_localu8 Local mode detected. Event with tag %s will NOT be sent.u transportu raetu idu tagu datau
_minion_eventu cmdNu __cliu salt-callu
master_uriu tcp://{ip}:{port}t ipu interfacet portu ret_portu 4506u master_uri_listt saltu tokt
master_urit listenu eventsu pretagu fire_master(# t __opts__t gett Nonet Falset logt warningR
t transportt clientt
ReqChannelt factoryt sendt Exceptiont closet Truet formatt utilst zeromqt
ip_brackett listt appendt cryptt SAutht gen_tokent
isinstanceR t updatet eventt MinionEventt
fire_eventt syst exc_infot tracebackt format_exceptiont debug( t datat tagt preloadt channelt loadt masterst retR t autht mastert exc_typet exc_valuet
exc_tracebackt lines( ( s6 /usr/lib/python2.7/site-packages/salt/modules/event.pyt fire_master" sj
=
*
c
C@ s� yI t j j j d d t d d t d d t d t �} | j | | � SWnI t k
r� t j � \ } } } t
j | | | � } t j
| � t SXd S( u�
Fire an event on the local minion event bus. Data must be formed as a dict.
CLI Example:
.. code-block:: bash
salt '*' event.fire '{"data":"my event data"}' 'tag'
u miniont sock_diru sock_dirR u transportt optsR N( R
R R) t get_eventR R R+ R R, R- R. R/ R R0 ( R1 R2 R) R: R; R< R= ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/event.pyt firep s
c K@ s� i } | rP t | t � r: t | t t j � � | d <qP t t j � | d <n | r� t | t � r{ t | t � | d <q� t | d <n | r� t | t � r� t | t � | d <q� t | d <n | r� t j d d � | d <t j d � | d <n | r| j
| � n t | t j � r*| j
| � n t j d � sct j d � d k sct j d � d
k rpt
| | � St | | d | �Sd S(
u�
Send an event to the Salt Master
.. versionadded:: 2014.7.0
:param tag: A tag to give the event.
Use slashes to create a namespace for related events. E.g.,
``myco/build/buildserver1/start``, ``myco/build/buildserver1/success``,
``myco/build/buildserver1/failure``.
:param data: A dictionary of data to send in the event.
This is free-form. Send any data points that are needed for whoever is
consuming the event. Arguments on the CLI are interpreted as YAML so
complex data structures are possible.
:param with_env: Include environment variables from the current shell
environment in the event data as ``environ``.. This is a short-hand for
working with systems that seed the environment with relevant data such
as Jenkins.
:type with_env: Specify ``True`` to include all environment variables, or
specify a list of strings of variable names to include.
:param with_grains: Include grains from the current minion in the event
data as ``grains``.
:type with_grains: Specify ``True`` to include all grains, or specify a
list of strings of grain names to include.
:param with_pillar: Include Pillar values from the current minion in the
event data as ``pillar``. Remember Pillar data is often sensitive data
so be careful. This is useful for passing ephemeral Pillar values
through an event. Such as passing the ``pillar={}`` kwarg in
:py:func:`state.sls <salt.modules.state.sls>` from the Master, through
an event on the Minion, then back to the Master.
:type with_pillar: Specify ``True`` to include all Pillar values, or
specify a list of strings of Pillar keys to include. It is a
best-practice to only specify a relevant subset of Pillar data.
:param with_env_opts: Include ``saltenv`` and ``pillarenv`` set on minion
at the moment when event is send into event data.
:type with_env_opts: Specify ``True`` to include ``saltenv`` and
``pillarenv`` values or ``False`` to omit them.
:param kwargs: Any additional keyword arguments passed to this function
will be interpreted as key-value pairs and included in the event data.
This provides a convenient alternative to YAML for simple values.
CLI Example:
.. code-block:: bash
salt-call event.send myco/mytag foo=Foo bar=Bar
salt-call event.send 'myco/mytag' '{foo: Foo, bar: Bar}'
A convenient way to allow Jenkins to execute ``salt-call`` is via sudo. The
following rule in sudoers will allow the ``jenkins`` user to run only the
following command.
``/etc/sudoers`` (allow preserving the environment):
.. code-block:: text
jenkins ALL=(ALL) NOPASSWD:SETENV: /usr/bin/salt-call event.send*
Call Jenkins via sudo (preserve the environment):
.. code-block:: bash
sudo -E salt-call event.send myco/jenkins/build/success with_env=[BUILD_ID, BUILD_URL, GIT_BRANCH, GIT_COMMIT]
u environu grainsu pillaru saltenvu baseu pillarenvu localu file_clientu master_typeu disableR3 N( R' R" R
R t ost environt
__grains__t
__pillar__R R R( t collectionst MappingRB R> ( R2 R1 R3 t with_envt with_grainst with_pillart
with_env_optst kwargst data_dict( ( s6 /usr/lib/python2.7/site-packages/salt/modules/event.pyR � s. N
9
( t __doc__t
__future__R R R RG t loggingRC R, R. t
salt.cryptR
t salt.utils.eventt salt.utils.zeromqt salt.payloadt salt.transport.clientt salt.extR t __proxyenabled__t getLoggert __name__R R
R R> RB R R ( ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/event.pyt <module> s. N
Mini Shell