From c3667a5f91083963b9fedbc50b94e673cdeef29b Mon Sep 17 00:00:00 2001 From: Daniel Wozniak Date: Tue, 5 Mar 2019 02:16:16 -0700 Subject: [PATCH] Merge pull request #51907 from max-arnold/module-docs-fix Minor improvements in module docs --- doc/topics/development/modules/index.rst | 23 +++++++++++++++---- .../tutorials/jinja_to_execution_module.rst | 3 +-- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/doc/topics/development/modules/index.rst b/doc/topics/development/modules/index.rst index 223e57ae484a..45ba66c51a13 100644 --- a/doc/topics/development/modules/index.rst +++ b/doc/topics/development/modules/index.rst @@ -55,7 +55,7 @@ prepended by underscore, such as: Modules must be synced before they can be used. This can happen a few ways, discussed below. -.. note: +.. note:: Using saltenvs besides ``base`` may not work in all contexts. Sync Via States @@ -143,6 +143,8 @@ Executor ``salt.executors`` (:ref:`index `) `` File Server ``salt.fileserver`` (:ref:`index `) ``fileserver`` ``fileserver_dirs`` Grain ``salt.grains`` (:ref:`index `) ``grains`` ``grains_dirs`` Log Handler ``salt.log.handlers`` (:ref:`index `) ``log_handlers`` ``log_handlers_dirs`` +Matcher ``salt.matchers`` ``matchers`` ``matchers_dirs`` +Metaproxy ``salt.metaproxy`` ``metaproxy`` [#no-fs]_ ``metaproxy_dirs`` Net API ``salt.netapi`` (:ref:`index `) ``netapi`` [#no-fs]_ ``netapi_dirs`` Outputter ``salt.output`` (:ref:`index `) ``output`` ``outputter_dirs`` Pillar ``salt.pillar`` (:ref:`index `) ``pillar`` ``pillar_dirs`` @@ -167,7 +169,7 @@ Wheel ``salt.wheels`` (:ref:`index `) `` .. [#no-fs] These modules cannot be loaded from the Salt File Server. -.. note: +.. note:: While it is possible to import modules directly with the import statement, it is strongly recommended that the appropriate :ref:`dunder dictionary ` is used to access them @@ -189,7 +191,7 @@ Beacon * :ref:`Writing Beacons ` -Beacons are polled by the Salt event loop to monitor non-salt processes. See +Beacons are polled by the Salt event loop to monitor non-salt processes. See :ref:`Beacons ` for more information about the beacon system. Cache @@ -268,6 +270,19 @@ Log Handler Log handlers allows the logs from salt (master or minion) to be sent to log aggregation systems. +Matcher +------- + +Matcher modules are used to define the :ref:`minion targeting expressions `. +For now, it is only possible to override the :ref:`existing matchers ` +(the required CLI plumbing for custom matchers is not implemented yet). + +Metaproxy +--------- + +Metaproxy is an abstraction layer above the existing proxy minion. It enables +adding different types of proxy minions that can still load existing proxymodules. + Net API ------- @@ -392,7 +407,7 @@ Tokens Token stores for :ref:`External Authentication `. See the :py:mod:`salt.tokens` docstring for details. -.. note: +.. note:: The runner to load tokens modules is :py:func:`saltutil.sync_eauth_tokens `. diff --git a/doc/topics/tutorials/jinja_to_execution_module.rst b/doc/topics/tutorials/jinja_to_execution_module.rst index 25493635926a..91500f4f82dc 100644 --- a/doc/topics/tutorials/jinja_to_execution_module.rst +++ b/doc/topics/tutorials/jinja_to_execution_module.rst @@ -6,8 +6,7 @@ How to Convert Jinja Logic to an Execution Module .. versionadded: 2016.??? -.. note: - +.. note:: This tutorial assumes a basic knowledge of Salt states and specifically experience using the `maps.jinja` idiom.