mirror of
https://github.com/valitydev/salt.git
synced 2024-11-09 01:36:48 +00:00
Merge pull request #21179 from whiteinge/doc-presence-cross-ref-localhost-prob
Improved presence docs; added cross-references and localhost caveat
This commit is contained in:
commit
0eaaf87eec
@ -418,8 +418,12 @@ this can slow down the authentication process a bit in large setups.
|
||||
|
||||
Default: False
|
||||
|
||||
When enabled the master regularly sends events of currently connected, lost
|
||||
and newly connected minions on the eventbus.
|
||||
Causes the master to periodically look for actively connected minions.
|
||||
:ref:`Presence events <event-master_presence>` are fired on the event bus on a
|
||||
regular interval with a list of connected minions, as well as events with lists
|
||||
of newly connected or disconnected minions. This is a master-only operation
|
||||
that does not send executions to minions. Note, this does not detect minions
|
||||
that connect to a master via localhost.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
@ -70,12 +70,16 @@ Job events
|
||||
:var fun: The function the minion ran. E.g., ``test.ping``.
|
||||
:var return: The data returned from the execution module.
|
||||
|
||||
.. _event-master_presence:
|
||||
|
||||
Presence events
|
||||
===============
|
||||
|
||||
.. salt:event:: salt/presence/present
|
||||
|
||||
Fired on a set schedule.
|
||||
Events fired on a regular interval about currently connected, newly
|
||||
connected, or recently disconnected minions. Requires the
|
||||
:conf_master:`presence_events` setting to be enabled.
|
||||
|
||||
:var present: A list of minions that are currently connected to the Salt
|
||||
master.
|
||||
|
Loading…
Reference in New Issue
Block a user