2012-10-16 22:58:08 +00:00
|
|
|
========
|
|
|
|
|
salt-api
|
|
|
|
|
========
|
|
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
:program:`salt-api` is a modular interface on top of `Salt`_ that can provide a
|
2012-10-16 22:58:08 +00:00
|
|
|
variety of entry points into a running Salt system. It can start and manage
|
|
|
|
|
multiple interfaces allowing a REST API to coexist with XMLRPC or even a
|
|
|
|
|
Websocket API.
|
|
|
|
|
|
|
|
|
|
.. _`Salt`: http://saltstack.org/
|
|
|
|
|
|
2012-12-23 21:12:03 +00:00
|
|
|
Getting started
|
|
|
|
|
===============
|
|
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
1. Install :program:`salt-api` on the same machine as your Salt master.
|
|
|
|
|
2. Edit your Salt master config file for all required options for each
|
|
|
|
|
``netapi`` module you wish to run.
|
|
|
|
|
3. Install any required additional libraries or software for each ``netapi``
|
2013-02-12 19:34:40 +00:00
|
|
|
module you wish to run.
|
2013-03-04 20:52:51 +00:00
|
|
|
4. Run :command:`salt-api` which will then start all configured ``netapi``
|
2013-02-12 19:34:40 +00:00
|
|
|
modules.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
Each ``netapi`` module will have differing configuration requirements and
|
|
|
|
|
differing required software libraries.
|
|
|
|
|
|
|
|
|
|
Exactly like the various module types in Salt (:term:`execution modules`,
|
|
|
|
|
:term:`renderer modules`, :term:`returner modules`, etc.), :term:`netapi
|
|
|
|
|
modules` in :program:`salt-api` will *not* be loaded into memory or started
|
|
|
|
|
if all requirements are not met.
|
2012-12-23 21:12:03 +00:00
|
|
|
|
2013-04-09 14:40:12 +00:00
|
|
|
Installation quickstart
|
|
|
|
|
=======================
|
2013-02-12 21:59:00 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
topics/quickstart
|
|
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
``netapi`` modules
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
The core functionality for :program:`salt-api` lies in pluggable ``netapi``
|
|
|
|
|
modules that adhere to the simple interface of binding to a port and starting a
|
|
|
|
|
service. :program:`salt-api` can manage one or many services concurrently.
|
2012-09-24 20:17:56 +00:00
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
Full list of ``netapi`` modules
|
|
|
|
|
-------------------------------
|
2012-10-16 22:58:08 +00:00
|
|
|
|
2012-10-25 21:45:16 +00:00
|
|
|
.. toctree::
|
2013-03-04 20:52:51 +00:00
|
|
|
:maxdepth: 3
|
2012-10-25 21:45:16 +00:00
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
ref/netapis/all/index
|
2012-10-25 21:45:16 +00:00
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
``netapi`` developer reference
|
|
|
|
|
------------------------------
|
2012-10-16 22:58:08 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
2013-03-04 20:52:51 +00:00
|
|
|
:maxdepth: 1
|
2012-10-16 22:58:08 +00:00
|
|
|
|
2013-03-04 20:52:51 +00:00
|
|
|
topics/netapis/index
|
|
|
|
|
topics/netapis/writing
|
2012-09-24 20:17:56 +00:00
|
|
|
|
|
|
|
|
Releases
|
|
|
|
|
========
|
|
|
|
|
|
2012-10-16 22:58:08 +00:00
|
|
|
.. toctree::
|
2013-03-04 20:52:51 +00:00
|
|
|
:maxdepth: 2
|
2012-10-16 22:58:08 +00:00
|
|
|
|
|
|
|
|
topics/releases/index
|
2012-09-24 20:17:56 +00:00
|
|
|
|
|
|
|
|
Reference
|
|
|
|
|
=========
|
|
|
|
|
|
2012-10-16 22:58:08 +00:00
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
|
|
|
|
* :ref:`glossary`
|
