Clarifying the documentation for extension_modules configuration option

This commit is contained in:
Gareth J. Greenaway 2023-03-23 10:47:21 -07:00 committed by Pedro Algarvio
parent 04a7781a77
commit 39f0184eed
3 changed files with 16 additions and 8 deletions

1
changelog/63929.fixed.md Normal file
View file

@ -0,0 +1 @@
Clarifying documentation for extension_modules configuration option.

View file

@ -60,15 +60,19 @@
#
#cachedir: /var/cache/salt/master
# Directory for custom modules. This directory can contain subdirectories for
# each of Salt's module types such as "runners", "output", "wheel", "modules",
# "states", "returners", "engines", "utils", etc.
# Directory where custom modules synced to This directory can contain
# subdirectories for each of Salt's module types such as "runners",
# "output", "wheel", "modules", "states", "returners", "engines",
# "utils", etc.
#
# Note, any directories or files not found in the `module_dirs`
# location will be removed from the extension_modules path.
#extension_modules: /var/cache/salt/master/extmods
# Directory for custom modules. This directory can contain subdirectories for
# each of Salt's module types such as "runners", "output", "wheel", "modules",
# "states", "returners", "engines", "utils", etc.
# Like 'extension_modules' but can take an array of paths
#module_dirs: []
# Verify and set permissions on configuration directories at startup:

View file

@ -206,10 +206,13 @@ following the Filesystem Hierarchy Standard (FHS) might set it to
moved into the master cachedir (on most platforms,
``/var/cache/salt/master/extmods``).
Directory for custom modules. This directory can contain subdirectories for
each of Salt's module types such as ``runners``, ``output``, ``wheel``,
``modules``, ``states``, ``returners``, ``engines``, ``utils``, etc.
This path is appended to :conf_master:`root_dir`.
Directory wehre custom modules are synced to. This directory can contain
subdirectories for each of Salt's module types such as ``runners``,
``output``, ``wheel``, ``modules``, ``states``, ``returners``, ``engines``,
``utils``, etc. This path is appended to :conf_master:`root_dir`.
Note, any directories or files not found in the `module_dirs` location
will be removed from the extension_modules path.
.. code-block:: yaml