valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-06 16:45:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Removed site homepage; replaced with docs homepage

Browse Source
This commit is contained in:
Seth House 2012-02-06 15:45:24 -07:00
parent f7dce9a7ee
commit 4514368865
7 changed files with 201 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
doc/_templates/index.html vendored
View File

@ -1,83 +0,0 @@
{% extends "layout.html" %}
{% set title = 'Overview' %}
{% block body %}
<div class="introduction">
<h1>What is Salt?</h1>
<p>Salt is a powerful remote execution manager that can be used to
administer servers in a fast and efficient way.</p>
<p>Salt allows commands to be executed across large groups of servers.
This means systems can be easily managed, but data can also be easily
gathered. Quick introspection into running systems becomes a
reality.</p>
<p>Remote execution is usually used to set up a certain state on a
remote system. Salt addresses this problem as well, the salt state
system uses salt state files to define the state a server needs to be
in.</p>
<p>Between the remote execution system, and state management Salt
addresses the backbone of cloud and data center management.</p>
<h2>The Salt stack</h2>
<dl class="feat-link">
<dt>Remote execution</dt>
<dd>Remote execution is the core of modern cloud and infrastructure
solutions, and Salt offers the fastest and easiest remote execution
system available today</dd>
</dl>
<dl class="feat-link">
<dt>Configuration management</dt>
<dd>Salt offers the world simplest, yet most powerful, flexible and
scalable configuration management system</dd>
</dl>
<dl class="feat-link">
<dt>Highly scalable</dt>
<dd>Easily manage tens or hundreds or even tens of thousands of
nodes with a multi-tiered management infrastructure.</dd>
</dl>
<dl class="feat-link">
<dt>Highly configurable</dt>
<dd>Receive responses where, how, and when you want.</dd>
</dl>
</div>
<div class="documentation">
<h2>Documentation</h2>
<dl class="doc-link">
<dt class="doc-tutorials"><a href="{{ pathto("home") }}#docs-tutorials">Tutorials</a></dt>
<dd>Get started with each Salt component in five minutes or less</dd>
</dl>
<dl class="doc-link">
<dt class="doc-fulldocs"><a href="{{ pathto("home") }}#docs-reference">Documentation</a></dt>
<dd>Comprehensive and in-depth explanations and reference;
<br>Offline?
<a href="{{ github_downloads }}/salt-{{ version }}.pdf" class="doc-pdf">
<img src="{{ pathto('_static/page_white_acrobat.png', 1) }}">
PDF</a>
| <a href="{{ github_downloads }}/salt-{{ version }}.epub" class="doc-epub">
<img src="{{ pathto('_static/book_open.png', 1) }}">
ePUB</a>
</dd>
</dl>
<dl class="doc-link">
<dt class="doc-offline"><a href="{{ pathto("contents") }}">Contents</a></dt>
<dd>An exhaustive (and exhausting) overview of all the Salt documentation</dd>
</dl>
<dl class="doc-link">
<dt class="doc-fulldocs"><a href="{{ pathto("py-modindex") }}">Module index</a></dt>
<dd>Quickly jump to the reference for individual modules, states, and more</dd>
</dl>
</div>
{% endblock %}

32
doc/_templates/indexsidebar.html vendored
View File

