mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 00:55:19 +00:00
53bab586f4
Woot! The conflicts below are intentional because they contained salt-api-isms that needed to be included into the corresponding Salt files. Conflicts: debian/changelog debian/control doc/conf.py doc/index.rst opt_requirements.txt salt/config.py salt/loader.py
280 lines
9.9 KiB
ReStructuredText
280 lines
9.9 KiB
ReStructuredText
:orphan:
|
|
|
|
.. _contents:
|
|
|
|
SaltStack
|
|
=========
|
|
|
|
Salt is a new approach to infrastructure management. Easy enough to get
|
|
running in minutes, scalable enough to manage tens of thousands of servers,
|
|
and fast enough to communicate with them in *seconds*.
|
|
|
|
Salt delivers a dynamic communication bus for infrastructures that can be used
|
|
for orchestration, remote execution, configuration management and much more.
|
|
|
|
.. seealso:: Other Documentation
|
|
|
|
Download an offline copy of the latest Salt documentation:
|
|
|
|
* `PDF`_
|
|
* `ePub`_
|
|
|
|
See documentation for past Salt releases at http://salt.readthedocs.org.
|
|
Download offline copies on the `ReadTheDocs download page`_.
|
|
|
|
Watch announcements, demonstrations, and video tutorials on the `SaltStack
|
|
YouTube channel`_.
|
|
|
|
.. _`PDF`: https://media.readthedocs.org/pdf/salt/latest/salt.pdf
|
|
.. _`ePub`: https://media.readthedocs.org/epub/salt/latest/salt.epub
|
|
.. _`ReadTheDocs download page`: https://readthedocs.org/projects/salt/downloads/
|
|
.. _`SaltStack YouTube channel`: http://www.youtube.com/saltstack
|
|
|
|
Download
|
|
========
|
|
|
|
Salt source releases are available for download via PyPI:
|
|
|
|
https://pypi.python.org/pypi/salt
|
|
|
|
The installation documents outline where to obtain packages and installation
|
|
specifics for platforms:
|
|
|
|
:doc:`Installation </topics/installation/index>`
|
|
|
|
The Salt Bootstrap project is a single shell script which aims to automate
|
|
the install correctly on platforms:
|
|
|
|
https://github.com/saltstack/salt-bootstrap
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
This walkthrough is made to help individuals get started quickly and gain a
|
|
foundational knowledge of Salt:
|
|
|
|
:doc:`Official Salt Walkthrough</topics/tutorials/walkthrough>`
|
|
|
|
Additional tutorials are available when getting started with Salt
|
|
|
|
States - Configuration Management with Salt:
|
|
- :doc:`Getting Started with States<topics/tutorials/starting_states>`
|
|
- :doc:`Basic config management <topics/tutorials/states_pt1>`
|
|
- :doc:`Less basic config management <topics/tutorials/states_pt2>`
|
|
- :doc:`Advanced techniques <topics/tutorials/states_pt3>`
|
|
- :doc:`Salt Fileserver Path Inheritance <topics/tutorials/states_pt4>`
|
|
|
|
Masterless Quickstart:
|
|
:doc:`Salt Quickstart </topics/tutorials/quickstart>`
|
|
|
|
A list of all tutorials can be found here:
|
|
:doc:`All Salt tutorials <topics/tutorials/index>`
|
|
|
|
Salt in depth
|
|
=============
|
|
|
|
Setting up and using Salt is a simple task but its capabilities run much, much
|
|
deeper. These documents will lead to a greater understating of how Salt will
|
|
empower infrastructure management.
|
|
|
|
Remote execution
|
|
----------------
|
|
|
|
Remote execution is the core function of Salt. Running pre-defined or
|
|
arbitrary commands on remote hosts.
|
|
|
|
**Modules**
|
|
Salt modules are the core of remote execution. They provide
|
|
functionality such as installing packages, restarting a service,
|
|
running a remote command, transferring files, and infinitely more.
|
|
|
|
:doc:`Full list of modules </ref/modules/all/index>`
|
|
The giant list of core modules that ship with Salt
|
|
|
|
:doc:`Writing modules <ref/modules/index>`
|
|
A guide on how to write Salt modules.
|
|
|
|
**Returners**
|
|
Salt returners allow saving minion responses in various datastores or
|
|
to various locations in addition to display at the CLI.
|
|
|
|
:doc:`Full list of returners </ref/returners/all/index>`
|
|
Store minion responses in Redis, Mongo, Cassandra, SQL or more.
|
|
|
|
:doc:`Writing returners <ref/returners/index>`
|
|
Extending Salt to communicate with more interfaces is easy, new
|
|
databases can be supported or custom interfaces can be easily
|
|
communicated with.
|
|
|
|
Targeting
|
|
---------
|
|
|
|
:ref:`Targeting <targeting>` is the method of specifying which minions should
|
|
execute commands or manage server configuration.
|
|
|
|
:ref:`Globbing and regex <targeting-glob>`
|
|
Match minions using globbing and regular expressions.
|
|
|
|
:ref:`Grains <targeting-grains>`
|
|
Match minions using bits of static information about the minion such as
|
|
OS, software versions, virtualization, CPU, memory, and much more.
|
|
|
|
:ref:`Pillar <targeting-pillar>`
|
|
Match minions using user-defined variables.
|
|
|
|
:ref:`Subnet/IP Address <targeting-ipcidr>`
|
|
Match minions by Subnet or IP address (currently IPv4 only).
|
|
|
|
:ref:`Compound matching <targeting-compound>`
|
|
Combine any of the above matchers into a single expression.
|
|
|
|
:ref:`Node groups <targeting-nodegroups>`
|
|
Statically define groups of minions in the master config file using the
|
|
:ref:`compound <targeting-compound>` matching syntax.
|
|
|
|
:ref:`Batching execution <targeting-batch>`
|
|
Loop through all matching minions so that only a subset are executing a
|
|
command at one time.
|
|
|
|
Configuration management
|
|
------------------------
|
|
|
|
Building on the remote execution core is a robust and flexible configuration
|
|
management framework. Execution happens on the minions allowing effortless,
|
|
simultaneous configuration of tens of thousands of hosts.
|
|
|
|
**States**
|
|
Express the state of a host using small, easy to read, easy to
|
|
understand configuration files. *No programming required*.
|
|
|
|
:doc:`Full list of states <ref/states/all/index>`
|
|
Install packages, create users, transfer files, start services, and
|
|
much more.
|
|
|
|
:doc:`Pillar System <topics/pillar/index>`
|
|
Salt's Pillar system
|
|
|
|
:doc:`States Overview<ref/states/index>`
|
|
An overview of States and some of the core components.
|
|
|
|
:doc:`Highstate data structure <ref/states/highstate>`
|
|
A dry vocabulary and technical representation of the configuration
|
|
format that states represent.
|
|
|
|
:doc:`Writing states <ref/states/writing>`
|
|
A guide on how to write Salt state modules. Extending Salt to directly
|
|
manage in more software is easy.
|
|
|
|
**Renderers**
|
|
Write state configuration files in the language, templating engine, or
|
|
file type of choice. Salt's configuration management system is, under the
|
|
hood, language agnostic.
|
|
|
|
:doc:`Full list of renderers <ref/renderers/all/index>`
|
|
YAML is not the only choice, many systems are available, from
|
|
alternative templating engines to the PyDSL language for rendering
|
|
sls formulas.
|
|
|
|
:doc:`Renderers <ref/renderers/index>`
|
|
Salt states are only concerned with the ultimate highstate data
|
|
structure. How that data structure is created is not important.
|
|
|
|
Miscellaneous topics
|
|
--------------------
|
|
|
|
Salt is many splendid things.
|
|
|
|
:doc:`Salt Cloud <topics/cloud/index>`
|
|
Salt Cloud is a public cloud provisioning tool that integrates Salt with
|
|
many cloud providers.
|
|
|
|
:doc:`File Server <ref/file_server/index>`
|
|
Salt can easily and quickly transfer files (in fact, that's how Salt
|
|
States work). Even under heavy load, files are chunked and served.
|
|
|
|
:doc:`Syndic <topics/topology/syndic>`
|
|
A seamless master of masters. Scale Salt to tens of thousands of hosts or
|
|
across many different networks.
|
|
|
|
:doc:`Peer Communication <ref/peer>`
|
|
Allow minions to communicate amongst themselves. For example, configure
|
|
one minion by querying live data from all the others. With great power
|
|
comes great responsibility.
|
|
|
|
:doc:`Reactor System <topics/reactor/index>`
|
|
The reactor system allows for Salt to create a self aware environment
|
|
by hooking infrastructure events into actions.
|
|
|
|
:doc:`Firewall Settings and Salt <topics/tutorials/firewall>`
|
|
A tutorial covering how to properly firewall a Salt Master server.
|
|
|
|
:doc:`Scheduling Executions (like states)<topics/jobs/schedule>`
|
|
The schedule system in Salt allows for executions to be run of all sorts
|
|
from the master or minion at automatic intervals.
|
|
|
|
:doc:`Network topology <topics/topology/index>`
|
|
At it's core, Salt is a highly scalable communication layer built on
|
|
top of ZeroMQ that enables remote execution and configuration
|
|
management. The possibilities are endless and Salt's future looks
|
|
bright.
|
|
|
|
:doc:`Testing Salt <topics/development/tests/index>`
|
|
A howto for writing unit tests and integration tests.
|
|
|
|
:doc:`Salt Proxy Minions <topics/topology/proxyminion/index>`
|
|
Controlling devices and machines unable to run a salt-minion.
|
|
|
|
:ref:`Python API interface <python-api>`
|
|
Use Salt locally from scripts and programs easily and
|
|
simply via ``import salt``.
|
|
|
|
:ref:`External API interfaces <netapi-introduction>`
|
|
Expose a Salt API such as REST, XMPP, WebSockets, and more using netapi
|
|
modules. See the :ref:`full list of netapi modules <all-netapi-modules>`.
|
|
|
|
:doc:`Automatic Updates and Frozen Binary Deployments <topics/tutorials/esky>`
|
|
Use a frozen install to make deployments easier (Even on Windows!). Or
|
|
take advantage of automatic updates to keep minions running the latest
|
|
builds.
|
|
|
|
:doc:`Windows Software Manager / Package Repository <topics/windows/windows-package-manager>`
|
|
Looking for an easy way to manage software on Windows machines?
|
|
Search no more! Salt has an integrated software package manager for
|
|
Windows machines! Install software hosted on the master, somewhere on the
|
|
network, or any HTTP, HTTPS, or ftp server.
|
|
|
|
Reference
|
|
---------
|
|
|
|
:doc:`Command-line interface <ref/cli/index>`
|
|
Read the Salt manpages.
|
|
|
|
:doc:`Full list of master settings <ref/configuration/master>`
|
|
Read through the heavily-commented master configuration file.
|
|
|
|
:doc:`Full list of minion settings <ref/configuration/minion>`
|
|
Read through the heavily-commented minion configuration file.
|
|
|
|
:doc:`Full table of contents </contents>`
|
|
Dense but complete.
|
|
|
|
FAQ
|
|
===
|
|
|
|
See :doc:`here <faq>` for a list of Frequently Asked Questions.
|
|
|
|
More information about the project
|
|
==================================
|
|
|
|
:doc:`Release notes </topics/releases/index>`
|
|
Living history of SaltStack.
|
|
|
|
:doc:`Salt Development </topics/development/index>`
|
|
Information for Hacking on Salt
|
|
|
|
:doc:`Translate Documentation </topics/development/translating>`
|
|
How to help out translating Salt to your language.
|
|
|
|
.. _`salt-contrib`: https://github.com/saltstack/salt-contrib
|
|
.. _`salt-states`: https://github.com/saltstack/salt-states
|