salt/debian
Seth House e269995ab6 Added minimum version requirements to the *zmq packages
Renamed the Debian python-zmq package to the Ubuntu python-pyzmq
package for now. (How is this best reconciled?)
2011-11-25 23:51:16 -07:00
..
patches adding the debian packaging files 2011-10-03 21:46:11 -06:00
source adding the debian packaging files 2011-10-03 21:46:11 -06:00
AUTHORS adding the debian packaging files 2011-10-03 21:46:11 -06:00
changelog adding the debian packaging files 2011-10-03 21:46:11 -06:00
compat Lowered debhelper and Standards-Version for Ubuntu 10.04 LTS 2011-11-25 23:51:16 -07:00
control Added minimum version requirements to the *zmq packages 2011-11-25 23:51:16 -07:00
copyright adding the debian packaging files 2011-10-03 21:46:11 -06:00
files adding the debian packaging files 2011-10-03 21:46:11 -06:00
README.rst adding the debian packaging files 2011-10-03 21:46:11 -06:00
rules adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.debhelper.log adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.manpages adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.postinst.debhelper adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.postrm.debhelper adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.prerm.debhelper adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.salt-master.init adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.salt-minion.init adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.salt-syndic.init adding the debian packaging files 2011-10-03 21:46:11 -06:00
salt.substvars adding the debian packaging files 2011-10-03 21:46:11 -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?
=============

.. 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, handle them quickly and through a simple and 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, to use a secure and encrypted protocol, the smallest and
fastest network payloads possible, and with a simple programmer interface. 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 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, so Salt itself
contains a viable, and transparent, AMQ 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
Python pickles, enabling fast and light network traffic.

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

Python client interface
=======================

In order to allow for simple expansion, Salt execution routines can be written
as plain Python modules and the data collected from Salt executions can be sent
back to the master server, or to any arbitrary program. Salt can be called from
a simple Python API, or from the command line, so that Salt can be used to
execute one-off commands as well as operate as an integral part of a larger
application.

Fast, flexible, scalable
========================

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. A system that is
very fast, easy to set up and amazingly malleable, able to suit the needs of
any number of servers working within the same system. 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, able to suit any network.

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.  So, please feel free to
sprinkle some of this around your systems and let the deliciousness come forth.

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