@ -1,32 +0,0 @@
<h3>Download</h3>
{% if version.endswith('pre') %}
<p>This documentation is for version <b>{{ version }}</b>, which is not released yet.</p>
<p>You can download it from the <a href="{{ github_base }}">GitHub repository</a>.</p>
{% else %}
<p>Current version: <b>{{ version }}</b></p>
<p>Get the Salt tarball from the <a href="{{ github_downloads }}">GitHub downloads page</a>,
or <a href="{{ pathto("topics/installation") }}">packages are available</a> for some OSes.</p>
<p><a href="{{ pathto("topics/releases/index") }}">Read the release announcement.</a></p>
{#
<p>Latest <a href="http://saltstack.org/latest">development version docs</a> are also available.</p>
#}
{% endif %}
<h3>Recent updates</h3>
<p>Our IRC channel is now on the popular Freenode network. See you there!</p>
<p>The Salt git repository can now be found at the new saltstack GitHub organization.
<a href="http://red45.wordpress.com/2011/11/15/little-move-big-progress/">Read why.</a></p>
<h3>Get help. Get involved.</h3>
<form action="http://groups.google.com/group/salt-users/boxsubscribe">
<p>Join the <a href="https://groups.google.com/forum/#!forum/salt-users">mailing list</a>:
<br>
<input type="email" name="email" placeholder="Email address">
<button type="submit" name="sub">Subscribe</button></p>
</form>
<p>Join us via IRC in the <tt>#salt</tt> channel via
<a href="http://webchat.freenode.net/?channels=salt&uio=Mj10cnVlJjk9dHJ1ZSYxMD10cnVl83">Freenode's webchat</a>.</p>
<p><a href="{{ github_issues }}">Search bugs</a> or file one.</p>

8
doc/_templates/layout.html vendored
View File

@ -1,6 +1,6 @@
{% extends "!layout.html" %}
{% block rootrellink %}
<li><a href="{{ pathto('index') }}">Salt home</a>&nbsp;|&nbsp;</li>
<li><a href="{{ pathto('home') }}">Documentation</a> &raquo;</li>
{% endblock %}
{%- block rootrellink %}
<li><a href="http://saltstack.org">&laquo; SaltStack.org</a>&nbsp;|&nbsp;</li>
<li><a href="{{ pathto('index') }}">Documentation home</a></li>
{%- endblock %}

28
doc/conf.py
View File

@ -76,20 +76,15 @@ on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
project = u'Salt'
copyright = u'2011, Thomas S. Hatch'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = __version__
# The full version, including alpha/beta/rc tags.
release = version
master_doc = 'contents'
templates_path = ['_templates']
exclude_patterns = ['_build']
extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', 'sphinx.ext.autosummary']
extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks',
'sphinx.ext.autosummary']
modindex_common_prefix = ['salt.']
@ -122,23 +117,20 @@ html_favicon = 'favicon.ico'
html_use_smartypants = False
html_additional_pages = {
'index': 'index.html',
'404': '404.html',
}
html_default_sidebars = [
'localtoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html']
html_sidebars = {
'ref/**/all/salt.*': ['autosummarysidebar.html'] + html_default_sidebars,
'index': ['indexsidebar.html', 'searchbox.html'],
'ref/**/all/salt.*': [
'autosummarysidebar.html',
'localtoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html',
],
}
html_context = {
'html_default_sidebars': html_default_sidebars,
'github_base': 'https://github.com/saltstack/salt',
'github_issues': 'https://github.com/saltstack/salt/issues',
'github_downloads': 'https://github.com/saltstack/salt/downloads',
@ -158,7 +150,7 @@ latex_documents = [
u'Thomas Hatch', 'manual'),
]
latex_logo = '_static/salt.png'
latex_logo = '_static/salt-vert.png'
### Manpage options

2
doc/contents.rst
View File

@ -6,8 +6,6 @@ Full Table of Contents
:maxdepth: 3
:glob:
home
topics/index
topics/configuration
topics/tutorials/modules

80
doc/home.rst
View File

@ -1,80 +0,0 @@
.. _contents:
.. |vid| image:: /_static/film_link.png
.. _docs-tutorials:
Salt at a glance
================
Learn about the various parts of Salt in five minute increments (or less).
* **What is Salt?:**
:doc:`Overview <topics/index>`
| :doc:`Community </topics/community>`
* **The basics:**
`Installation`_
| :doc:`Configuration <topics/configuration>`
| |vid| `Watch the screencast <http://blip.tv/saltstack/salt-installation-configuration-and-remote-execution-5713423>`_
* **Remote execution:**
:doc:`Modules <topics/tutorials/modules>`
* **State management:**
:doc:`Part 1 <topics/tutorials/states_pt1>`
| :doc:`Part 2 <topics/tutorials/states_pt2>`
| :doc:`Part 3 <topics/tutorials/states_pt3>`
.. _docs-reference:
Salt in depth
=============
While using and setting up Salt is a simple task, the capabilities of Salt run
much deeper. Gaining a better understanding of how Salt works will allow you to
get much more out of Salt.
* **Remote execution:**
:doc:`Writing modules <ref/modules/index>`
| :doc:`full list of modules <ref/modules/all/index>`
* **System info & detection:**
:doc:`Grains <ref/grains>`
* **Displaying or storing responses:**
:doc:`Writing returners <ref/returners/index>`
| :doc:`full list of returners <ref/returners/all/index>`
* **State enforcement:**
:doc:`States <ref/states/index>`
| :doc:`Highstate data structure <ref/states/highstate>`
| :doc:`full list of states <ref/states/all/index>`
* **Renderers:**
:doc:`Renderers <ref/renderers/index>`
| :doc:`full list of renderers <ref/renderers/all/index>`
* **Transferring & syncing files:**
:doc:`File Server <ref/file_server/index>`
* **Network topology:**
:doc:`ref/syndic`
| :doc:`ref/peer`
* **Configuration:**
:doc:`Full list of minion settings <ref/configuration/minion>`
| :doc:`Full list of master settings <ref/configuration/master>`
* **Using Salt:**
:doc:`From the command-line <ref/cli/index>`
| :doc:`Through the Python API <ref/python-api>`
.. admonition:: Screencasts and presentations
* Thomas S. Hatch was `interviewed on episode 191 of FLOSS Weekly
<http://twit.tv/show/floss-weekly/191>`_.
* Presentation at the Salt Lake Linux User Group (SLLUG) in May 2011
`video <http://blip.tv/thomas-s-hatch/salt-0-8-7-presentation-5180182>`_
| :download:`slides <Salt.pdf>` (PDF)
Salt quick reference
====================
* :doc:`Release notes </topics/releases/index>`
| :doc:`Roadmap </topics/roadmap/index>`
* :ref:`modindex`
| :ref:`genindex`
| :doc:`Full table of contents </contents>`
* :ref:`search`

