valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-09 01:36:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch '0.10.1'

Browse Source
This commit is contained in:
Thomas S Hatch 2012-06-19 18:52:40 -06:00
commit 5d7d55f60a
429 changed files with 20233 additions and 3480 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.gitignore vendored
View File

@ -19,3 +19,13 @@ share/
# tox - ignore any tox-created virtualenv dirs
.tox
# setuptools stuff
*.egg-info
# code coverage outputs genereated by coverage.py
.coverage
coverage.xml
htmlcov/
/.project
/.pydevproject

249
.pylintrc Normal file
View File

@ -0,0 +1,249 @@
[MASTER]
# Specify a configuration file.
#rcfile=
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
# Profiled execution.
profile=no
# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=CVS
# Pickle collected data for later comparisons.
persistent=yes
# List of plugins (as comma separated values of python modules names) to load,
# usually to register additional checkers.
load-plugins=
[MESSAGES CONTROL]
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time.
#enable=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once).
#disable=
[REPORTS]
# Set the output format. Available formats are text, parseable, colorized, msvs
# (visual studio) and html
output-format=text
# Include message's id in output
include-ids=no
# Put messages in a separate file for each module / package specified on the
# command line instead of printing them on stdout. Reports (if any) will be
# written in a file name "pylint_global.[txt|html]".
files-output=no
# Tells whether to display a full report or only the messages
reports=yes
# Python expression which should return a note less than 10 (10 is the highest
# note). You have access to the variables errors warning, statement which
# respectively contain the number of errors / warnings messages and the total
# number of statements analyzed. This is used by the global evaluation report
# (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Add a comment according to your evaluation note. This is used by the global
# evaluation report (RP0004).
comment=no
[TYPECHECK]
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# List of classes names for which member attributes should not be checked
# (useful for classes with attributes dynamically set).
ignored-classes=SQLObject
# When zope mode is activated, add a predefined set of Zope acquired attributes
# to generated-members.
zope=no
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E0201 when accessed. Python regular
# expressions are accepted.
generated-members=REQUEST,acl_users,aq_parent
[BASIC]
# Required attributes for module, separated by a comma
required-attributes=
# List of builtins function names that should not be used, separated by a comma
bad-functions=map,filter,apply,input
# Regular expression which should only match correct module names
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
# Regular expression which should only match correct module level names
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
# Regular expression which should only match correct class names
class-rgx=[A-Z_][a-zA-Z0-9]+$
# Regular expression which should only match correct function names
function-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct method names
method-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct instance attribute names
attr-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct argument names
argument-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct variable names
variable-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct list comprehension /
# generator expression variable names
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,ex,Run,_
# Bad variable names which should always be refused, separated by a comma
bad-names=foo,bar,baz,toto,tutu,tata
# Regular expression which should only match functions or classes name which do
# not require a docstring
no-docstring-rgx=__.*__
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,XXX,TODO
[FORMAT]
# Maximum number of characters on a single line.
max-line-length=80
# Maximum number of lines in a module
max-module-lines=1000
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=' '
[VARIABLES]
# Tells whether we should check for unused import in __init__ files.
init-import=no
# A regular expression matching the beginning of the name of dummy variables
# (i.e. not used).
dummy-variables-rgx=_|dummy
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define new builtins when possible.
additional-builtins=__opts__,__salt__,__pillar__,__grains__
[SIMILARITIES]
# Minimum lines number of a similarity.
min-similarity-lines=4
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
[CLASSES]
# List of interface methods to ignore, separated by a comma. This is used for
# instance to not check methods defines in Zope's Interface base class.
ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,__new__,setUp
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
[IMPORTS]
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled)
import-graph=
# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled)
ext-import-graph=
# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled)
int-import-graph=
[DESIGN]
# Maximum number of arguments for function / method
max-args=5
# Argument names that match this expression will be ignored. Default to name
# with leading underscore
ignored-argument-names=_.*
# Maximum number of locals for function / method body
max-locals=15
# Maximum number of return / yield for function / method body
max-returns=6
# Maximum number of branch for function / method body
max-branchs=12
# Maximum number of statements in function / method body
max-statements=50
# Maximum number of parents for a class (see R0901).
max-parents=7
# Maximum number of attributes for a class (see R0902).
max-attributes=7
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception

20
.travis.yml
View File

@ -1,3 +1,5 @@
language: python
python:
- '2.6'
- '2.7'
@ -6,10 +8,16 @@ branches:
only:
- develop
before-install:
- sudo add-apt-repository ppa:saltstack/salt
- sudo apt-get update -y
- sudo apt-get install salt-master salt-syndic salt-minion
before_install:
- sudo apt-get update && sudo apt-get install swig
- pip install http://dl.dropbox.com/u/174789/m2crypto-0.20.1.tar.gz
- "if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install unittest2; fi"
script: cd tests && python runtests.py
after_script: python setup.py bdist
install: pip install -r requirements.txt --use-mirrors
script: python setup.py test
notifications:
irc:
channels: "irc.freenode.org#salt"
on_success: change
on_failure: change

1
AUTHORS
View File

@ -45,6 +45,7 @@ Jeff Schroeder <jeffschroeder@computer.org>
Jonas Buckner <buckner.jonas@gmail.com>
Joseph Hall <perlhoser@gmail.com>
Kent Tenney <ktenney@gmail.com>
Marc Abramowitz <marc+github@marc-abramowitz.com>
Markus Gattol <markus.gattol@sunoano.org>
Martin Schnabel <mb0@mb0.org>
Matthew Printz <hipokrit@gmail.com>

1
MANIFEST.in
View File

