saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

doc/requisites: document lack of SLS support for onchanges/watch

Browse source 
Add note to `onchanges` and `watch` requisite docs to state, that
addressing an included SLS as requisite to be monitored by `onchanges`
or `watch` is not supported.
This commit is contained in:
Elias Probst 2020-12-09 00:05:58 +00:00 • committed by Megan Wilhite
parent ab54b842e4
commit 18b60ccf85
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/ref/states/requisites.rst
View file

@ -290,6 +290,12 @@ the specified state to watch the state with the ``requisite_in``.
.. _requisites-watch:
.. note::
An ``onchanges`` requisite has no effect on SLS requisites (monitoring for
changes in an included SLS). Only the individual state IDs from an included
SLS can be monitored.
watch
~~~~~
@ -304,6 +310,12 @@ the execution module and will execute any time a watched state changes.
of ``watch``. ``watch`` is designed to add *additional* behavior when
there are changes, but otherwise the state executes normally.
.. note::
A ``watch`` requisite has no effect on SLS requisites (watching for changes
in an included SLS). Only the individual state IDs from an included SLS can
be watched.
A good example of using ``watch`` is with a :mod:`service.running
<salt.states.service.running>` state. When a service watches a state, then
the service is reloaded/restarted when the watched state changes, in addition