valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 08:58:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated the netapi modules index to be more clear

Browse Source
This commit is contained in:
Seth House 2014-06-18 20:16:20 -06:00
parent 554a612aa4
commit 6f112d6eef
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/topics/netapi/index.rst
View File

@ -4,24 +4,33 @@
Introduction to netapi modules
==============================
netapi modules generally bind to a port and start a service. They are
purposefully open-ended. There could be multiple netapi modules that provide a
REST interface, a module that provides an XMPP interface, or Websockets, or
XMLRPC.
netapi modules provide API-centric access to Salt. Usually externally-facing
services such as REST or WebSockets, XMPP, XMLRPC, etc.
netapi modules are enabled by adding configuration to your master config file.
Check the docs for each module to see external requirements and configuration
settings.
In general netapi modules bind to a port and start a service. They are
purposefully open-ended. A single module can be configured to run as well as
multiple modules simultaneously.
Communication with Salt and Salt satellite projects is done by passing a list of
lowstate dictionaries to a client interface. A list of available client
interfaces is below. The lowstate dictionary items map to keyword arguments on
the client interface.
netapi modules are enabled by adding configuration to your Salt Master config
file and then starting the :command:`salt-api` daemon. Check the docs for each
module to see external requirements and configuration settings.
.. seealso:: :ref:`python-api`
Communication with Salt and Salt satellite projects is done using Salt's own
:ref:`Python API <python-api>`. A list of available client interfaces is below.
.. admonition:: salt-api
Prior to Salt's Helium release, netapi modules lived in the separate sister
projected ``salt-api``. That project has been merged into the main Salt
project.
Client interfaces
=================
Salt's client interfaces expose executing functions by crafting a dictionary of
values that are mapped to function arguments. This allows calling functions
simply by creating a data structure. (And this is exactly how much of Salt's
own internals work!)
.. autoclass:: saltapi.APIClient
:members: local, local_async, local_batch, runner, wheel