mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 08:58:59 +00:00
41 lines
1.3 KiB
ReStructuredText
41 lines
1.3 KiB
ReStructuredText
|
=======
|
||
|
|
Beacons
|
||
|
|
=======
|
||
|
|
|
||
|
|
The beacon system allows the minion to hook into system processes and
|
||
|
|
continually translate external events into the salt event bus. The
|
||
|
|
primary example of this is the ``inotify`` beacon. This beacon uses
|
||
|
|
inotify to watch configured files or directories on the minion for
|
||
|
|
changes, creation, deletion etc.
|
||
|
|
|
||
|
|
This allows for the changes to be sent up tot he master where the
|
||
|
|
reactor can respond to changes.
|
||
|
|
|
||
|
|
Configuring The Beacons
|
||
|
|
=======================
|
||
|
|
|
||
|
|
The beacon system, like many others in Salt, can be configured via the
|
||
|
|
minion pillar, grains, or local config file:
|
||
|
|
|
||
|
|
.. code-block:: yaml
|
||
|
|
|
||
|
|
beacons:
|
||
|
|
inotify:
|
||
|
|
/etc/httpd/conf.d: {}
|
||
|
|
/opt: {}
|
||
|
|
|
||
|
|
Writing Beacon Plugins
|
||
|
|
======================
|
||
|
|
|
||
|
|
Beacon plugins use the standard salt loader system, meaning that many of the
|
||
|
|
constructs from other plugin systems holds true, such as the ``__virtul__``
|
||
|
|
function.
|
||
|
|
|
||
|
|
The important function in the Beacon Plugin is the ``beacon`` function. When
|
||
|
|
the beacon is configured to run, this function will be executed repeatedly
|
||
|
|
by the minion. The ``beacon`` function therefore cannot block and should be
|
||
|
|
as lightweight as possible. The ``beacon`` also must return a list of dicts,
|
||
|
|
each dict in the list will be translated into an event on the master.
|
||
|
|
|
||
|
|
Please see the inotify beacon as an example.
|