mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Add missing module type sections
This commit is contained in:
parent
172d8c2902
commit
40f9b16530
1 changed files with 97 additions and 32 deletions
|
@ -95,15 +95,15 @@ The specific names used by each loading method above are as follows. See section
|
|||
for a short summary of each of these systems.
|
||||
|
||||
============ ================================================================ ========================= =====================
|
||||
Module Type Salt Package Name Directory Name Entry Point
|
||||
Module Type Salt Package Name FS/Directory Name Entry Point
|
||||
============ ================================================================ ========================= =====================
|
||||
Auth ``salt.auth`` (:ref:`index <external-logging-handlers>`) ``auth`` [#no-fs]_ ``auth_dirs``
|
||||
Beacon ``salt.beacons`` (:ref:`index <beacons>`) ``beacons`` ``beacons_dirs``
|
||||
Cache ``salt.cache`` (:ref:`index <all-salt.cache>`) ``cache`` ``cache_dirs``
|
||||
Cloud ``salt.cloud.clouds`` (:ref:`index <all-salt.clouds>`) ``clouds`` ``cloud_dirs``
|
||||
Engine ``salt.engines`` (:ref:`index <engines>`) ``engines`` ``engines_dirs``
|
||||
Executor ``salt.executors`` (:ref:`index <all-salt_executors>`) ``executors`` [#no-fs]_ ``executor_dirs``
|
||||
Execution ``salt.modules`` (:ref:`index <all-salt.modules>`) ``modules`` ``module_dirs``
|
||||
Executor ``salt.executors`` (:ref:`index <all-salt_executors>`) ``executors`` [#no-fs]_ ``executor_dirs``
|
||||
File Server ``salt.fileserver`` (:ref:`index <file-server>`) ``fileserver`` [#no-fs]_ ``fileserver_dirs``
|
||||
Grain ``salt.grains`` (:ref:`index <all-salt.grains>`) ``grains`` ``grains_dirs``
|
||||
Log Handler ``salt.log.handlers`` (:ref:`index <external-logging-handlers>`) ``log_handlers`` ``log_handlers_dirs``
|
||||
|
@ -131,8 +131,33 @@ Wheel ``salt.wheels`` (:ref:`index <all-salt.wheel>`) ``
|
|||
|
||||
.. [#no-fs] These modules cannot be loaded from the Salt File Server.
|
||||
|
||||
Execution Modules
|
||||
-----------------
|
||||
Auth
|
||||
----
|
||||
|
||||
The auth module system allows for external authentication routines to be easily
|
||||
added into Salt. The `auth` function needs to be implemented to satisfy the
|
||||
requirements of an auth module. Use the ``pam`` module as an example.
|
||||
|
||||
Beacon
|
||||
------
|
||||
|
||||
Cache
|
||||
-----
|
||||
|
||||
Cloud
|
||||
-----
|
||||
|
||||
Engine
|
||||
------
|
||||
|
||||
Execution
|
||||
---------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
/ref/modules/index
|
||||
|
||||
Execution modules make up the core of the functionality used by Salt to
|
||||
interact with client systems. The execution modules create the core system
|
||||
|
@ -145,46 +170,31 @@ detecting information about the system. The only restraint in execution
|
|||
modules is that the defined functions always return a JSON serializable
|
||||
object.
|
||||
|
||||
For a list of all built in execution modules, click :ref:`here
|
||||
<all-salt.modules>`
|
||||
Executor
|
||||
--------
|
||||
|
||||
For information on writing execution modules, see :ref:`this page
|
||||
<writing-execution-modules>`.
|
||||
File Server
|
||||
-----------
|
||||
|
||||
State Modules
|
||||
-------------
|
||||
|
||||
State modules are used to define the state interfaces used by Salt States.
|
||||
These modules are restrictive in that they must follow a number of rules to
|
||||
function properly.
|
||||
|
||||
.. note::
|
||||
|
||||
State modules define the available routines in sls files. If calling
|
||||
an execution module directly is desired, take a look at the `module`
|
||||
state.
|
||||
|
||||
Auth
|
||||
----
|
||||
|
||||
The auth module system allows for external authentication routines to be easily
|
||||
added into Salt. The `auth` function needs to be implemented to satisfy the
|
||||
requirements of an auth module. Use the ``pam`` module as an example.
|
||||
|
||||
Fileserver
|
||||
----------
|
||||
|
||||
The fileserver module system is used to create fileserver backends used by the
|
||||
The file server module system is used to create file server backends used by the
|
||||
Salt Master. These modules need to implement the functions used in the
|
||||
fileserver subsystem. Use the ``gitfs`` module as an example.
|
||||
|
||||
Grains
|
||||
------
|
||||
|
||||
* :ref:`writing-grains`
|
||||
|
||||
Grain modules define extra routines to populate grains data. All defined
|
||||
public functions will be executed and MUST return a Python dict object. The
|
||||
dict keys will be added to the grains made available to the minion.
|
||||
|
||||
Log Handler
|
||||
-----------
|
||||
|
||||
Net API
|
||||
-------
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
|
@ -206,6 +216,9 @@ the filesystem pillar is passed into external pillars. This is commonly used
|
|||
as a bridge to database data for pillar, but is also the backend to the libvirt
|
||||
state used to generate and sign libvirt certificates on the fly.
|
||||
|
||||
Proxy
|
||||
-----
|
||||
|
||||
Renderers
|
||||
---------
|
||||
|
||||
|
@ -220,17 +233,69 @@ Returners are used to send data from minions to external sources, commonly
|
|||
databases. A full returner will implement all routines to be supported as an
|
||||
external job cache. Use the ``redis`` returner as an example.
|
||||
|
||||
Roster
|
||||
------
|
||||
|
||||
Runners
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
/ref/runners/index
|
||||
|
||||
Runners are purely master-side execution sequences.
|
||||
|
||||
SDB
|
||||
---
|
||||
|
||||
Search
|
||||
------
|
||||
|
||||
Serializer
|
||||
----------
|
||||
|
||||
State
|
||||
-----
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
/ref/states/index
|
||||
|
||||
State modules are used to define the state interfaces used by Salt States.
|
||||
These modules are restrictive in that they must follow a number of rules to
|
||||
function properly.
|
||||
|
||||
.. note::
|
||||
|
||||
State modules define the available routines in sls files. If calling
|
||||
an execution module directly is desired, take a look at the `module`
|
||||
state.
|
||||
|
||||
SPM pkgdb
|
||||
---------
|
||||
|
||||
SPM pkgfiles
|
||||
------------
|
||||
|
||||
SSH Wrapper
|
||||
-----------
|
||||
|
||||
Thorium
|
||||
-------
|
||||
|
||||
Tops
|
||||
----
|
||||
|
||||
Tops modules are used to convert external data sources into top file data for
|
||||
the state system.
|
||||
|
||||
Util
|
||||
----
|
||||
|
||||
Wheel
|
||||
-----
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue