Add docs for the saltutil state module

saltstack · May 7, 2019 · f11510c · f11510c
1 parent 7758312
commit f11510c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/doc/ref/states/all/index.rst b/doc/ref/states/all/index.rst
@@ -258,6 +258,7 @@ state modules
     rvm
     salt_proxy
     saltmod
+    saltutil
     schedule
     selinux
     serverdensity_device

diff --git a/doc/ref/states/all/salt.states.saltutil.rst b/doc/ref/states/all/salt.states.saltutil.rst
@@ -0,0 +1,6 @@
+====================
+salt.states.saltutil
+====================
+
+.. automodule:: salt.states.saltutil
+    :members:
diff --git a/doc/topics/development/modules/index.rst b/doc/topics/development/modules/index.rst
@@ -69,6 +69,16 @@ dynamic modules when states are run. To disable this behavior set
 When dynamic modules are autoloaded via states, only the modules defined in the
 same saltenvs as the states currently being run.
 
+Also it is possible to use the explicit ``saltutil.sync_*`` :py:mod:`state functions <salt.states.saltutil>`
+to sync the modules (previously it was necessary to use the ``module.run`` state):
+
+.. code-block::yaml
+
+   synchronize_modules:
+     saltutil.sync_modules:
+       - refresh: True
+
+
 Sync Via the saltutil Module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~