From 8cbe82e039817cd0faa03222e30c3c5757cfd416 Mon Sep 17 00:00:00 2001 From: Jamie Bliss Date: Sat, 1 Jun 2019 20:25:27 -0400 Subject: [PATCH] Modular Systems: Document saltenvs and modules --- doc/topics/development/modules/index.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/topics/development/modules/index.rst b/doc/topics/development/modules/index.rst index e95a485759c..e200ece8b82 100644 --- a/doc/topics/development/modules/index.rst +++ b/doc/topics/development/modules/index.rst @@ -55,9 +55,6 @@ prepended by underscore, such as: Modules must be synced before they can be used. This can happen a few ways, discussed below. -.. note: - Using saltenvs besides ``base`` may not work in all contexts. - Sync Via States ~~~~~~~~~~~~~~~ @@ -78,6 +75,15 @@ or specific dynamic modules. The ``saltutil.sync_*`` :py:mod:`runner functions ` can be used to sync modules to minions and the master, respectively. +About saltenvs +~~~~~~~~~~~~~~ + +In either of the above cases, which saltenvs are synced from are based on the topfiles. (Unless specified manually.) + +The minion syncs modules from saltenvs that mention the minion in the saltenv's topfile. + +That is, for each saltenv on the file server, if a minion is mentioned in that saltenv's topfile, the minion will load modules from that saltenv. + The extmods Directory ---------------------