Merge branch 'master' of github.com:thatch45/salt

This commit is contained in:
Thomas S Hatch 2011-11-13 11:26:57 -07:00
commit 7884696c07
79 changed files with 523 additions and 372 deletions

6
doc/_templates/autosummary.rst.tmpl vendored Normal file
View file

@ -0,0 +1,6 @@
{{ underline }}
{{ fullname }}
{{ underline }}
.. automodule:: {{ fullname }}
:members:

View file

@ -0,0 +1,8 @@
{% if parents %}
<h3>Parent topic</h3>
<ul>
{% for p in parents %}
<li><a href="{{ p.link|e }}">{{ p.title }}</a></li>
{% endfor %}
</ul>
{% endif %}

View file

@ -40,19 +40,9 @@
<div class="sidebar">
{%- block sidebarlogo %}{%- endblock %}
{%- if sidebars != None %}
{#- new style sidebar: explicitly include/exclude templates #}
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
{%- else %}
{#- old style sidebars: using blocks -- should be deprecated #}
{%- block sidebartoc %}{%- include "localtoc.html" %}{%- endblock %}
{%- block sidebarrel %}{%- include "relations.html" %}{%- endblock %}
{%- block sidebarsourcelink %}{%- include "sourcelink.html" %}{%- endblock %}
{%- if customsidebar %}{%- include customsidebar %}{%- endif %}
{%- block sidebarsearch %}{%- include "searchbox.html" %}{%- endblock %}
{%- endif %}
{%- for sidebartemplate in sidebars|default(html_default_sidebars, true) %}
{%- include sidebartemplate %}
{%- endfor %}
</div>
{%- endif %}
{%- endmacro %}

View file

@ -29,10 +29,12 @@ master_doc = 'contents'
templates_path = ['_templates']
exclude_patterns = ['_build']
extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks']
extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', 'sphinx.ext.autosummary']
modindex_common_prefix = ['salt.']
autosummary_generate = True
# Define a substitution for linking to the latest release tarball
rst_prolog = """\
.. |latest| replace:: https://github.com/downloads/thatch45/salt/salt-%s.tar.gz
@ -59,8 +61,20 @@ html_style = ['base-salt.css']
html_use_smartypants = False
html_additional_pages = {'index': 'index.html'}
html_sidebars = {'index': ['indexsidebar.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'],
}
html_context = {
'html_default_sidebars': html_default_sidebars,
'github_base': 'https://github.com/thatch45/salt',
'github_issues': 'https://github.com/thatch45/salt/issues',
'github_downloads': 'https://github.com/thatch45/salt/downloads',

View file

@ -17,10 +17,14 @@ Full Table of Contents
ref/index
ref/modules/*
ref/modules/all/index
ref/grains
ref/returners/*
ref/returners/all/index
ref/states/*
ref/states/all/index
ref/renderers/*
ref/renderers/all/index
ref/runners
ref/peer
ref/syndic

View file

@ -36,19 +36,19 @@ get much more out of Salt.
* **Remote execution:**
:doc:`Writing modules <ref/modules/index>`
| :doc:`full list of modules <ref/modules/modules>`
| :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/returners>`
| :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/states>`
| :doc:`full list of states <ref/states/all/index>`
* **Renderers:**
:doc:`Renderers <ref/renderers/index>`
| :doc:`full list of renderers <ref/renderers/renderers>`
| :doc:`full list of renderers <ref/renderers/all/index>`
* **Transferring & syncing files:**
:doc:`File Server <ref/file_server/index>`
* **Network topology:**

View file

@ -0,0 +1,49 @@
.. _all-salt.modules:
============================
Full list of builtin modules
============================
.. currentmodule:: salt.modules
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
apache
apt
butterkvm
cluster
cmd
cp
cron
disk
file
freebsdpkg
grains
groupadd
hosts
kmod
linux_sysctl
mdadm
moosefs
mount
mysql
network
pacman
ps
publish
puppet
pw_group
pw_user
selinux
service
shadow
solr
ssh
state
status
test
useradd
virt
yum

View file

@ -0,0 +1,6 @@
===================
salt.modules.apache
===================
.. automodule:: salt.modules.apache
:members:

View file

@ -0,0 +1,6 @@
================
salt.modules.apt
================
.. automodule:: salt.modules.apt
:members:

View file

@ -0,0 +1,6 @@
======================
salt.modules.butterkvm
======================
.. automodule:: salt.modules.butterkvm
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.cluster
====================
.. automodule:: salt.modules.cluster
:members:

View file

@ -0,0 +1,6 @@
================
salt.modules.cmd
================
.. automodule:: salt.modules.cmd
:members:

View file

@ -0,0 +1,6 @@
===============
salt.modules.cp
===============
.. automodule:: salt.modules.cp
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.cron
=================
.. automodule:: salt.modules.cron
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.disk
=================
.. automodule:: salt.modules.disk
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.file
=================
.. automodule:: salt.modules.file
:members:

View file

@ -0,0 +1,6 @@
=======================
salt.modules.freebsdpkg
=======================
.. automodule:: salt.modules.freebsdpkg
:members:

View file

@ -0,0 +1,6 @@
===================
salt.modules.grains
===================
.. automodule:: salt.modules.grains
:members:

View file

@ -0,0 +1,6 @@
=====================
salt.modules.groupadd
=====================
.. automodule:: salt.modules.groupadd
:members:

View file

@ -0,0 +1,6 @@
==================
salt.modules.hosts
==================
.. automodule:: salt.modules.hosts
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.kmod
=================
.. automodule:: salt.modules.kmod
:members:

View file

@ -0,0 +1,6 @@
=========================
salt.modules.linux_sysctl
=========================
.. automodule:: salt.modules.linux_sysctl
:members:

View file

@ -0,0 +1,6 @@
==================
salt.modules.mdadm
==================
.. automodule:: salt.modules.mdadm
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.moosefs
====================
.. automodule:: salt.modules.moosefs
:members:

View file

@ -0,0 +1,6 @@
==================
salt.modules.mount
==================
.. automodule:: salt.modules.mount
:members:

View file

@ -0,0 +1,6 @@
==================
salt.modules.mysql
==================
.. automodule:: salt.modules.mysql
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.network
====================
.. automodule:: salt.modules.network
:members:

View file

@ -0,0 +1,6 @@
===================
salt.modules.pacman
===================
.. automodule:: salt.modules.pacman
:members:

View file

@ -0,0 +1,6 @@
===============
salt.modules.ps
===============
.. automodule:: salt.modules.ps
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.publish
====================
.. automodule:: salt.modules.publish
:members:

View file

@ -0,0 +1,6 @@
===================
salt.modules.puppet
===================
.. automodule:: salt.modules.puppet
:members:

View file

@ -0,0 +1,6 @@
=====================
salt.modules.pw_group
=====================
.. automodule:: salt.modules.pw_group
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.pw_user
====================
.. automodule:: salt.modules.pw_user
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.selinux
====================
.. automodule:: salt.modules.selinux
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.service
====================
.. automodule:: salt.modules.service
:members:

View file

@ -0,0 +1,6 @@
===================
salt.modules.shadow
===================
.. automodule:: salt.modules.shadow
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.solr
=================
.. automodule:: salt.modules.solr
:members:

View file

@ -0,0 +1,6 @@
================
salt.modules.ssh
================
.. automodule:: salt.modules.ssh
:members:

View file

@ -0,0 +1,6 @@
==================
salt.modules.state
==================
.. automodule:: salt.modules.state
:members:

View file

@ -0,0 +1,6 @@
===================
salt.modules.status
===================
.. automodule:: salt.modules.status
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.test
=================
.. automodule:: salt.modules.test
:members:

View file

@ -0,0 +1,6 @@
====================
salt.modules.useradd
====================
.. automodule:: salt.modules.useradd
:members:

View file

@ -0,0 +1,6 @@
=================
salt.modules.virt
=================
.. automodule:: salt.modules.virt
:members:

View file

@ -0,0 +1,6 @@
================
salt.modules.yum
================
.. automodule:: salt.modules.yum
:members:

View file

@ -4,7 +4,7 @@ Modules
Salt modules are the functions called by the :command:`salt` command.
.. seealso:: :doc:`Full list of builtin modules <modules>`
.. seealso:: :ref:`Full list of builtin modules <all-salt.modules>`
Salt ships with many modules that cover a wide variety of tasks.

View file

@ -1,226 +0,0 @@
============================
Full list of builtin modules
============================
:mod:`salt.modules.apache`
==========================
.. automodule:: salt.modules.apache
:members:
:mod:`salt.modules.apt`
=======================
.. automodule:: salt.modules.apt
:members:
:mod:`salt.modules.butterkvm`
=============================
.. automodule:: salt.modules.butterkvm
:members:
:mod:`salt.modules.cluster`
===========================
.. automodule:: salt.modules.cluster
:members:
:mod:`salt.modules.cmd`
=======================
.. automodule:: salt.modules.cmd
:members:
:mod:`salt.modules.cp`
======================
.. automodule:: salt.modules.cp
:members:
:mod:`salt.modules.cron`
========================
.. automodule:: salt.modules.cron
:members:
..
:mod:`salt.modules.cytest`
==========================
..
.. automodule:: salt.modules.cytest
:members:
:mod:`salt.modules.disk`
========================
.. automodule:: salt.modules.disk
:members:
:mod:`salt.modules.file`
========================
.. automodule:: salt.modules.file
:members:
:mod:`salt.modules.freebsdpkg`
==============================
.. automodule:: salt.modules.freebsdpkg
:members:
:mod:`salt.modules.grains`
==========================
.. automodule:: salt.modules.grains
:members:
:mod:`salt.modules.groupadd`
============================
.. automodule:: salt.modules.groupadd
:members:
:mod:`salt.modules.hosts`
=========================
.. automodule:: salt.modules.hosts
:members:
:mod:`salt.modules.kmod`
========================
.. automodule:: salt.modules.kmod
:members:
:mod:`salt.modules.mdadm`
=========================
.. automodule:: salt.modules.mdadm
:members:
:mod:`salt.modules.moosefs`
===========================
.. automodule:: salt.modules.moosefs
:members:
:mod:`salt.modules.mount`
=========================
.. automodule:: salt.modules.mount
:members:
:mod:`salt.modules.mysql`
=========================
.. automodule:: salt.modules.mysql
:members:
:mod:`salt.modules.network`
===========================
.. automodule:: salt.modules.network
:members:
:mod:`salt.modules.pacman`
==========================
.. automodule:: salt.modules.pacman
:members:
:mod:`salt.modules.ps`
======================
.. automodule:: salt.modules.ps
:members:
:mod:`salt.modules.publish`
===========================
.. automodule:: salt.modules.publish
:members:
:mod:`salt.modules.puppet`
==========================
.. automodule:: salt.modules.puppet
:members:
:mod:`salt.modules.pw_group`
============================
.. automodule:: salt.modules.pw_group
:members:
:mod:`salt.modules.pw_user`
===========================
.. automodule:: salt.modules.pw_user
:members:
:mod:`salt.modules.selinux`
===========================
.. automodule:: salt.modules.selinux
:members:
:mod:`salt.modules.service`
===========================
.. automodule:: salt.modules.service
:members:
:mod:`salt.modules.shadow`
==========================
.. automodule:: salt.modules.shadow
:members:
:mod:`salt.modules.solr`
========================
.. automodule:: salt.modules.solr
:members:
:mod:`salt.modules.ssh`
=======================
.. automodule:: salt.modules.ssh
:members:
:mod:`salt.modules.state`
=========================
.. automodule:: salt.modules.state
:members:
:mod:`salt.modules.status`
==========================
.. automodule:: salt.modules.status
:members:
:mod:`salt.modules.test`
========================
.. automodule:: salt.modules.test
:members:
:mod:`salt.modules.useradd`
===========================
.. automodule:: salt.modules.useradd
:members:
:mod:`salt.modules.virt`
========================
.. automodule:: salt.modules.virt
:members:
:mod:`salt.modules.yum`
=======================
.. automodule:: salt.modules.yum
:members:

View file

@ -0,0 +1,17 @@
.. _all-salt.renderers:
==============================
Full list of builtin renderers
==============================
.. currentmodule:: salt.renderers
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
json_jinja
json_mako
yaml_jinja
yaml_mako
py

View file

@ -0,0 +1,6 @@
=========================
salt.renderers.json_jinja
=========================
.. automodule:: salt.renderers.json_jinja
:members:

View file

@ -0,0 +1,6 @@
========================
salt.renderers.json_mako
========================
.. automodule:: salt.renderers.json_mako
:members:

View file

@ -0,0 +1,6 @@
=================
salt.renderers.py
=================
.. automodule:: salt.renderers.py
:members:

View file

@ -0,0 +1,6 @@
=========================
salt.renderers.yaml_jinja
=========================
.. automodule:: salt.renderers.yaml_jinja
:members:

View file

@ -0,0 +1,6 @@
========================
salt.renderers.yaml_mako
========================
.. automodule:: salt.renderers.yaml_mako
:members:

View file

@ -1,18 +0,0 @@
==============================
Full list of builtin renderers
==============================
.. automodule:: salt.renderers.json_jinja
:members:
.. automodule:: salt.renderers.json_mako
:members:
.. automodule:: salt.renderers.py
:members:
.. automodule:: salt.renderers.yaml_jinja
:members:
.. automodule:: salt.renderers.yaml_mako
:members:

View file

@ -0,0 +1,15 @@
.. _all-salt.returners:
==============================
Full list of builtin returners
==============================
.. currentmodule:: salt.returners
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
local
mongo_return
redis_return

View file

@ -0,0 +1,6 @@
====================
salt.returners.local
====================
.. automodule:: salt.returners.local
:members:

View file

@ -0,0 +1,6 @@
===========================
salt.returners.mongo_return
===========================
.. automodule:: salt.returners.mongo_return
:members:

View file

@ -0,0 +1,6 @@
===========================
salt.returners.redis_return
===========================
.. automodule:: salt.returners.redis_return
:members:

View file

@ -14,7 +14,7 @@ The returner interface allows the return data to be sent to any system that
can receive data. This means that return data can be sent to a Redis server,
a MongoDB server, a MySQL server, or any system!
.. seealso:: :doc:`Full list of builtin returners <returners>`
.. seealso:: :ref:`Full list of builtin returners <all-salt.returners>`
Writing a Returner
==================

View file

@ -1,25 +0,0 @@
==============================
Full list of builtin returners
==============================
.. contents:: Contents
:local:
:depth: 1
:mod:`salt.returners.local`
===========================
.. automodule:: salt.returners.local
:members:
:mod:`salt.returners.redis_return`
==================================
.. automodule:: salt.returners.redis_return
:members:
:mod:`salt.returners.mongo_return`
==================================
.. automodule:: salt.returners.mongo_return
:members:

View file

@ -0,0 +1,24 @@
.. _all-salt.states:
===========================
Full list of builtin states
===========================
.. currentmodule:: salt.states
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
cmd
cron
file
group
host
kmod
mount
pkg
service
ssh_auth
sysctl
user

View file

@ -0,0 +1,6 @@
===============
salt.states.cmd
===============
.. automodule:: salt.states.cmd
:members:

View file

@ -0,0 +1,6 @@
================
salt.states.cron
================
.. automodule:: salt.states.cron
:members:

View file

@ -0,0 +1,6 @@
================
salt.states.file
================
.. automodule:: salt.states.file
:members:

View file

@ -0,0 +1,6 @@
=================
salt.states.group
=================
.. automodule:: salt.states.group
:members:

View file

@ -0,0 +1,6 @@
================
salt.states.host
================
.. automodule:: salt.states.host
:members:

View file

@ -0,0 +1,6 @@
================
salt.states.kmod
================
.. automodule:: salt.states.kmod
:members:

View file

@ -0,0 +1,6 @@
=================
salt.states.mount
=================
.. automodule:: salt.states.mount
:members:

View file

@ -0,0 +1,6 @@
===============
salt.states.pkg
===============
.. automodule:: salt.states.pkg
:members:

View file

@ -0,0 +1,6 @@
===================
salt.states.service
===================
.. automodule:: salt.states.service
:members:

View file

@ -0,0 +1,6 @@
====================
salt.states.ssh_auth
====================
.. automodule:: salt.states.ssh_auth
:members:

View file

@ -0,0 +1,6 @@
==================
salt.states.sysctl
==================
.. automodule:: salt.states.sysctl
:members:

View file

@ -0,0 +1,6 @@
================
salt.states.user
================
.. automodule:: salt.states.user
:members:

View file

@ -1,63 +0,0 @@
===========================
Full list of builtin states
===========================
:mod:`salt.states.cmd`
======================
.. automodule:: salt.states.cmd
:members:
:mod:`salt.states.cron`
=======================
.. automodule:: salt.states.cron
:members:
:mod:`salt.states.file`
=======================
.. automodule:: salt.states.file
:members:
:mod:`salt.states.group`
========================
.. automodule:: salt.states.group
:members:
:mod:`salt.states.host`
=======================
.. automodule:: salt.states.host
:members:
:mod:`salt.states.mount`
========================
.. automodule:: salt.states.mount
:members:
:mod:`salt.states.pkg`
======================
.. automodule:: salt.states.pkg
:members:
:mod:`salt.states.service`
==========================
.. automodule:: salt.states.service
:members:
:mod:`salt.states.ssh_auth`
===========================
.. automodule:: salt.states.ssh_auth
:members:
:mod:`salt.states.user`
=======================
.. automodule:: salt.states.user
:members:

View file

@ -1,18 +1,22 @@
"""
Manage Apache Solr
This module uses http requests to talk to the Apache Solr request handlers to
gather information and report errors. Because of this the minion doesn't
nescessarily need to reside on the actual slave. However if you want to use
the signal function the minion must reside on the physical Solr host.
This module supports multi-core and standard setups. Certain methods are
master/slave specific. Make sure you set the ``solr.type``. If you have
questions or want a feature request please ask.
"""
###############################################################################
# APACHE SOLR SALT MODULE #
# Author: Jed Glazner #
# Version: 0.1 #
# Modified: 9/20/2011 #
# #
# This module uses http requests to talk to the apache solr request handlers #
# to gather information and report errors. Because of this the minion doesn't #
# nescessarily need to reside on the actual slave. However if you want to #
# use the signal function the minion must reside on the physical solr host. #
# #
# This module supports multi-core and standard setups. Certain methods are #
# master/slave specific. Make sure you set the solr.type. If you have #
# questions or want a feature request please ask. #
# #
# #############################################################################
import urllib

View file

@ -1,6 +1,8 @@
'''
The default rendering engine, yaml_jinja, this renderer will take a yaml file
with the jinja template and render it to a high data format for salt states.
Process json with the jinja2 templating engine
This renderer will take a json file with the jinja template and render it to a
high data format for salt states.
'''
# Import python libs

View file

@ -1,6 +1,8 @@
'''
The default rendering engine, yaml_jinja, this renderer will take a yaml file
with the jinja template and render it to a high data format for salt states.
Process json with the Mako templating engine
This renderer will take a json file with the Mako template and render it to a
high data format for salt states.
'''
# Import python libs

View file

@ -1,6 +1,8 @@
'''
Pure python state renderer, the sls file should contain a function called sls
which returns high state data
Pure python state renderer
The sls file should contain a function called ``sls`` which returns high state
data
'''
# Import python libs

View file

@ -1,6 +1,8 @@
'''
The default rendering engine, yaml_jinja, this renderer will take a yaml file
with the jinja template and render it to a high data format for salt states.
The default rendering engine, process yaml with the jinja2 templating engine
This renderer will take a yaml file with the jinja2 template and render it to a
high data format for salt states.
'''
# Import python libs

View file

@ -1,6 +1,8 @@
'''
yaml_mako, this renderer will take a yaml file
within a mako template and render it to a high data format for salt states.
Process yaml with the Mako templating engine
This renderer will take a yaml file within a mako template and render it to a
high data format for salt states.
'''
# Import python libs