@ -9,5 +9,6 @@ include tests/integration/files/*
include tests/integration/tmp/_README
include tests/unit/templates/files/*
recursive-include doc *
recursive-include scripts *
include conf/*
recursive-include salt *.jinja

11
README.rst
View File

@ -2,6 +2,9 @@
What is Salt?
=============
.. image:: https://secure.travis-ci.org/saltstack/salt.png?branch=develop
:target: http://travis-ci.org/saltstack/salt
.. rubric:: We’re not just talking about NaCl.
Distributed Remote Execution
@ -32,7 +35,7 @@ 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
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.
@ -42,7 +45,7 @@ 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, 0MQ broker inside the daemon. Salt uses
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
@ -72,7 +75,7 @@ speed. We consider speed to be a feature, not an afterthought. Salt’s
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
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 tenants.
@ -83,7 +86,7 @@ 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
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

41
conf/master.template
View File

@ -38,6 +38,13 @@
# Set the directory used to hold unix sockets
#sock_dir: /tmp/salt-unix
# The master maintains a job cache, while this is a great addition it can be
# a burden on the master for larger deployments (over 5000 minions).
# Disabling the job cache will make previously executed jobs unavailable to
# the jobs system and is not generally recommended.
#
#job_cache: True
# Set the acceptance level for serialization of messages. This should only be
# set if the master is newer than 0.9.5 and the minion are older. This option
# allows a 0.9.5 and newer master to communicate with minions 0.9.4 and
@ -59,11 +66,21 @@
# public keys from the minions. Note that this is insecure.
#auto_accept: False
##### Master Module Management #####
##########################################
# Manage how master side modules are loaded
#
# Add any additional locations to look for master runners
#runner_dirs: []
#
#Enable Cython for master side modules
#cython_enable: False
##### State System settings #####
##########################################
# The state system uses a "top" file to tell the minions what environment to
# use and what modules to use. The state_top file is defined relative to the
# root of the base environment.
# root of the base environment as defined in "File Server settings" below.
#state_top: top.sls
#
# The external_nodes option allows Salt to gather data that would normally be
@ -137,7 +154,7 @@
# syndic servers(s) below it set the "order_masters" setting to True, if this
# is a master that will be running a syndic daemon for passthrough the
# "syndic_master" setting needs to be set to the location of the master server
# to recieve commands from.
# to receive commands from.
#
# Set the order_masters setting to True if this master will command lower
# masters' syndic interfaces.
@ -167,9 +184,27 @@
# peer:
# .*:
# - .*
# This is not recomanded, since it would allow anyone who gets root on any
# This is not recommended, since it would allow anyone who gets root on any
# single minion to instantly have root on all of the minions!
#
# Minions can also be allowed to execute runners from the salt master.
# Since executing a runner from the minion could be considered a security risk,
# it needs to be enabled. This setting functions just like the peer setting
# except that it opens up runners instead of module functions.
#
# All peer runner support is turned off by default and must be enabled before
# using. This will enable all peer runners for all minions:
#
# peer_run:
# .*:
# - .*
#
# To enable just the manage.up runner for the minion foo.example.com:
#
# peer_run:
# foo.example.com:
# - manage.up
#
##### Cluster settings #####
##########################################

10
conf/minion.template
View File

@ -25,11 +25,11 @@
#id:
# Append a domain to a hostname in the event that it does not exist. This is
# usefule for systems where socket.getfqdn() does not actually result in a
# useful for systems where socket.getfqdn() does not actually result in a
# FQDN (for instance, Solaris).
#append_domain:
# If the the connection to the server is interrupted, the minion will
# If the connection to the server is interrupted, the minion will
# attempt to reconnect. sub_timeout allows you to control the rate
# of reconnection attempts (in seconds). To disable reconnects, set
# this value to 0.
@ -97,7 +97,7 @@
#renderer: yaml_jinja
#
# state_verbose allows for the data returned from the minion to be more
# verbose. Normaly only states that fail or states that have changes are
# verbose. Normally only states that fail or states that have changes are
# returned, but setting state_verbose to True will return all states that
# were checked
#state_verbose: False
@ -116,7 +116,7 @@
# Normally the minion is not isolated to any single environment on the master
# when running states, but the environment can be isolated on the minion side
# by statically setting it. Remember that the recommended way to manage
# environments is to issolate via the top file.
# environments is to isolate via the top file.
#environment: None
#
# If using the local file directory, then the state top file name needs to be
@ -127,7 +127,7 @@
##########################################
# The Salt Minion can redirect all file server operations to a local directory,
# this allows for the same state tree that is on the master to be used if
# coppied completely onto the minion. This is a literal copy of the settings on
# copied completely onto the minion. This is a literal copy of the settings on
# the master but used to reference a local directory on the minion.
# Set the file client, the client defaults to looking on the master server for

6
debian/changelog vendored
View File

@ -1,3 +1,9 @@
salt (0.9.9) precise; urgency=low
* New upstream version
-- Tom Vaughan <thomas.david.vaughan@gmail.com> Tue, 01 May 2012 19:11:23 -0400
salt (0.9.8-1) unstable; urgency=low
* Initial upload to Debian unstable

1
debian/control vendored
View File

@ -15,6 +15,7 @@ Standards-Version: 3.9.3
Homepage: http://saltstack.org
#Vcs-Git: git://git.debian.org/collab-maint/salt.git
#Vcs-Browser: http://git.debian.org/?p=collab-maint/salt.git;a=summary
#X-Python-Version: >= 2.6, <= 2.7
Package: salt-common

2
debian/copyright vendored
View File

@ -1,7 +1,7 @@
Format: http://dep.debian.net/deps/dep5
Upstream-Name: salt
Upstream-Contact: salt-users@googlegroups.com
Source: https://github.com/downloads/saltstack/salt/salt-0.9.8.tar.gz
Source: https://github.com/downloads/saltstack/salt/salt-0.9.9.tar.gz
Files: *
Copyright: 2012 Thomas S Hatch <thatch45@gmail.com>

11
debian/salt-master.upstart vendored Normal file
View File

@ -0,0 +1,11 @@
description "salt-master"
start on (net-device-up
and local-filesystems
and runlevel [2345])
stop on runlevel [!2345]
expect daemon
respawn
exec /usr/bin/salt-master -d

12
debian/salt-minion.upstart vendored Normal file
View File

@ -0,0 +1,12 @@
description "salt-minion"
start on (net-device-up
and local-filesystems
and runlevel [2345])
stop on runlevel [!2345]
respawn limit 10 5
script
exec /usr/bin/python /usr/bin/salt-minion > /dev/null 2>&1
end script

12
debian/salt-syndic.upstart vendored Normal file
View File

@ -0,0 +1,12 @@
description "salt-syndic"
start on (net-device-up
and local-filesystems
and runlevel [2345])
stop on runlevel [!2345]
respawn limit 10 5
script
exec /usr/bin/python /usr/bin/salt-syndic > /dev/null 2>&1
end script

2
debian/source/format vendored
View File

@ -1 +1 @@
3.0 (quilt)
3.0 (native)

6
doc/_templates/autosummary.rst.tmpl vendored
View File

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

20
doc/_templates/autosummary/module.rst vendored Normal file
View File

@ -0,0 +1,20 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
{{ underline }}
{{ fullname }}
{{ underline }}
.. automodule:: {{ fullname }}
{% if functions %}
.. rubric:: Members
{% for item in functions if item in members %}
{{ item }}
{{ underline }}{{ underline }}{{ underline }}
.. autofunction:: {{ item }}
{% endfor %}
{% endif %}

66
doc/conf.py
View File

@ -2,6 +2,10 @@
import sys
import os
import types
from sphinx.directives import TocTree
class Mock(object):
'''
@ -78,8 +82,8 @@ on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# -- General configuration -----------------------------------------------------
project = u'Salt'
copyright = u'2012, Thomas S. Hatch'
project = 'Salt'
copyright = '2012, Thomas S. Hatch'
version = __version__
release = version
@ -151,8 +155,7 @@ html_show_copyright = True
### Latex options
latex_documents = [
('contents', 'Salt.tex', u'Salt Documentation',
u'Thomas Hatch', 'manual'),
('contents', 'Salt.tex', 'Salt Documentation', 'Thomas Hatch', 'manual'),
]
latex_logo = '_static/salt-vert.png'
@ -162,29 +165,58 @@ latex_logo = '_static/salt-vert.png'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
authors = [
u'Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file',
'Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file',
]
man_pages = [
('ref/cli/salt', 'salt', u'salt', authors, 1),
('contents', 'salt', u'Salt Documentation', authors, 7),
('ref/cli/salt-master', 'salt-master', u'salt-master Documentation', authors, 1),
('ref/cli/salt-minion', 'salt-minion', u'salt-minion Documentation', authors, 1),
('ref/cli/salt-key', 'salt-key', u'salt-key Documentation', authors, 1),
('ref/cli/salt-cp', 'salt-cp', u'salt-cp Documentation', authors, 1),
('ref/cli/salt-call', 'salt-call', u'salt-call Documentation', authors, 1),
('ref/cli/salt-syndic', 'salt-syndic', u'salt-syndic Documentation', authors, 1),
('ref/cli/salt-run', 'salt-run', u'salt-run Documentation', authors, 1),
('ref/cli/salt', 'salt', 'salt', authors, 1),
('contents', 'salt', 'Salt Documentation', authors, 7),
('ref/cli/salt-master', 'salt-master', 'salt-master Documentation', authors, 1),
('ref/cli/salt-minion', 'salt-minion', 'salt-minion Documentation', authors, 1),
('ref/cli/salt-key', 'salt-key', 'salt-key Documentation', authors, 1),
('ref/cli/salt-cp', 'salt-cp', 'salt-cp Documentation', authors, 1),
('ref/cli/salt-call', 'salt-call', 'salt-call Documentation', authors, 1),
('ref/cli/salt-syndic', 'salt-syndic', 'salt-syndic Documentation', authors, 1),
('ref/cli/salt-run', 'salt-run', 'salt-run Documentation', authors, 1),
]
### epub options
epub_title = u'Salt Documentation'
epub_author = u'Thomas S. Hatch'
epub_title = 'Salt Documentation'
epub_author = 'Thomas S. Hatch'
epub_publisher = epub_author
epub_copyright = u'2012, Thomas S. Hatch'
epub_copyright = '2012, Thomas S. Hatch'
epub_scheme = 'URL'
epub_identifier = 'http://saltstack.org/'
#epub_tocdepth = 3
def skip_mod_init_member(app, what, name, obj, skip, options):
if name.startswith('_'):
return True
if isinstance(obj, types.FunctionType) and obj.__name__ == 'mod_init':
return True
return False
def _normalize_version(args):
_, path = args
return '.'.join([x.zfill(4) for x in (path.split('/')[-1].split('.'))])
class ReleasesTree(TocTree):
option_spec = dict(TocTree.option_spec)
def run(self):
rst = super(ReleasesTree, self).run()
entries = rst[0][0]['entries'][:]
entries.sort(key=_normalize_version, reverse=True)
rst[0][0]['entries'][:] = entries
return rst
def setup(app):
app.add_directive('releasestree', ReleasesTree)
app.connect('autodoc-skip-member', skip_mod_init_member)

4
doc/contents.rst
View File

@ -17,9 +17,13 @@ Full Table of Contents
topics/tutorials/bootstrap_ec2
topics/pillar/index
topics/jobs/index
topics/nonroot
topics/troubleshooting/index
topics/troubleshooting/yaml_idiosyncrasies
topics/community
topics/tutorials/standalone_minion
topics/projects/index
topics/event/index
ref/index
ref/modules/*

20
doc/index.rst
View File

@ -1,3 +1,5 @@
:orphan:
.. _contents:
.. |vid| image:: /_static/film_link.png
@ -54,7 +56,7 @@ installing packages, configuring users and services, and much more.
Salt in depth
=============
Setting up and using Salt is a simple task but it's capabilities run much, much
Setting up and using Salt is a simple task but its capabilities run much, much
deeper. Gaining a better understanding of how Salt works will allow you to
truly make it work for you.
@ -62,6 +64,7 @@ truly make it work for you.
* :doc:`Bootstraping Salt on EC2 <topics/tutorials/bootstrap_ec2>`
* :doc:`Installing Salt on FreeBSD <topics/installation/freebsd>`
* :doc:`Preseeding Minions with Accepted Keys <topics/tutorials/preseed_key>`
.. contents:: The components of Salt
:local:
@ -86,6 +89,10 @@ configuration.
:doc:`Compound matchers </topics/targeting/compound>`
Combine the above matchers as a single target.
:doc:`Batching execution </topics/targeting/batch>`
Loop through all matching minions so that only a subset are executing a
command at one time.
Remote execution
----------------
@ -102,7 +109,7 @@ arbitrary commands on remote hosts.
(And there are even more in the `salt-contrib`_ repository!)
:doc:`Writing modules <ref/modules/index>`
A guide on how to write Salt modules
A guide on how to write Salt modules.
**Returners**
Salt returners allow saving minion responses in various datastores or
@ -129,14 +136,14 @@ effortless, simultaneous configuration of thousands of hosts.
:doc:`Full list of states <ref/states/all/index>`
Install packages, create users, transfer files, start services, and
more and more.
much 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
A dry vocabulary and technical representation of the configuration
format that states represent.
**Renderers**
@ -156,7 +163,7 @@ effortless, simultaneous configuration of thousands of hosts.
Miscellaneous topics
--------------------
Salt is a many splendid thing.
Salt is many splendid things.
:doc:`File Server <ref/file_server/index>`
Salt can easily and quickly transfer files (in fact, that's how Salt
@ -171,6 +178,9 @@ Salt is a many splendid thing.
one minion by querying live data from all the others. With great power
comes great responsibility.
:doc:`Running Salt without root <topics/nonroot>`
:doc:`Firewall settings and Salt <topics/tutorials/firewall>`
: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

22
doc/man/salt-call.1
View File

@ -1,4 +1,4 @@
.TH "SALT-CALL" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-CALL" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
@ -46,7 +46,7 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-g, \-\-grains
Return the information generated by the salt grains
Return the information generated by the Salt grains
.UNINDENT
.INDENT 0.0
.TP
@ -57,7 +57,7 @@ directories can be delimited by commas
.INDENT 0.0
.TP
.B \-d, \-\-doc
Return the documentation for the specified module of for all modules if
Return the documentation for the specified module or for all modules if
none are specified
.UNINDENT
.INDENT 0.0
@ -70,9 +70,9 @@ settings see the config file. Default: \fBinfo\fP.
.INDENT 0.0
.TP
.B \-\-raw\-out
Print the output from the salt command in raw python
Print the output from the salt command in raw Python
form, this is suitable for re\-reading the output into
an executing python script with eval.
an executing Python script with eval.
.UNINDENT
.INDENT 0.0
.TP
@ -83,22 +83,26 @@ form the shell would.
.INDENT 0.0
.TP
.B \-\-yaml\-out
Print the output from the salt command in yaml.
Print the output from the salt command in YAML.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-json\-out
Print the output from the salt command in json.
Print the output from the salt command in JSON.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt\-master(1)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

22
doc/man/salt-cp.1
View File

@ -1,4 +1,4 @@
.TH "SALT-CP" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-CP" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
Copy a file to a set of systems
@ -45,7 +45,7 @@ salt\-cp \-G \(aqos:Arch.*\(aq [ options ] SOURCE DEST
.fi
.SH DESCRIPTION
.sp
Salt copy copies a local file out to all of the salt minions matched by the
Salt copy copies a local file out to all of the Salt minions matched by the
given target.
.SH OPTIONS
.INDENT 0.0
@ -56,12 +56,12 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
The timeout in seconds to wait for replies from the Salt minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a pcre regular expression
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
@ -73,14 +73,14 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.INDENT 0.0
.TP
.B \-G, \-\-grain
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
.UNINDENT
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<pcre
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
@ -106,14 +106,18 @@ make sure that the compound target is encapsulated in quotes.
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the salt master configuration file, the salt master
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt\-master(1)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

11
doc/man/salt-key.1
View File

@ -1,4 +1,4 @@
.TH "SALT-KEY" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-KEY" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -28,14 +28,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
salt\-key [ options ]
.SH DESCRIPTION
.sp
Salt\-key executes simple management of salt server public keys used for
Salt\-key executes simple management of Salt server public keys used for
authentication.
.SH OPTIONS
.INDENT 0.0
@ -51,7 +51,7 @@ List the unaccepted minion public keys.
.INDENT 0.0
.TP
.B \-L, \-\-list\-all
List all public keys on this salt master: accepted, pending,
List all public keys on this Salt master: accepted, pending,
and rejected.
.UNINDENT
.INDENT 0.0
@ -87,7 +87,7 @@ Deleta all keys
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The master configuration file needs to be read to determine where the salt
The master configuration file needs to be read to determine where the Salt
keys are stored via the pki_dir configuration value;
default=/etc/salt/master
.UNINDENT
@ -96,5 +96,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

16
doc/man/salt-master.1
View File

@ -1,4 +1,4 @@
.TH "SALT-MASTER" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-MASTER" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
@ -28,16 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
The salt master daemon, used to control the salt minions
The Salt master daemon, used to control the Salt minions
.SH SYNOPSIS
.sp
salt\-master [ options ]
.SH DESCRIPTION
.sp
The master daemon controls the salt minions
The master daemon controls the Salt minions
.SH OPTIONS
.INDENT 0.0
.TP
@ -47,7 +47,7 @@ Print a usage message briefly summarizing these command\-line options.
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run the salt master as a daemon
Run the Salt master as a daemon
.UNINDENT
.INDENT 0.0
.TP
@ -71,10 +71,14 @@ Console log level. One of \fBinfo\fP, \fBnone\fP, \fBgarbage\fP,
\fBtrace\fP, \fBwarning\fP, \fBerror\fP, \fBdebug\fP. For the logfile
settings see the config file. Default: \fBwarning\fP.
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt(7)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

16
doc/man/salt-minion.1
View File

@ -1,4 +1,4 @@
.TH "SALT-MINION" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-MINION" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
@ -28,16 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
The salt minion daemon, receives commands from a remote salt master.
The Salt minion daemon, receives commands from a remote Salt master.
.SH SYNOPSIS
.sp
salt\-minion [ options ]
.SH DESCRIPTION
.sp
The salt minion receives commands from the central salt master and replies with
The Salt minion receives commands from the central Salt master and replies with
the results of said commands.
.SH OPTIONS
.INDENT 0.0
@ -48,7 +48,7 @@ Print a usage message briefly summarizing these command\-line options.
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run the salt minion as a daemon
Run the Salt minion as a daemon
.UNINDENT
.INDENT 0.0
.TP
@ -72,10 +72,14 @@ Console log level. One of \fBinfo\fP, \fBnone\fP, \fBgarbage\fP,
\fBtrace\fP, \fBwarning\fP, \fBerror\fP, \fBdebug\fP. For the logfile
settings see the config file. Default: \fBwarning\fP.
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt(7)\fP
\fIsalt\-master(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

12
doc/man/salt-run.1
View File

@ -1,4 +1,4 @@
.TH "SALT-RUN" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-RUN" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
Execute a Salt runner
@ -53,14 +53,18 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the salt master configuration file, the salt master
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt\-master(1)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

16
doc/man/salt-syndic.1
View File

@ -1,4 +1,4 @@
.TH "SALT-SYNDIC" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT-SYNDIC" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
@ -28,17 +28,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
The salt syndic daemon, a special minion that passes through commands from a
The Salt syndic daemon, a special minion that passes through commands from a
higher master
.SH SYNOPSIS
.sp
salt\-syndic [ options ]
.SH DESCRIPTION
.sp
The salt syndic daemon, a special minion that passes through commands from a
The Salt syndic daemon, a special minion that passes through commands from a
higher master.
.SH OPTIONS
.INDENT 0.0
@ -49,7 +49,7 @@ Print a usage message briefly summarizing these command\-line options.
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run the salt syndic as a daemon
Run the Salt syndic as a daemon
.UNINDENT
.INDENT 0.0
.TP
@ -66,10 +66,14 @@ The master configuration file to use, the default is /etc/salt/master
.B \-\-minion\-config=MINION_CONFIG
The minion configuration file to use, the default is /etc/salt/minion
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt\-master(1)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

27
doc/man/salt.1
View File

@ -1,4 +1,4 @@
.TH "SALT" "1" "April 27, 2012" "0.9.9" "Salt"
.TH "SALT" "1" "June 19, 2012" "0.10.1" "Salt"
.SH NAME
salt \- salt
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.INDENT 0.0
@ -58,7 +58,7 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
The timeout in seconds to wait for replies from the Salt minions.
.UNINDENT
.INDENT 0.0
.TP
@ -79,7 +79,7 @@ minions to execute on.
.INDENT 0.0
.TP
.B \-\-version
Print the version of salt that is running.
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
@ -96,7 +96,7 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.INDENT 0.0
.TP
.B \-G, \-\-grain
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
.sp
@ -107,7 +107,7 @@ the \-\-grain\-pcre option.
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
@ -128,7 +128,7 @@ Instead of using shell globs use the return code of a function.
.INDENT 0.0
.TP
.B \-N, \-\-nodegroup
Use a predefined compound target defined in the salt master configuration
Use a predefined compound target defined in the Salt master configuration
file
.UNINDENT
.INDENT 0.0
@ -152,7 +152,7 @@ but will be sent to the specified return system.
.TP
.B \-Q, \-\-query
The \-Q option is being deprecated and will be removed in version 0.9.9,
Use the salt jobs interface instead, for documentation on the salt jobs
Use the Salt jobs interface instead, for documentation on the Salt jobs
interface execute the command "salt\-run \-d jobs"
.sp
Execute a salt command query, this can be used to find the results of a
@ -161,16 +161,16 @@ previous function call: \-Q test.echo\(aq)
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the salt master configuration file, the salt master
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
.UNINDENT
.INDENT 0.0
.TP
.B \-\-raw\-out
Print the output from the salt command in raw python
Print the output from the salt command in raw Python
form, this is suitable for re\-reading the output into
an executing python script with eval.
an executing Python script with eval.
.UNINDENT
.INDENT 0.0
.TP
@ -181,12 +181,12 @@ form the shell would.
.INDENT 0.0
.TP
.B \-\-yaml\-out
Print the output from the salt command in yaml.
Print the output from the salt command in YAML.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-json\-out
Print the output from the salt command in json.
Print the output from the salt command in JSON.
.UNINDENT
.INDENT 0.0
.TP
@ -203,5 +203,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

5386
doc/man/salt.7
View File

File diff suppressed because it is too large Load Diff

2
doc/ref/cli/index.rst
View File

@ -21,7 +21,7 @@ environment variables ``SALT_MASTER_CONFIG`` and ``SALT_MINION_CONFIG``.
Using the Salt Command
======================
The Salt command needs a few components to send information to the salt
The Salt command needs a few components to send information to the Salt
minions. The target minions need to be defined, the function to call and any
arguments the function requires.

19
doc/ref/cli/salt-call.rst
View File

@ -20,7 +20,7 @@ Options
.. option:: -g, --grains
Return the information generated by the salt grains
Return the information generated by the Salt grains
.. option:: -m MODULE_DIRS, --module-dirs=MODULE_DIRS
@ -29,7 +29,7 @@ Options
.. option:: -d, --doc
Return the documentation for the specified module of for all modules if
Return the documentation for the specified module or for all modules if
none are specified
.. option:: -l LOG_LEVEL, --log-level=LOG_LEVEL
@ -40,9 +40,9 @@ Options
.. option:: --raw-out
Print the output from the salt command in raw python
Print the output from the salt command in raw Python
form, this is suitable for re-reading the output into
an executing python script with eval.
an executing Python script with eval.
.. option:: --text-out
@ -51,12 +51,19 @@ Options
.. option:: --yaml-out
Print the output from the salt command in yaml.
Print the output from the salt command in YAML.
.. option:: --json-out
Print the output from the salt command in json.
Print the output from the salt command in JSON.
.. option:: --no-color
Disable all colored output
See also
========
:manpage:`salt(1)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`

19
doc/ref/cli/salt-cp.rst
View File

@ -18,7 +18,7 @@ Synopsis
Description
===========
Salt copy copies a local file out to all of the salt minions matched by the
Salt copy copies a local file out to all of the Salt minions matched by the
given target.
Options
@ -32,11 +32,11 @@ Options
.. option:: -t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
The timeout in seconds to wait for replies from the Salt minions.
.. option:: -E, --pcre
The target expression will be interpreted as a pcre regular expression
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.. option:: -L, --list
@ -46,13 +46,13 @@ Options
.. option:: -G, --grain
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of '<grain value>:<glob
expression>'; example: 'os:Arch*'
.. option:: --grain-pcre
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of '<grain value>:<pcre
regular expression>'; example: 'os:Arch.*'
@ -75,6 +75,13 @@ Options
.. option:: -c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
See also
========
:manpage:`salt(1)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`

6
doc/ref/cli/salt-key.rst
View File

@ -10,7 +10,7 @@ salt-key [ options ]
Description
===========
Salt-key executes simple management of salt server public keys used for
Salt-key executes simple management of Salt server public keys used for
authentication.
Options
@ -28,7 +28,7 @@ Options
.. option:: -L, --list-all
List all public keys on this salt master: accepted, pending,
List all public keys on this Salt master: accepted, pending,
and rejected.
.. option:: -a ACCEPT, --accept=ACCEPT
@ -57,6 +57,6 @@ Options
.. option:: -c CONFIG, --config=CONFIG
The master configuration file needs to be read to determine where the salt
The master configuration file needs to be read to determine where the Salt
keys are stored via the pki_dir configuration value;
default=/etc/salt/master

13
doc/ref/cli/salt-master.rst
View File

@ -2,7 +2,7 @@
``salt-master``
===============
The salt master daemon, used to control the salt minions
The Salt master daemon, used to control the Salt minions
Synopsis
========
@ -12,7 +12,7 @@ salt-master [ options ]
Description
===========
The master daemon controls the salt minions
The master daemon controls the Salt minions
Options
=======
@ -25,7 +25,7 @@ Options
.. option:: -d, --daemon
Run the salt master as a daemon
Run the Salt master as a daemon
.. option:: -c CONFIG, --config=CONFIG
@ -44,3 +44,10 @@ Options
Console log level. One of ``info``, ``none``, ``garbage``,
``trace``, ``warning``, ``error``, ``debug``. For the logfile
settings see the config file. Default: ``warning``.
See also
========
:manpage:`salt(1)`
:manpage:`salt(7)`
:manpage:`salt-minion(1)`

13
doc/ref/cli/salt-minion.rst
View File

@ -2,7 +2,7 @@
``salt-minion``
===============
The salt minion daemon, receives commands from a remote salt master.
The Salt minion daemon, receives commands from a remote Salt master.
Synopsis
========
@ -12,7 +12,7 @@ salt-minion [ options ]
Description
===========
The salt minion receives commands from the central salt master and replies with
The Salt minion receives commands from the central Salt master and replies with
the results of said commands.
Options
@ -26,7 +26,7 @@ Options
.. option:: -d, --daemon
Run the salt minion as a daemon
Run the Salt minion as a daemon
.. option:: -c CONFIG, --config=CONFIG
@ -45,3 +45,10 @@ Options
Console log level. One of ``info``, ``none``, ``garbage``,
``trace``, ``warning``, ``error``, ``debug``. For the logfile
settings see the config file. Default: ``warning``.
See also
========
:manpage:`salt(1)`
:manpage:`salt(7)`
:manpage:`salt-master(1)`

9
doc/ref/cli/salt-run.rst
View File

@ -29,6 +29,13 @@ Options
.. option:: -c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
See also
========
:manpage:`salt(1)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`

13
doc/ref/cli/salt-syndic.rst
View File

@ -2,7 +2,7 @@
``salt-syndic``
===============
The salt syndic daemon, a special minion that passes through commands from a
The Salt syndic daemon, a special minion that passes through commands from a
higher master
Synopsis
@ -13,7 +13,7 @@ salt-syndic [ options ]
Description
===========
The salt syndic daemon, a special minion that passes through commands from a
The Salt syndic daemon, a special minion that passes through commands from a
higher master.
Options
@ -27,7 +27,7 @@ Options
.. option:: -d, --daemon
Run the salt syndic as a daemon
Run the Salt syndic as a daemon
.. option:: --pid-file PIDFILE
@ -40,3 +40,10 @@ Options
.. option:: --minion-config=MINION_CONFIG
The minion configuration file to use, the default is /etc/salt/minion
See also
========
:manpage:`salt(1)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`

22
doc/ref/cli/salt.rst
View File

@ -33,7 +33,7 @@ Options
.. option:: -t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
The timeout in seconds to wait for replies from the Salt minions.
.. option:: -s STATIC, --static=STATIC
@ -51,7 +51,7 @@ Options
.. option:: --version
Print the version of salt that is running.
Print the version of Salt that is running.
.. option:: -E, --pcre
@ -65,7 +65,7 @@ Options
.. option:: -G, --grain
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of '<grain value>:<glob
expression>'; example: 'os:Arch*'
@ -75,7 +75,7 @@ Options
.. option:: --grain-pcre
The target expression matches values returned by the salt grains system on
The target expression matches values returned by the Salt grains system on
the minions. The target expression is in the format of '<grain value>:<
regular expression>'; example: 'os:Arch.*'
@ -93,7 +93,7 @@ Options
.. option:: -N, --nodegroup
Use a predefined compound target defined in the salt master configuration
Use a predefined compound target defined in the Salt master configuration
file
.. option:: -R, --range
@ -114,7 +114,7 @@ Options
.. option:: -Q, --query
The -Q option is being deprecated and will be removed in version 0.9.9,
Use the salt jobs interface instead, for documentation on the salt jobs
Use the Salt jobs interface instead, for documentation on the Salt jobs
interface execute the command "salt-run -d jobs"
Execute a salt command query, this can be used to find the results of a
@ -122,15 +122,15 @@ Options
.. option:: -c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
.. option:: --raw-out
Print the output from the salt command in raw python
Print the output from the salt command in raw Python
form, this is suitable for re-reading the output into
an executing python script with eval.
an executing Python script with eval.
.. option:: --text-out
@ -139,11 +139,11 @@ Options
.. option:: --yaml-out
Print the output from the salt command in yaml.
Print the output from the salt command in YAML.
.. option:: --json-out
Print the output from the salt command in json.
Print the output from the salt command in JSON.
.. option:: --no-color

67
doc/ref/configuration/master.rst
View File

@ -45,7 +45,7 @@ The network port to set up the publication interface
.. conf_master:: user
``user``
----------------
--------
Default: ``root``
@ -134,6 +134,20 @@ Default: ``24``
Set the number of hours to keep old job information
.. conf_master:: job_cache
``job_cache``
-------------
Default: ``True``
The master maintains a job cache, while this is a great addition it can be
a burden on the master for larger deployments (over 5000 minions).
Disabling the job cache will make previously executed jobs unavailable to
the jobs system and is not generally recommended. Normally it is wise to make
sure the master has access to a faster IO system or a tmpfs is mounted to the
jobs dir
.. conf_master:: sock_dir
``sock_dir``
@ -180,6 +194,33 @@ public keys from the minions
auto_accept: False
Master Module Management
------------------------
.. conf_master:: runner_dirs
``runner_dirs``
---------------
Default: ``[]``
Set additional directories to search for runner modules
.. conf_master:: cython_enable
``cython_enable``
-----------------
Default: ``False``
Set to true to enable cython modules (.pyx files) to be compiled on the fly on
the Salt master
.. code-block:: yaml
cython_enable: False
Master State System Settings
----------------------------
@ -269,6 +310,7 @@ Default: ``base: [/srv/salt]``
Salt runs a lightweight file server written in zeromq to deliver files to
minions. This file server is built into the master daemon and does not
require a dedicated port.
The file server works on environments passed to the master. Each environment
can have multiple root directories. The subdirectories in the multiple file
roots cannot match, otherwise the downloaded files will not be able to be
@ -443,6 +485,27 @@ This will allow all minions to execute all commands:
This is not recommended, since it would allow anyone who gets root on any
single minion to instantly have root on all of the minions!
.. conf_master:: peer_run
``peer_run``
------------
Default: ``{}``
The peer_run option is used to open up runners on the master to access from the
minions. The peer_run configuration matches the format of the peer
configuration.
The following example would allow foo.example.com to execute the manage.up
runner:
.. code-block:: yaml
peer_run:
foo.example.com:
- manage.up
Node Groups
-----------
@ -497,7 +560,7 @@ One of 'info', 'quiet', 'critical', 'error', 'debug', 'warning'.
Default: ``{}``
Logger levels can be used to tweak specific loggers logging levels.
Imagine you want to have the salt library at the 'warning' level, but you
Imagine you want to have the Salt library at the 'warning' level, but you
still wish to have 'salt.modules' at the 'debug' level:
.. code-block:: yaml

38
doc/ref/configuration/minion.rst
View File

@ -37,7 +37,7 @@ The hostname or ipv4 of the master.
Default: ``4506``
The port of the master ret server, this needs to coincide with the ret_port
option on the salt master.
option on the Salt master.
.. code-block:: yaml
@ -46,7 +46,7 @@ option on the salt master.
.. conf_minion:: user
``user``
----------------
--------
Default: ``root``
@ -72,14 +72,14 @@ The directory used to store the minion's public and private keys.
.. conf_minion:: id
``id``
------------
------
Default: hostname (as returned by the Python call: ``socket.getfqdn()``)
Explicitly declare the id for this minion to use, if left commented the id
will be the hostname as returned by the python call: socket.getfqdn()
Since salt uses detached ids it is possible to run multiple minions on the
same machine but with different ids, this can be useful for salt compute
will be the hostname as returned by the Python call: ``socket.getfqdn()``
Since Salt uses detached ids it is possible to run multiple minions on the
same machine but with different ids, this can be useful for Salt compute
clusters.
.. code-block:: yaml
@ -186,7 +186,7 @@ If certain returners should be disabled, this is the place
Default: ``[]``
A list of extra directories to search for salt modules
A list of extra directories to search for Salt modules
.. code-block:: yaml
@ -200,7 +200,7 @@ A list of extra directories to search for salt modules
Default: ``[]``
A list of extra directories to search for salt returners
A list of extra directories to search for Salt returners
.. code-block:: yaml
@ -214,7 +214,7 @@ A list of extra directories to search for salt returners
Default: ``[]``
A list of extra directories to search for salt states
A list of extra directories to search for Salt states
.. code-block:: yaml
@ -229,7 +229,7 @@ A list of extra directories to search for salt states
Default: ``[]``
A list of extra directories to search for salt renderers
A list of extra directories to search for Salt renderers
.. code-block:: yaml
@ -243,8 +243,8 @@ A list of extra directories to search for salt renderers
Default: ``False``
Set this value to true to enable auto loading and compiling of .pyx modules,
This setting requires that gcc and cython are installed on the minion
Set this value to true to enable auto-loading and compiling of ``.pyx`` modules,
This setting requires that ``gcc`` and ``cython`` are installed on the minion
.. code-block:: yaml
@ -275,7 +275,7 @@ Default: ``False``
state_verbose allows for the data returned from the minion to be more
verbose. Normally only states that fail or states that have changes are
returned, but setting state_verbose to True will return all states that
returned, but setting state_verbose to ``True`` will return all states that
were checked
.. code-block:: yaml
@ -291,7 +291,7 @@ Default: ``True``
autoload_dynamic_modules Turns on automatic loading of modules found in the
environments on the master. This is turned on by default, to turn of
autoloading modules when states run set this value to False
autoloading modules when states run set this value to ``False``
.. code-block:: yaml
@ -304,7 +304,7 @@ Default: ``True``
clean_dynamic_modules keeps the dynamic modules on the minion in sync with
the dynamic modules on the master, this means that if a dynamic module is
not on the master it will be deleted from the minion. By default this is
enabled and can be disabled by changing this value to False
enabled and can be disabled by changing this value to ``False``
.. code-block:: yaml
@ -327,7 +327,7 @@ environments is to isolate via the top file.
environment: None
Security Settings
------------------
-----------------
.. conf_minion:: open_mode
@ -336,7 +336,7 @@ Security Settings
Default: ``False``
Open mode can be used to clean out the pki key received from the salt master,
Open mode can be used to clean out the PKI key received from the Salt master,
turn on open mode, restart the minion, then turn off open mode and restart the
minion to clean the keys.
@ -351,7 +351,7 @@ Thread Settings
Default: ``True``
Disable multiprocessing support, by default when a minion receives a
Disable multiprocessing support by default when a minion receives a
publication a new process is spawned and the command is executed therein.
.. code-block:: yaml
@ -396,7 +396,7 @@ One of 'info', 'quiet', 'critical', 'error', 'debug', 'warning'.
Default: ``{}``
Logger levels can be used to tweak specific loggers logging levels.
Imagine you want to have the salt library at the 'warning' level, but, you
Imagine you want to have the Salt library at the 'warning' level, but, you
still wish to have 'salt.modules' at the 'debug' level:
.. code-block:: yaml

11
doc/ref/file_server/dynamic-modules.rst
View File

@ -4,7 +4,7 @@ Dynamic Module Distribution
.. versionadded:: 0.9.5
Salt python modules can be distributed automatically via the salt file server.
Salt Python modules can be distributed automatically via the Salt file server.
Under the root of any environment defined via the file_roots option on the
master server directories corresponding to the type of module can be used.
@ -17,7 +17,7 @@ The directories are prepended with an underscore:
5. _states
The contents of these directories need to be synced over to the minions after
python modules have been created in them. There are a number of ways to sync
Python modules have been created in them. There are a number of ways to sync
the modules.
Sync Via States
@ -28,6 +28,13 @@ which defaults to True. This option makes the state system refresh all
dynamic modules when states are run. To disable this behavior set
``autoload_dynamic_modules`` to False in the minion config.
When dynamic modules are autoloaded via states, modules only pertinent to
the environments matched in the master's top file are downloaded.
This is important to remember, because modules can be manually loaded from
any specific environment that environment specific modules will be loaded
when a state run is executed.
Sync Via the saltutil Module
============================

4
doc/ref/file_server/file_roots.rst
View File

@ -43,7 +43,7 @@ are listed. In the case of this ``file_roots`` configuration:
- /srv/salt/base
- /srv/salt/failover
If a file's uri is ``salt://httpd/httpd.conf``, it will first search for the
If a file's URI is ``salt://httpd/httpd.conf``, it will first search for the
file at ``/srv/salt/base/httpd/httpd.conf``. If the file is found there it
will be returned. If the file is not found there, then
``/srv/salt/failover/httpd/httpd.conf`` will be used for the source.
@ -58,7 +58,7 @@ Local File Server
The file server can be rerouted to run from the minion. This is primarily to
enable running salt states without a salt master. To use the local file server
enable running Salt states without a Salt master. To use the local file server
interface, copy the file server data to the minion and set the file_roots
option on the minion to point to the directories copied from the master.
Once the minion ``file_roots`` option has been set, change the ``file_client``

12
doc/ref/file_server/index.rst
View File

@ -3,10 +3,10 @@ Salt File Server
================
Salt comes with a simple file server suitable for distributing files to the
salt minions. The file server is a stateless ZeroMQ server that is built into
the salt master.
Salt minions. The file server is a stateless ZeroMQ server that is built into
the Salt master.
The main intent of the Salt File server is to present files for use in the
The main intent of the Salt file server is to present files for use in the
Salt state system. With this said, the Salt file server can be used for any
general file transfer from the master to the minions.
@ -35,7 +35,7 @@ the master, the syntax looks like this:
# salt '*' cp.get_file salt://vimrc /etc/vimrc
This will instruct all salt minions to download the vimrc file and copy it
This will instruct all Salt minions to download the vimrc file and copy it
to /etc/vimrc
File Server Client API
@ -61,7 +61,7 @@ built in ``__opts__`` data can be passed:
def get_file(path, dest, env='base'):
'''
Used to get a single file from the salt master
Used to get a single file from the Salt master
CLI Example:
salt '*' cp.get_file salt://vimrc /etc/vimrc
@ -81,7 +81,7 @@ data is not available, it needs to be generated:
def get_file(path, dest, env='base'):
'''
Used to get a single file from the salt master
Used to get a single file from the Salt master
'''
# Get the configuration data
opts = salt.config.minion_config('/etc/salt/minion')

24
doc/ref/index.rst
View File

@ -14,7 +14,7 @@ so much more.
Client API
----------
The primary interface used to extend salt, is to simply use it. Salt executions
The primary interface used to extend Salt, is to simply use it. Salt executions
can be called via the Salt client api, making programming master side solutions
with Salt is easy.
@ -22,7 +22,7 @@ Adding Loadable Plugins
-----------------------
Salt is comprised of a core platform that loads many types of easy to write
plugins. The idea is to enable all of the breaking points in the salt processes
plugins. The idea is to enable all of the breaking points in the Salt processes
to have a point of pluggable interaction. This means that all of the main
features of Salt can be extended, modified or used.
@ -32,14 +32,14 @@ executions to manipulating the flow of how data is handled by Salt.
Minion Execution Modules
````````````````````````
The minion execution modules or just ``modules`` are the core to what salt is
The minion execution modules or just ``modules`` are the core to what Salt is
and does. These modules are found in:
:blob:`salt/modules`
These modules are what is called by the salt command line and the salt client
api. Adding modules is done by simply adding additional python modules to the
modules directory and restarting the minion.
These modules are what is called by the Salt command line and the salt client
API. Adding modules is done by simply adding additional Python modules to the
*modules* directory and restarting the minion.
Grains
``````
@ -50,7 +50,7 @@ what package manager to default to, or where certain configuration files are
stored on the minion.
The Salt grains are the interface used for auto detection and dynamic assignment
of execution modules and types to specific salt minions.
of execution modules and types to specific Salt minions.
The code used to generate the Salt grains can be found here:
@ -82,10 +82,10 @@ The existing renderers can be found here:
Returners
`````````
The salt commands all produce a return value, that return value is sent to the
salt master by default, but it can be sent anywhere. The returner interface
The Salt commands all produce a return value, that return value is sent to the
Salt master by default, but it can be sent anywhere. The returner interface
makes it programmatically possible for the information to be sent to anything
from an SQL or NOSQL database, to a custom application made to use Salt.
from an SQL or NoSQL database, to a custom application made to use Salt.
The existing returners can be found here:
@ -95,8 +95,8 @@ Runners
```````
Sometimes a certain application can be made to execute and run from the
existing salt command line. This is where the salt runners come into play.
The Salt Runners what is called by the salt-run command and are meant to
existing Salt command line. This is where the Salt runners come into play.
The Salt Runners what is called by the Salt-run command and are meant to
act as a generic interface for encapsulating master side executions.
Existing Salt runners are located here:

14
doc/ref/modules/all/index.rst
View File

@ -15,11 +15,12 @@ Full list of builtin modules
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
aliases
apache
apt
archive
brew
butterkvm
cluster
cmdmod
@ -28,8 +29,10 @@ Full list of builtin modules
data
debconfmod
disk
django
ebuild
file
freebsdjail
freebsdkmod
freebsdpkg
freebsdservice
@ -38,10 +41,12 @@ Full list of builtin modules
git
grains
groupadd
grub
hg
hosts
kmod
kvm_hyper
launchctl
linux_sysctl
mdadm
moosefs
@ -49,14 +54,18 @@ Full list of builtin modules
mysql
network
nginx
osxdesktop
pacman
pillar
pip
postgres
ps
publish
puppet
pw_group
pw_user
rabbitmq_server
reg
rh_ip
rh_service
rvm
@ -65,6 +74,7 @@ Full list of builtin modules
service
shadow
solr
sqlite3
ssh
state
status
@ -77,7 +87,9 @@ Full list of builtin modules
virtualenv
win_disk
win_file
win_groupadd
win_network
win_pkg
win_service
win_shadow
win_useradd

44
doc/ref/modules/all/salt.modules.aliases.rst Normal file
View File

@ -0,0 +1,44 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.aliases
====================
.. automodule:: salt.modules.aliases
.. rubric:: Members
get_target
============================================================
.. autofunction:: get_target
has_target
============================================================
.. autofunction:: has_target
list_aliases
============================================================
.. autofunction:: list_aliases
rm_alias
============================================================
.. autofunction:: rm_alias
set_target
============================================================
.. autofunction:: set_target

52
doc/ref/modules/all/salt.modules.apache.rst
View File

@ -1,6 +1,56 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.apache
===================
.. automodule:: salt.modules.apache
:members:
.. rubric:: Members
directives
=========================================================
.. autofunction:: directives
fullversion
=========================================================
.. autofunction:: fullversion
modules
=========================================================
.. autofunction:: modules
servermods
=========================================================
.. autofunction:: servermods
signal
=========================================================
.. autofunction:: signal
version
=========================================================
.. autofunction:: version
vhosts
=========================================================
.. autofunction:: vhosts

70
doc/ref/modules/all/salt.modules.apt.rst
View File

@ -1,6 +1,74 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
================
salt.modules.apt
================
.. automodule:: salt.modules.apt
:members:
.. rubric:: Members
available_version
================================================
.. autofunction:: available_version
install
================================================
.. autofunction:: install
list_pkgs
================================================
.. autofunction:: list_pkgs
list_upgrades
================================================
.. autofunction:: list_upgrades
purge
================================================
.. autofunction:: purge
refresh_db
================================================
.. autofunction:: refresh_db
remove
================================================
.. autofunction:: remove
upgrade
================================================
.. autofunction:: upgrade
upgrade_available
================================================
.. autofunction:: upgrade_available
version
================================================
.. autofunction:: version

52
doc/ref/modules/all/salt.modules.archive.rst
View File

@ -1,6 +1,56 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.archive
====================
.. automodule:: salt.modules.archive
:members:
.. rubric:: Members
gunzip
============================================================
.. autofunction:: gunzip
gzip
============================================================
.. autofunction:: gzip
rar
============================================================
.. autofunction:: rar
tar
============================================================
.. autofunction:: tar
unrar
============================================================
.. autofunction:: unrar
unzip
============================================================
.. autofunction:: unzip
zip
============================================================
.. autofunction:: zip

50
doc/ref/modules/all/salt.modules.brew.rst Normal file
View File

@ -0,0 +1,50 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.brew
=================
.. automodule:: salt.modules.brew
.. rubric:: Members
install
===================================================
.. autofunction:: install
list_pkgs
===================================================
.. autofunction:: list_pkgs
list_upgrades
===================================================
.. autofunction:: list_upgrades
remove
===================================================
.. autofunction:: remove
upgrade_available
===================================================
.. autofunction:: upgrade_available
version
===================================================
.. autofunction:: version

34
doc/ref/modules/all/salt.modules.butterkvm.rst
View File

@ -1,6 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
======================
salt.modules.butterkvm
======================
.. automodule:: salt.modules.butterkvm
:members:
.. rubric:: Members
create
==================================================================
.. autofunction:: create
full_butter_data
==================================================================
.. autofunction:: full_butter_data
libvirt_creds
==================================================================
.. autofunction:: libvirt_creds
local_images
==================================================================
.. autofunction:: local_images

16
doc/ref/modules/all/salt.modules.cluster.rst
View File

@ -1,6 +1,20 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.cluster
====================
.. automodule:: salt.modules.cluster
:members:
.. rubric:: Members
distrib
============================================================
.. autofunction:: distrib

76
doc/ref/modules/all/salt.modules.cmdmod.rst
View File

@ -1,6 +1,74 @@
================
salt.modules.cmd
================
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.cmdmod
===================
.. automodule:: salt.modules.cmdmod
:members:
.. rubric:: Members
exec_code
=========================================================
.. autofunction:: exec_code
has_exec
=========================================================
.. autofunction:: has_exec
retcode
=========================================================
.. autofunction:: retcode
run
=========================================================
.. autofunction:: run
run_all
=========================================================
.. autofunction:: run_all
run_stderr
=========================================================
.. autofunction:: run_stderr
run_stdout
=========================================================
.. autofunction:: run_stdout
shell_grain
=========================================================
.. autofunction:: shell_grain
which
=========================================================
.. autofunction:: which
which_bin
=========================================================
.. autofunction:: which_bin

100
doc/ref/modules/all/salt.modules.cp.rst
View File

@ -1,6 +1,104 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===============
salt.modules.cp
===============
.. automodule:: salt.modules.cp
:members:
.. rubric:: Members
cache_dir
=============================================
.. autofunction:: cache_dir
cache_file
=============================================
.. autofunction:: cache_file
cache_files
=============================================
.. autofunction:: cache_files
cache_local_file
=============================================
.. autofunction:: cache_local_file
cache_master
=============================================
.. autofunction:: cache_master
get_dir
=============================================
.. autofunction:: get_dir
get_file
=============================================
.. autofunction:: get_file
get_template
=============================================
.. autofunction:: get_template
get_url
=============================================
.. autofunction:: get_url
hash_file
=============================================
.. autofunction:: hash_file
is_cached
=============================================
.. autofunction:: is_cached
list_master
=============================================
.. autofunction:: list_master
list_minion
=============================================
.. autofunction:: list_minion
list_states
=============================================
.. autofunction:: list_states
recv
=============================================
.. autofunction:: recv

64
doc/ref/modules/all/salt.modules.cron.rst
View File

@ -1,6 +1,68 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.cron
=================
.. automodule:: salt.modules.cron
:members:
.. rubric:: Members
list_tab
===================================================
.. autofunction:: list_tab
ls
===================================================
.. autofunction:: ls
raw_cron
===================================================
.. autofunction:: raw_cron
rm
===================================================
.. autofunction:: rm
rm_env
===================================================
.. autofunction:: rm_env
rm_job
===================================================
.. autofunction:: rm_job
set_env
===================================================
.. autofunction:: set_env
set_job
===================================================
.. autofunction:: set_job
set_special
===================================================
.. autofunction:: set_special

46
doc/ref/modules/all/salt.modules.data.rst
View File

@ -1,6 +1,50 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.data
=================
.. automodule:: salt.modules.data
:members:
.. rubric:: Members
clear
===================================================
.. autofunction:: clear
dump
===================================================
.. autofunction:: dump
getval
===================================================
.. autofunction:: getval
getvals
===================================================
.. autofunction:: getvals
load
===================================================
.. autofunction:: load
update
===================================================
.. autofunction:: update

34
doc/ref/modules/all/salt.modules.debconfmod.rst
View File

@ -1,6 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=======================
salt.modules.debconfmod
=======================
.. automodule:: salt.modules.debconfmod
:members:
.. rubric:: Members
get_selections
=====================================================================
.. autofunction:: get_selections
set
=====================================================================
.. autofunction:: set
set_file
=====================================================================
.. autofunction:: set_file
show
=====================================================================
.. autofunction:: show

22
doc/ref/modules/all/salt.modules.disk.rst
View File

@ -1,6 +1,26 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.disk
=================
.. automodule:: salt.modules.disk
:members:
.. rubric:: Members
inodeusage
===================================================
.. autofunction:: inodeusage
usage
===================================================
.. autofunction:: usage

44
doc/ref/modules/all/salt.modules.django.rst Normal file
View File

@ -0,0 +1,44 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.django
===================
.. automodule:: salt.modules.django
.. rubric:: Members
collectstatic
=========================================================
.. autofunction:: collectstatic
command
=========================================================
.. autofunction:: command
createsuperuser
=========================================================
.. autofunction:: createsuperuser
loaddata
=========================================================
.. autofunction:: loaddata
syncdb
=========================================================
.. autofunction:: syncdb

64
doc/ref/modules/all/salt.modules.ebuild.rst
View File

@ -1,6 +1,68 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.ebuild
===================
.. automodule:: salt.modules.ebuild
:members:
.. rubric:: Members
available_version
=========================================================
.. autofunction:: available_version
install
=========================================================
.. autofunction:: install
list_pkgs
=========================================================
.. autofunction:: list_pkgs
purge
=========================================================
.. autofunction:: purge
refresh_db
=========================================================
.. autofunction:: refresh_db
remove
=========================================================
.. autofunction:: remove
update
=========================================================
.. autofunction:: update
upgrade
=========================================================
.. autofunction:: upgrade
version
=========================================================
.. autofunction:: version

148
doc/ref/modules/all/salt.modules.file.rst
View File

@ -1,6 +1,152 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.file
=================
.. automodule:: salt.modules.file
:members:
.. rubric:: Members
append
===================================================
.. autofunction:: append
chgrp
===================================================
.. autofunction:: chgrp
chown
===================================================
.. autofunction:: chown
comment
===================================================
.. autofunction:: comment
contains
===================================================
.. autofunction:: contains
contains_glob
===================================================
.. autofunction:: contains_glob
contains_regex
===================================================
.. autofunction:: contains_regex
find
===================================================
.. autofunction:: find
get_gid
===================================================
.. autofunction:: get_gid
get_group
===================================================
.. autofunction:: get_group
get_mode
===================================================
.. autofunction:: get_mode
get_sum
===================================================
.. autofunction:: get_sum
get_uid
===================================================
.. autofunction:: get_uid
get_user
===================================================
.. autofunction:: get_user
gid_to_group
===================================================
.. autofunction:: gid_to_group
group_to_gid
===================================================
.. autofunction:: group_to_gid
sed
===================================================
.. autofunction:: sed
set_mode
===================================================
.. autofunction:: set_mode
stats
===================================================
.. autofunction:: stats
touch
===================================================
.. autofunction:: touch
uid_to_user
===================================================
.. autofunction:: uid_to_user
uncomment
===================================================
.. autofunction:: uncomment
user_to_uid
===================================================
.. autofunction:: user_to_uid

68
doc/ref/modules/all/salt.modules.freebsdjail.rst Normal file
View File

@ -0,0 +1,68 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
========================
salt.modules.freebsdjail
========================
.. automodule:: salt.modules.freebsdjail
.. rubric:: Members
fstab
========================================================================
.. autofunction:: fstab
get_enabled
========================================================================
.. autofunction:: get_enabled
is_enabled
========================================================================
.. autofunction:: is_enabled
restart
========================================================================
.. autofunction:: restart
show_config
========================================================================
.. autofunction:: show_config
start
========================================================================
.. autofunction:: start
status
========================================================================
.. autofunction:: status
stop
========================================================================
.. autofunction:: stop
sysctl
========================================================================
.. autofunction:: sysctl

40
doc/ref/modules/all/salt.modules.freebsdkmod.rst
View File

@ -1,6 +1,44 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
========================
salt.modules.freebsdkmod
========================
.. automodule:: salt.modules.freebsdkmod
:members:
.. rubric:: Members
available
========================================================================
.. autofunction:: available
check_available
========================================================================
.. autofunction:: check_available
load
========================================================================
.. autofunction:: load
lsmod
========================================================================
.. autofunction:: lsmod
remove
========================================================================
.. autofunction:: remove

70
doc/ref/modules/all/salt.modules.freebsdpkg.rst
View File

@ -1,6 +1,74 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=======================
salt.modules.freebsdpkg
=======================
.. automodule:: salt.modules.freebsdpkg
:members:
.. rubric:: Members
available_version
=====================================================================
.. autofunction:: available_version
install
=====================================================================
.. autofunction:: install
list_pkgs
=====================================================================
.. autofunction:: list_pkgs
purge
=====================================================================
.. autofunction:: purge
refresh_db
=====================================================================
.. autofunction:: refresh_db
rehash
=====================================================================
.. autofunction:: rehash
remove
=====================================================================
.. autofunction:: remove
search
=====================================================================
.. autofunction:: search
upgrade
=====================================================================
.. autofunction:: upgrade
version
=====================================================================
.. autofunction:: version

52
doc/ref/modules/all/salt.modules.freebsdservice.rst
View File

@ -1,6 +1,56 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===========================
salt.modules.freebsdservice
===========================
.. automodule:: salt.modules.freebsdservice
:members:
.. rubric:: Members
get_all
=================================================================================
.. autofunction:: get_all
get_disabled
=================================================================================
.. autofunction:: get_disabled
get_enabled
=================================================================================
.. autofunction:: get_enabled
restart
=================================================================================
.. autofunction:: restart
start
=================================================================================
.. autofunction:: start
status
=================================================================================
.. autofunction:: status
stop
=================================================================================
.. autofunction:: stop

58
doc/ref/modules/all/salt.modules.gem.rst
View File

@ -1,6 +1,62 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
================
salt.modules.gem
================
.. automodule:: salt.modules.gem
:members:
.. rubric:: Members
install
================================================
.. autofunction:: install
list
================================================
.. autofunction:: list
sources_add
================================================
.. autofunction:: sources_add
sources_list
================================================
.. autofunction:: sources_list
sources_remove
================================================
.. autofunction:: sources_remove
uninstall
================================================
.. autofunction:: uninstall
update
================================================
.. autofunction:: update
update_system
================================================
.. autofunction:: update_system

76
doc/ref/modules/all/salt.modules.gentoo_service.rst
View File

@ -1,6 +1,80 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===========================
salt.modules.gentoo_service
===========================
.. automodule:: salt.modules.gentoo_service
:members:
.. rubric:: Members
disable
=================================================================================
.. autofunction:: disable
disabled
=================================================================================
.. autofunction:: disabled
enable
=================================================================================
.. autofunction:: enable
enabled
=================================================================================
.. autofunction:: enabled
get_all
=================================================================================
.. autofunction:: get_all
get_disabled
=================================================================================
.. autofunction:: get_disabled
get_enabled
=================================================================================
.. autofunction:: get_enabled
restart
=================================================================================
.. autofunction:: restart
start
=================================================================================
.. autofunction:: start
status
=================================================================================
.. autofunction:: status
stop
=================================================================================
.. autofunction:: stop

70
doc/ref/modules/all/salt.modules.git.rst
View File

@ -1,6 +1,74 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
================
salt.modules.git
================
.. automodule:: salt.modules.git
:members:
.. rubric:: Members
archive
================================================
.. autofunction:: archive
checkout
================================================
.. autofunction:: checkout
clone
================================================
.. autofunction:: clone
describe
================================================
.. autofunction:: describe
fetch
================================================
.. autofunction:: fetch
init
================================================
.. autofunction:: init
merge
================================================
.. autofunction:: merge
pull
================================================
.. autofunction:: pull
rebase
================================================
.. autofunction:: rebase
revision
================================================
.. autofunction:: revision

28
doc/ref/modules/all/salt.modules.grains.rst
View File

@ -1,6 +1,32 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.grains
===================
.. automodule:: salt.modules.grains
:members:
.. rubric:: Members
item
=========================================================
.. autofunction:: item
items
=========================================================
.. autofunction:: items
ls
=========================================================
.. autofunction:: ls

40
doc/ref/modules/all/salt.modules.groupadd.rst
View File

@ -1,6 +1,44 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=====================
salt.modules.groupadd
=====================
.. automodule:: salt.modules.groupadd
:members:
.. rubric:: Members
add
===============================================================
.. autofunction:: add
chgid
===============================================================
.. autofunction:: chgid
delete
===============================================================
.. autofunction:: delete
getent
===============================================================
.. autofunction:: getent
info
===============================================================
.. autofunction:: info

26
doc/ref/modules/all/salt.modules.grub.rst Normal file
View File

@ -0,0 +1,26 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.grub
=================
.. automodule:: salt.modules.grub
.. rubric:: Members
conf
===================================================
.. autofunction:: conf
version
===================================================
.. autofunction:: version

46
doc/ref/modules/all/salt.modules.hg.rst
View File

@ -1,6 +1,50 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===============
salt.modules.hg
===============
.. automodule:: salt.modules.hg
:members:
.. rubric:: Members
archive
=============================================
.. autofunction:: archive
clone
=============================================
.. autofunction:: clone
describe
=============================================
.. autofunction:: describe
pull
=============================================
.. autofunction:: pull
revision
=============================================
.. autofunction:: revision
update
=============================================
.. autofunction:: update

52
doc/ref/modules/all/salt.modules.hosts.rst
View File

@ -1,6 +1,56 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
==================
salt.modules.hosts
==================
.. automodule:: salt.modules.hosts
:members:
.. rubric:: Members
add_host
======================================================
.. autofunction:: add_host
get_alias
======================================================
.. autofunction:: get_alias
get_ip
======================================================
.. autofunction:: get_ip
has_pair
======================================================
.. autofunction:: has_pair
list_hosts
======================================================
.. autofunction:: list_hosts
rm_host
======================================================
.. autofunction:: rm_host
set_host
======================================================
.. autofunction:: set_host

40
doc/ref/modules/all/salt.modules.kmod.rst
View File

@ -1,6 +1,44 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=================
salt.modules.kmod
=================
.. automodule:: salt.modules.kmod
:members:
.. rubric:: Members
available
===================================================
.. autofunction:: available
check_available
===================================================
.. autofunction:: check_available
load
===================================================
.. autofunction:: load
lsmod
===================================================
.. autofunction:: lsmod
remove
===================================================
.. autofunction:: remove

100
doc/ref/modules/all/salt.modules.kvm_hyper.rst
View File

@ -1,6 +1,104 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
======================
salt.modules.kvm_hyper
======================
.. automodule:: salt.modules.kvm_hyper
:members:
.. rubric:: Members
freecpu
==================================================================
.. autofunction:: freecpu
freemem
==================================================================
.. autofunction:: freemem
get_conf
==================================================================
.. autofunction:: get_conf
get_disks
==================================================================
.. autofunction:: get_disks
halt
==================================================================
.. autofunction:: halt
hyper_info
==================================================================
.. autofunction:: hyper_info
hyper_type
==================================================================
.. autofunction:: hyper_type
init
==================================================================
.. autofunction:: init
list_virts
==================================================================
.. autofunction:: list_virts
pause
==================================================================
.. autofunction:: pause
purge
==================================================================
.. autofunction:: purge
resume
==================================================================
.. autofunction:: resume
set_autostart
==================================================================
.. autofunction:: set_autostart
start
==================================================================
.. autofunction:: start
virt_info
==================================================================
.. autofunction:: virt_info

50
doc/ref/modules/all/salt.modules.launchctl.rst Normal file
View File

@ -0,0 +1,50 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
======================
salt.modules.launchctl
======================
.. automodule:: salt.modules.launchctl
.. rubric:: Members
get_all
==================================================================
.. autofunction:: get_all
get_launchctl_data
==================================================================
.. autofunction:: get_launchctl_data
restart
==================================================================
.. autofunction:: restart
start
==================================================================
.. autofunction:: start
status
==================================================================
.. autofunction:: status
stop
==================================================================
.. autofunction:: stop

34
doc/ref/modules/all/salt.modules.linux_sysctl.rst
View File

@ -1,6 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=========================
salt.modules.linux_sysctl
=========================
.. automodule:: salt.modules.linux_sysctl
:members:
.. rubric:: Members
assign
===========================================================================
.. autofunction:: assign
get
===========================================================================
.. autofunction:: get
persist
===========================================================================
.. autofunction:: persist
show
===========================================================================
.. autofunction:: show

22
doc/ref/modules/all/salt.modules.mdadm.rst
View File

@ -1,6 +1,26 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
==================
salt.modules.mdadm
==================
.. automodule:: salt.modules.mdadm
:members:
.. rubric:: Members
detail
======================================================
.. autofunction:: detail
list
======================================================
.. autofunction:: list

34
doc/ref/modules/all/salt.modules.moosefs.rst
View File

@ -1,6 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.moosefs
====================
.. automodule:: salt.modules.moosefs
:members:
.. rubric:: Members
dirinfo
============================================================
.. autofunction:: dirinfo
fileinfo
============================================================
.. autofunction:: fileinfo
getgoal
============================================================
.. autofunction:: getgoal
mounts
============================================================
.. autofunction:: mounts

52
doc/ref/modules/all/salt.modules.mount.rst
View File

@ -1,6 +1,56 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
==================
salt.modules.mount
==================
.. automodule:: salt.modules.mount
:members:
.. rubric:: Members
active
======================================================
.. autofunction:: active
fstab
======================================================
.. autofunction:: fstab
is_fuse_exec
======================================================
.. autofunction:: is_fuse_exec
mount
======================================================
.. autofunction:: mount
remount
======================================================
.. autofunction:: remount
rm_fstab
======================================================
.. autofunction:: rm_fstab
set_fstab
======================================================
.. autofunction:: set_fstab

148
doc/ref/modules/all/salt.modules.mysql.rst
View File

@ -1,6 +1,152 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
==================
salt.modules.mysql
==================
.. automodule:: salt.modules.mysql
:members:
.. rubric:: Members
connect
======================================================
.. autofunction:: connect
db_check
======================================================
.. autofunction:: db_check
db_create
======================================================
.. autofunction:: db_create
db_exists
======================================================
.. autofunction:: db_exists
db_list
======================================================
.. autofunction:: db_list
db_optimize
======================================================
.. autofunction:: db_optimize
db_remove
======================================================
.. autofunction:: db_remove
db_repair
======================================================
.. autofunction:: db_repair
db_tables
======================================================
.. autofunction:: db_tables
free_slave
======================================================
.. autofunction:: free_slave
grant_add
======================================================
.. autofunction:: grant_add
grant_exists
======================================================
.. autofunction:: grant_exists
grant_revoke
======================================================
.. autofunction:: grant_revoke
slave_lag
======================================================
.. autofunction:: slave_lag
status
======================================================
.. autofunction:: status
user_chpass
======================================================
.. autofunction:: user_chpass
user_create
======================================================
.. autofunction:: user_create
user_exists
======================================================
.. autofunction:: user_exists
user_grants
======================================================
.. autofunction:: user_grants
user_info
======================================================
.. autofunction:: user_info
user_list
======================================================
.. autofunction:: user_list
user_remove
======================================================
.. autofunction:: user_remove
version
======================================================
.. autofunction:: version

82
doc/ref/modules/all/salt.modules.network.rst
View File

@ -1,6 +1,86 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.network
====================
.. automodule:: salt.modules.network
:members:
.. rubric:: Members
dig
============================================================
.. autofunction:: dig
host_to_ip
============================================================
.. autofunction:: host_to_ip
hwaddr
============================================================
.. autofunction:: hwaddr
interfaces
============================================================
.. autofunction:: interfaces
ip_to_host
============================================================
.. autofunction:: ip_to_host
ipaddr
============================================================
.. autofunction:: ipaddr
isportopen
============================================================
.. autofunction:: isportopen
netmask
============================================================
.. autofunction:: netmask
netstat
============================================================
.. autofunction:: netstat
ping
============================================================
.. autofunction:: ping
traceroute
============================================================
.. autofunction:: traceroute
up
============================================================
.. autofunction:: up

22
doc/ref/modules/all/salt.modules.nginx.rst
View File

@ -1,6 +1,26 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
==================
salt.modules.nginx
==================
.. automodule:: salt.modules.nginx
:members:
.. rubric:: Members
signal
======================================================
.. autofunction:: signal
version
======================================================
.. autofunction:: version

38
doc/ref/modules/all/salt.modules.osxdesktop.rst Normal file
View File

@ -0,0 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=======================
salt.modules.osxdesktop
=======================
.. automodule:: salt.modules.osxdesktop
.. rubric:: Members
get_output_volume
=====================================================================
.. autofunction:: get_output_volume
lock
=====================================================================
.. autofunction:: lock
screensaver
=====================================================================
.. autofunction:: screensaver
set_output_volume
=====================================================================
.. autofunction:: set_output_volume

70
doc/ref/modules/all/salt.modules.pacman.rst
View File

@ -1,6 +1,74 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.pacman
===================
.. automodule:: salt.modules.pacman
:members:
.. rubric:: Members
available_version
=========================================================
.. autofunction:: available_version
install
=========================================================
.. autofunction:: install
list_pkgs
=========================================================
.. autofunction:: list_pkgs
list_upgrades
=========================================================
.. autofunction:: list_upgrades
purge
=========================================================
.. autofunction:: purge
refresh_db
=========================================================
.. autofunction:: refresh_db
remove
=========================================================
.. autofunction:: remove
upgrade
=========================================================
.. autofunction:: upgrade
upgrade_available
=========================================================
.. autofunction:: upgrade_available
version
=========================================================
.. autofunction:: version

16
doc/ref/modules/all/salt.modules.pillar.rst
View File

@ -1,6 +1,20 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.pillar
===================
.. automodule:: salt.modules.pillar
:members:
.. rubric:: Members
data
=========================================================
.. autofunction:: data

34
doc/ref/modules/all/salt.modules.pip.rst
View File

@ -1,6 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
================
salt.modules.pip
================
.. automodule:: salt.modules.pip
:members:
.. rubric:: Members
freeze
================================================
.. autofunction:: freeze
install
================================================
.. autofunction:: install
list
================================================
.. autofunction:: list
uninstall
================================================
.. autofunction:: uninstall

2
doc/ref/modules/all/salt.modules.pkg.rst
View File

@ -14,3 +14,5 @@ salt.modules.pkg
* :mod:`salt.modules.yumpkg`
* :mod:`salt.modules.yumpkg5`
* :mod:`salt.modules.zypper`
* :mod:`salt.modules.brew`
* :mod:`salt.modules.win_pkg`

56
doc/ref/modules/all/salt.modules.postgres.rst Normal file
View File

@ -0,0 +1,56 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=====================
salt.modules.postgres
=====================
.. automodule:: salt.modules.postgres
.. rubric:: Members
check_or_die
===============================================================
.. autofunction:: check_or_die
db_create
===============================================================
.. autofunction:: db_create
db_exists
===============================================================
.. autofunction:: db_exists
db_list
===============================================================
.. autofunction:: db_list
db_remove
===============================================================
.. autofunction:: db_remove
user_create
===============================================================
.. autofunction:: user_create
version
===============================================================
.. autofunction:: version

106
doc/ref/modules/all/salt.modules.ps.rst
View File

@ -1,6 +1,110 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===============
salt.modules.ps
===============
.. automodule:: salt.modules.ps
:members:
.. rubric:: Members
boot_time
=============================================
.. autofunction:: boot_time
cached_physical_memory
=============================================
.. autofunction:: cached_physical_memory
cpu_percent
=============================================
.. autofunction:: cpu_percent
cpu_times
=============================================
.. autofunction:: cpu_times
disk_io_counters
=============================================
.. autofunction:: disk_io_counters
disk_partition_usage
=============================================
.. autofunction:: disk_partition_usage
disk_partitions
=============================================
.. autofunction:: disk_partitions
disk_usage
=============================================
.. autofunction:: disk_usage
get_pid_list
=============================================
.. autofunction:: get_pid_list
network_io_counters
=============================================
.. autofunction:: network_io_counters
num_cpus
=============================================
.. autofunction:: num_cpus
physical_memory_buffers
=============================================
.. autofunction:: physical_memory_buffers
physical_memory_usage
=============================================
.. autofunction:: physical_memory_usage
top
=============================================
.. autofunction:: top
total_physical_memory
=============================================
.. autofunction:: total_physical_memory
virtual_memory_usage
=============================================
.. autofunction:: virtual_memory_usage

28
doc/ref/modules/all/salt.modules.publish.rst
View File

@ -1,6 +1,32 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.publish
====================
.. automodule:: salt.modules.publish
:members:
.. rubric:: Members
full_data
============================================================
.. autofunction:: full_data
publish
============================================================
.. autofunction:: publish
runner
============================================================
.. autofunction:: runner

34
doc/ref/modules/all/salt.modules.puppet.rst
View File

@ -1,6 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
===================
salt.modules.puppet
===================
.. automodule:: salt.modules.puppet
:members:
.. rubric:: Members
fact
=========================================================
.. autofunction:: fact
facts
=========================================================
.. autofunction:: facts
noop
=========================================================
.. autofunction:: noop
run
=========================================================
.. autofunction:: run

40
doc/ref/modules/all/salt.modules.pw_group.rst
View File

@ -1,6 +1,44 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=====================
salt.modules.pw_group
=====================
.. automodule:: salt.modules.pw_group
:members:
.. rubric:: Members
add
===============================================================
.. autofunction:: add
chgid
===============================================================
.. autofunction:: chgid
delete
===============================================================
.. autofunction:: delete
getent
===============================================================
.. autofunction:: getent
info
===============================================================
.. autofunction:: info

70
doc/ref/modules/all/salt.modules.pw_user.rst
View File

@ -1,6 +1,74 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
====================
salt.modules.pw_user
====================
.. automodule:: salt.modules.pw_user
:members:
.. rubric:: Members
add
============================================================
.. autofunction:: add
chgid
============================================================
.. autofunction:: chgid
chgroups
============================================================
.. autofunction:: chgroups
chhome
============================================================
.. autofunction:: chhome
chshell
============================================================
.. autofunction:: chshell
chuid
============================================================
.. autofunction:: chuid
delete
============================================================
.. autofunction:: delete
getent
============================================================
.. autofunction:: getent
info
============================================================
.. autofunction:: info
list_groups
============================================================
.. autofunction:: list_groups

62
doc/ref/modules/all/salt.modules.rabbitmq_server.rst Normal file
View File

@ -0,0 +1,62 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
============================
salt.modules.rabbitmq_server
============================
.. automodule:: salt.modules.rabbitmq_server
.. rubric:: Members
add_user
====================================================================================
.. autofunction:: add_user
add_vhost
====================================================================================
.. autofunction:: add_vhost
delete_user
====================================================================================
.. autofunction:: delete_user
delete_vhost
====================================================================================
.. autofunction:: delete_vhost
list_user_permissions
====================================================================================
.. autofunction:: list_user_permissions
list_users
====================================================================================
.. autofunction:: list_users
list_vhosts
====================================================================================
.. autofunction:: list_vhosts
set_permissions
====================================================================================
.. autofunction:: set_permissions

38
doc/ref/modules/all/salt.modules.reg.rst Normal file
View File

@ -0,0 +1,38 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
================
salt.modules.reg
================
.. automodule:: salt.modules.reg
.. rubric:: Members
create_key
================================================
.. autofunction:: create_key
delete_key
================================================
.. autofunction:: delete_key
read_key
================================================
.. autofunction:: read_key
set_key
================================================
.. autofunction:: set_key

58
doc/ref/modules/all/salt.modules.rh_ip.rst
View File

@ -1,6 +1,62 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
==================
salt.modules.rh_ip
==================
.. automodule:: salt.modules.rh_ip
:members:
.. rubric:: Members
build_bond
======================================================
.. autofunction:: build_bond
build_interface
======================================================
.. autofunction:: build_interface
down
======================================================
.. autofunction:: down
exists
======================================================
.. autofunction:: exists
get_bond
======================================================
.. autofunction:: get_bond
get_interface
======================================================
.. autofunction:: get_interface
join
======================================================
.. autofunction:: join
up
======================================================
.. autofunction:: up

76
doc/ref/modules/all/salt.modules.rh_service.rst
View File

@ -1,6 +1,80 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=======================
salt.modules.rh_service
=======================
.. automodule:: salt.modules.rh_service
:members:
.. rubric:: Members
disable
=====================================================================
.. autofunction:: disable
disabled
=====================================================================
.. autofunction:: disabled
enable
=====================================================================
.. autofunction:: enable
enabled
=====================================================================
.. autofunction:: enabled
get_all
=====================================================================
.. autofunction:: get_all
get_disabled
=====================================================================
.. autofunction:: get_disabled
get_enabled
=====================================================================
.. autofunction:: get_enabled
restart
=====================================================================
.. autofunction:: restart
start
=====================================================================
.. autofunction:: start
status
=====================================================================
.. autofunction:: status
stop
=====================================================================
.. autofunction:: stop

106
doc/ref/modules/all/salt.modules.rvm.rst
View File

@ -1,6 +1,110 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
================
salt.modules.rvm
================
.. automodule:: salt.modules.rvm
:members:
.. rubric:: Members
do
================================================
.. autofunction:: do
gemset_copy
================================================
.. autofunction:: gemset_copy
gemset_create
================================================
.. autofunction:: gemset_create
gemset_delete
================================================
.. autofunction:: gemset_delete
gemset_empty
================================================
.. autofunction:: gemset_empty
gemset_list
================================================
.. autofunction:: gemset_list
gemset_list_all
================================================
.. autofunction:: gemset_list_all
get
================================================
.. autofunction:: get
install
================================================
.. autofunction:: install
install_ruby
================================================
.. autofunction:: install_ruby
is_installed
================================================
.. autofunction:: is_installed
list
================================================
.. autofunction:: list
reinstall_ruby
================================================
.. autofunction:: reinstall_ruby
rubygems
================================================
.. autofunction:: rubygems
set_default
================================================
.. autofunction:: set_default
wrapper
================================================
.. autofunction:: wrapper

82
doc/ref/modules/all/salt.modules.saltutil.rst
View File

@ -1,6 +1,86 @@
.. NOTE: Do not edit this file, it is a generated file and will be overwritten.
See the master template file _templates/autosummary/module.rst
=====================
salt.modules.saltutil
=====================
.. automodule:: salt.modules.saltutil
:members:
.. rubric:: Members
find_job
===============================================================
.. autofunction:: find_job
kill_job
===============================================================
.. autofunction:: kill_job
refresh_pillar
===============================================================
.. autofunction:: refresh_pillar
running
===============================================================
.. autofunction:: running
signal_job
===============================================================
.. autofunction:: signal_job
sync_all
===============================================================
.. autofunction:: sync_all
sync_grains
===============================================================
.. autofunction:: sync_grains
sync_modules
===============================================================
.. autofunction:: sync_modules
sync_renderers
===============================================================
.. autofunction:: sync_renderers
sync_returners
===============================================================
.. autofunction:: sync_returners
sync_states
===============================================================
.. autofunction:: sync_states
term_job
===============================================================
.. autofunction:: term_job

Some files were not shown because too many files have changed in this diff Show More