Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:
Go to file
2012-10-18 13:25:08 -04:00
conf update pub_refresh to be set to False 2012-10-11 22:37:44 -06:00
debian remove generated files and directories on package purge 2012-10-07 18:32:26 -07:00
doc Fix typo in master_tops doc 2012-10-17 22:39:25 -06:00
pkg moved salt.spec to 0.10.3 and added systemd scriptlets 2012-10-03 10:29:00 -06:00
salt fix to work with 3.0 upwards, should work on 2.7 and 2.6 release as well 2012-10-18 13:25:08 -04:00
scripts Add freeze_support on salt-minion script 2012-09-10 14:13:02 -05:00
tests fix sock_dir change for eventlisten script 2012-10-15 22:50:31 -06:00
.gitignore ignore 'tmp' directory created by integration test 2012-07-01 03:46:43 +05:30
.pylintrc include salt specific builtins 2012-05-01 22:58:16 +05:30
.travis.yml Fix running tests using python setup.py tests. I was deleting it too soon and not re-creating it. Increase tests verbosity on travis-ci. 2012-10-05 02:45:35 +01:00
AUTHORS adding my name to AUTHORS 2012-09-23 17:13:13 -05:00
HACKING.rst Add notes for M2Crypto setup 2012-09-18 00:04:04 -06:00
LICENSE Change from British LICENCE to American LICENSE spelling to match spelling in LICENSE file and packaging files 2011-07-27 18:09:56 -06:00
MANIFEST.in include tests/integration/tmp/_README no longer exists. Remove it from MANIFEST.in. 2012-10-05 02:10:33 +01:00
README.rst Tenants rent your property. Tenets are are principles that you uphold. 2012-06-30 06:25:06 -07:00
requirements.txt Removed camelcase from the pycrypto requirement as it's not the original package's spelling 2012-07-13 16:36:25 +02:00
setup.py Extend setuptools clean command to remove compiled python files. 2012-10-12 15:51:28 +01:00
tox.ini - tox boilerplate for when py3k matters 2012-05-30 16:07:12 -06:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

=============
What is Salt?
=============

.. image:: https://secure.travis-ci.org/saltstack/salt.png?branch=develop
   :target: http://travis-ci.org/saltstack/salt

.. rubric:: Were not just talking about NaCl.

Distributed Remote Execution
============================

Salt is a distributed remote execution system used to execute commands and
query data. It was developed in order to bring the best solutions found in the
world of remote execution together and make them better, faster and more
malleable. Salt accomplishes this via its ability to handle larger loads of
information, and not just dozens, but hundreds, or even thousands of individual
servers. It handles them quickly and through a simple yet manageable interface.

Simplicity
==========

Versatility between massive scale deployments and smaller systems may seem
daunting, but Salt is very simple to set up and maintain, regardless of the
size of the project. The architecture of Salt is designed to work with any
number of servers, from a handful of local network systems to international
deployments across disparate datacenters. The topology is a simple
server/client model with the needed functionality built into a single set of
daemons. While the default configuration will work with little to no
modification, Salt can be fine tuned to meet specific needs.

Parallel Execution
==================

The core function of Salt is to enable remote commands to be called in parallel
rather than in serial. It does this over a secure and encrypted protocol using
the smallest and fastest network payloads possible. All of this is possible
and Salt still manages to have a simple interface for developers. Salt also
introduces more granular controls to the realm of remote execution,
allowing for commands to be executed in parallel and for systems to be targeted
based on more than just hostname, but by live system properties.

Building on Proven Technology
=============================

Salt takes advantage of a number of technologies and techniques. The networking
layer is built with the excellent `ZeroMQ`_ networking library. Salt itself
contains a viable, and transparent, ZeroMQ broker inside the daemon. Salt uses
public keys for authentication with the master daemon, then uses faster AES
encryption for payload communication. This means that authentication and
encryption are also built into Salt. Salt takes advantage of communication via
the most excellent `msgpack`_ library, enabling fast and light network traffic.

.. _`ZeroMQ`: http://www.zeromq.org/

.. _`msgpack`: http://msgpack.org/


Python Client Interface
=======================

Salt execution routines can be written as plain Python modules and the data
collected from execution can be sent back to the master server, or any
arbitrary program. Salt can be called from a simple Python API, or from the
command line. This makes it easy to execute one-off commands as well as
operate as an integral part of a larger application.


Fast, Flexible, Scalable, Secure
================================

The result is a system that can execute commands across groups of
varying size, from very few to very many servers at considerably high
speed. We consider speed to be a feature, not an afterthought. Salts
unique architecture brings together the best of the remote execution
world, amplifies its capabilities and expands its range, resulting in
this system that is as versatile as it is practical. Last but not least,
security is an intrinsic part of Salt and something not just
influencing how source code is written and how tests are done, but
also something that defines the overall architecture and has heavy
influence on the core design tenets.

Open
====

Salt is developed under the `Apache 2.0 licence`_, and can be used for
open and proprietary projects. Please submit your expansions back to
the Salt project so that we can all benefit together as Salt grows.
Finally, please sprinkle some Salt around your systems and let the
deliciousness come forth.

.. _`Apache 2.0 licence`: http://www.apache.org/licenses/LICENSE-2.0.html