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 2

Clarify custom module sync requirements

Browse source
This commit is contained in:
Ken Crowell 2020-05-02 11:27:21 -03:00 • committed by Daniel Wozniak
parent d8b51d2158
commit 44d2c90251
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog/55514.fixed Normal file
View file

@ -0,0 +1 @@
Documentation on syncing custom modules slightly inaccurate and missing info on sync to master

9
doc/ref/modules/index.rst
View file

@ -21,10 +21,17 @@ on most systems.
Modules placed in ``_modules/`` will be synced to the minions when any of the
following Salt functions are called:
* :mod:`state.apply <salt.modules.state.apply_>`
* :mod:`state.highstate <salt.modules.state.highstate>` (or :mod:`state.apply
<salt.modules.state.apply_>` with no state argument)
* :mod:`saltutil.sync_modules <salt.modules.saltutil.sync_modules>`
* :mod:`saltutil.sync_all <salt.modules.saltutil.sync_all>`
Modules placed in ``_modules/`` will be synced to masters when any of the
following Salt runners are called:
* :mod:`saltutil.sync_modules <salt.runners.saltutil.sync_modules>`
* :mod:`saltutil.sync_all <salt.runners.saltutil.sync_all>`
Note that a module's default name is its filename
(i.e. ``foo.py`` becomes module ``foo``), but that its name can be overridden
by using a :ref:`__virtual__ function <virtual-modules>`.