187
doc/index.rst Normal file
View File

@ -0,0 +1,187 @@
.. _contents:
.. |vid| image:: /_static/film_link.png
Get started with Salt
=====================
.. sidebar:: Presentations
A list of `presentations and interviews on Salt`_ (including the FLOSS
Weekly interview).
.. _`presentations and interviews on Salt`: http://saltstack.org/presentations/
Salt is a **remote execution** and **configuration management** tool.
Salt is designed to be secure using **AES encryption** and **public-key
authentication**; incredibly scaleable using an advanced **ZeroMQ** topology;
fast and efficient using **msgpack**; and extensible using small and simple
**Python** modules.
Read the :doc:`Salt overview <topics/index>` for a more thorough description.
Step 1: Remote execution
------------------------
.. sidebar:: |vid| Screencasts
Watch the `remote execution screencast`__.
.. __: http://blip.tv/saltstack/salt-installation-configuration-and-remote-execution-5713423
The quickest way to see Salt in action is to run a command on a :term:`minion`
host from the :term:`master` host. This is widely known as :term:`remote
execution` — executing commands on remote hosts.
1. `Installation`_
2. :doc:`Configure the minion <topics/configuration>`
3. :doc:`Run remote commands <topics/tutorials/modules>`
Step 2: Configuration management
--------------------------------
Now that you have the basics out of the way, learn to use Salt to configure
your servers. This is widely known as :term:`configuration management` —
installing packages, configuring users and services, and much more.
1. :doc:`Basic config management <topics/tutorials/states_pt1>`
2. :doc:`Less basic config management <topics/tutorials/states_pt2>`
3. :doc:`Advanced techniques <topics/tutorials/states_pt3>`
Salt in depth
=============
Setting up and using Salt is a simple task but it's capabilities run much, much
deeper. Gaining a better understanding of how Salt works will allow you to
truly make it work for you.
.. contents:: Overview
:local:
:depth: 2
**Remote execution**
Remote execution is the core functionality 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 a package, restarting a service,
running a remote command, transferring a file — and the list goes on.
:doc:`Full list of modules </ref/modules/all/index>`
The giant list of core modules that ship with Salt
(And there are even more in the `salt-contrib`_ repository!)
:doc:`Writing modules <ref/modules/index>`
A guide on how to write Salt modules
**Targeting**
Specify which hosts should run commands or manage configuration.
:doc:`Targeting <ref/targeting/index>`
Hostnames, lists, regular expressions, or define groups.
:doc:`Grains <ref/grains>`
Bits of static information about a minion such as OS, version,
virtualization, CPU, memory, and much more.
**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 or more.
:doc:`Writing returners <ref/returners/index>`
If we're missing your favorite storage backend, webservice, or you
need a custom endpoint returners are *tiny* and simple to write.
**Configuration management**
Building on the remote execution core is a robust and flexible config
management framework. Execution happens on the minions allowing
effortless, simultaneous configuration of thousands of hosts.
**States**
Express the state of a host using small, easy to read, easy to
understand configuration files. No programming required (unless you
want to).
:doc:`Full list of states <ref/states/all/index>`
Install packages, create users, transfer files, start services, and
more and more.
:doc:`Using states <ref/states/index>`
You've seen the big list of available states, now learn how to call
them.
:doc:`Highstate data structure <ref/states/highstate>`
A dry, vocabulary and technical representation of the configuration
format that states represent.
**Renderers**
Write state configuration files in the language, templating engine, or
file type of your choice. The world doesn't need yet another DSL.
:doc:`Full list of renderers <ref/renderers/all/index>`
YAML? JSON? Jinja? Mako? Python? We got you covered. (And if we
don't, new renderers are *tiny* and easy to write.)
:doc:`Renderers <ref/renderers/index>`
Salt states are only concerned with the ultimate highstate data
structure. How you create that data structure isn't our business.
Tweak a config option and use whatever you're most comfortable
with.
**Miscellaneous topics**
Salt is a many splendid thing.
:doc:`File Server <ref/file_server/index>`
Salt can easily and quickly transfer files (in fact, that's how Salt
States work). Even under load, files are chunked and served.
:doc:`Syndic <ref/syndic>`
A seamless master of masters. Scale Salt to 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:`Network topology <ref/topology>`
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:`Python API interface <ref/python-api>`
Use Salt programmatically from your own scripts and programs easily and
simply via ``import salt``.
**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.
**More information about the project**
:doc:`Roadmap </topics/roadmap/index>`
Where we're headed.
:doc:`Release notes </topics/releases/index>`
Where we've been.
:doc:`Community </topics/community>`
How you can get involved.
.. _`salt-contrib`: https://github.com/saltstack/salt-contrib
.. _`salt-states`: https://github.com/saltstack/salt-states