mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Whitespace cleanup
This commit is contained in:
parent
498a612078
commit
d12677156e
53 changed files with 90 additions and 95 deletions
|
@ -141,4 +141,4 @@ Full list of builtin state modules
|
|||
winrepo
|
||||
xmpp
|
||||
zcbuildout
|
||||
zk_concurrency
|
||||
zk_concurrency
|
|
@ -3,4 +3,4 @@ salt.states.alias
|
|||
=================
|
||||
|
||||
.. automodule:: salt.states.alias
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.apt
|
|||
===============
|
||||
|
||||
.. automodule:: salt.states.apt
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.jboss7
|
|||
========================
|
||||
|
||||
.. automodule:: salt.states.artifactory
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.aws_sqs
|
|||
===================
|
||||
|
||||
.. automodule:: salt.states.aws_sqs
|
||||
:members:
|
||||
:members:
|
|
@ -4,4 +4,4 @@ salt.states.cmd
|
|||
|
||||
.. automodule:: salt.states.cmd
|
||||
:members:
|
||||
:exclude-members: watch
|
||||
:exclude-members: watch
|
|
@ -4,4 +4,4 @@ salt.states.event
|
|||
|
||||
.. automodule:: salt.states.event
|
||||
:members:
|
||||
:exclude-members: fire_master, mod_watch
|
||||
:exclude-members: fire_master, mod_watch
|
|
@ -3,4 +3,4 @@ salt.states.git
|
|||
===============
|
||||
|
||||
.. automodule:: salt.states.git
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.htpasswd
|
|||
====================
|
||||
|
||||
.. automodule:: salt.states.htpasswd
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.jboss7
|
|||
========================
|
||||
|
||||
.. automodule:: salt.states.jboss7
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.layman
|
|||
==================
|
||||
|
||||
.. automodule:: salt.states.layman
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.libvirt
|
|||
===================
|
||||
|
||||
.. automodule:: salt.states.libvirt
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.lvm
|
|||
===============
|
||||
|
||||
.. automodule:: salt.states.lvm
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.mdadm
|
|||
=================
|
||||
|
||||
.. automodule:: salt.states.mdadm
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.modjk_worker
|
|||
========================
|
||||
|
||||
.. automodule:: salt.states.modjk_worker
|
||||
:members:
|
||||
:members:
|
|
@ -4,4 +4,4 @@ salt.states.module
|
|||
|
||||
.. automodule:: salt.states.module
|
||||
:members:
|
||||
:exclude-members: watch
|
||||
:exclude-members: watch
|
|
@ -3,4 +3,4 @@ salt.states.network
|
|||
===================
|
||||
|
||||
.. automodule:: salt.states.network
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.pagerduty
|
|||
=====================
|
||||
|
||||
.. automodule:: salt.states.pagerduty
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.pip_state
|
|||
=====================
|
||||
|
||||
.. automodule:: salt.states.pip_state
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.ports
|
|||
=================
|
||||
|
||||
.. automodule:: salt.states.ports
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.postgres_extension
|
|||
==============================
|
||||
|
||||
.. automodule:: salt.states.postgres_extension
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.postgres_group
|
|||
==========================
|
||||
|
||||
.. automodule:: salt.states.postgres_group
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.redismod
|
|||
====================
|
||||
|
||||
.. automodule:: salt.states.redismod
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.selinux
|
|||
===================
|
||||
|
||||
.. automodule:: salt.states.selinux
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.ssh_known_hosts
|
|||
===========================
|
||||
|
||||
.. automodule:: salt.states.ssh_known_hosts
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.tomcat
|
|||
========================
|
||||
|
||||
.. automodule:: salt.states.tomcat
|
||||
:members:
|
||||
:members:
|
|
@ -4,4 +4,4 @@ salt.states.virtualenv
|
|||
|
||||
.. automodule:: salt.states.virtualenv_mod
|
||||
:members:
|
||||
:exclude-members: manage
|
||||
:exclude-members: manage
|
|
@ -3,4 +3,4 @@ salt.states.win_dns_client
|
|||
==========================
|
||||
|
||||
.. automodule:: salt.states.win_dns_client
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.win_firewall
|
|||
========================
|
||||
|
||||
.. automodule:: salt.states.win_firewall
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.win_network
|
|||
=======================
|
||||
|
||||
.. automodule:: salt.states.win_network
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.win_path
|
|||
====================
|
||||
|
||||
.. automodule:: salt.states.win_path
|
||||
:members:
|
||||
:members:
|
|
@ -3,4 +3,4 @@ salt.states.win_servermanager
|
|||
=============================
|
||||
|
||||
.. automodule:: salt.states.win_servermanager
|
||||
:members:
|
||||
:members:
|
|
@ -4,4 +4,4 @@ salt.states.win_system
|
|||
|
||||
.. automodule:: salt.states.win_system
|
||||
:members:
|
||||
:exclude-members: computer_description
|
||||
:exclude-members: computer_description
|
|
@ -3,4 +3,4 @@ salt.states.xmpp
|
|||
================
|
||||
|
||||
.. automodule:: salt.states.xmpp
|
||||
:members:
|
||||
:members:
|
|
@ -6,4 +6,4 @@ Altering States
|
|||
|
||||
.. note::
|
||||
|
||||
This documentation has been moved :ref:`here <global-state-arguments>`.
|
||||
This documentation has been moved :ref:`here <global-state-arguments>`.
|
|
@ -133,4 +133,4 @@ Deleting backups can be done using :mod:`file.delete_backup
|
|||
comment:
|
||||
Successfully removed /var/cache/salt/minion/file_backup/tmp/foo.txt_Sat_Jul_27_18:00:19_822550_2013
|
||||
result:
|
||||
True
|
||||
True
|
|
@ -76,41 +76,41 @@ Will have High Data which looks like this represented in json:
|
|||
{
|
||||
"apache": {
|
||||
"pkg": [
|
||||
"installed",
|
||||
"installed",
|
||||
{
|
||||
"order": 10000
|
||||
}
|
||||
],
|
||||
],
|
||||
"service": [
|
||||
"running",
|
||||
"running",
|
||||
{
|
||||
"watch": [
|
||||
{
|
||||
"file": "/etc/httpd/conf.d/httpd.conf"
|
||||
},
|
||||
},
|
||||
{
|
||||
"pkg": "apache"
|
||||
}
|
||||
]
|
||||
},
|
||||
},
|
||||
{
|
||||
"order": 10001
|
||||
}
|
||||
],
|
||||
"__sls__": "apache",
|
||||
],
|
||||
"__sls__": "apache",
|
||||
"__env__": "base"
|
||||
},
|
||||
},
|
||||
"/etc/httpd/conf.d/httpd.conf": {
|
||||
"file": [
|
||||
"managed",
|
||||
"managed",
|
||||
{
|
||||
"source": "salt://apache/httpd.conf"
|
||||
},
|
||||
},
|
||||
{
|
||||
"order": 10002
|
||||
}
|
||||
],
|
||||
"__sls__": "apache",
|
||||
],
|
||||
"__sls__": "apache",
|
||||
"__env__": "base"
|
||||
}
|
||||
}
|
||||
|
@ -121,39 +121,39 @@ The subsequent Low Data will look like this:
|
|||
|
||||
[
|
||||
{
|
||||
"name": "apache",
|
||||
"state": "pkg",
|
||||
"__id__": "apache",
|
||||
"fun": "installed",
|
||||
"__env__": "base",
|
||||
"__sls__": "apache",
|
||||
"name": "apache",
|
||||
"state": "pkg",
|
||||
"__id__": "apache",
|
||||
"fun": "installed",
|
||||
"__env__": "base",
|
||||
"__sls__": "apache",
|
||||
"order": 10000
|
||||
},
|
||||
},
|
||||
{
|
||||
"name": "apache",
|
||||
"name": "apache",
|
||||
"watch": [
|
||||
{
|
||||
"file": "/etc/httpd/conf.d/httpd.conf"
|
||||
},
|
||||
},
|
||||
{
|
||||
"pkg": "apache"
|
||||
}
|
||||
],
|
||||
"state": "service",
|
||||
"__id__": "apache",
|
||||
"fun": "running",
|
||||
"__env__": "base",
|
||||
"__sls__": "apache",
|
||||
],
|
||||
"state": "service",
|
||||
"__id__": "apache",
|
||||
"fun": "running",
|
||||
"__env__": "base",
|
||||
"__sls__": "apache",
|
||||
"order": 10001
|
||||
},
|
||||
},
|
||||
{
|
||||
"name": "/etc/httpd/conf.d/httpd.conf",
|
||||
"source": "salt://apache/httpd.conf",
|
||||
"state": "file",
|
||||
"__id__": "/etc/httpd/conf.d/httpd.conf",
|
||||
"fun": "managed",
|
||||
"__env__": "base",
|
||||
"__sls__": "apache",
|
||||
"name": "/etc/httpd/conf.d/httpd.conf",
|
||||
"source": "salt://apache/httpd.conf",
|
||||
"state": "file",
|
||||
"__id__": "/etc/httpd/conf.d/httpd.conf",
|
||||
"fun": "managed",
|
||||
"__env__": "base",
|
||||
"__sls__": "apache",
|
||||
"order": 10002
|
||||
}
|
||||
]
|
||||
|
@ -342,4 +342,4 @@ the first instance of a failure.
|
|||
|
||||
In the end, using requisites creates very tight and fine grained states,
|
||||
not using requisites makes full sequence runs and while slightly easier
|
||||
to write, and gives much less control over the executions.
|
||||
to write, and gives much less control over the executions.
|
|
@ -63,7 +63,7 @@ twice then only one of the extend blocks will be read. So this is WRONG:
|
|||
service:
|
||||
- watch:
|
||||
- file: /etc/ssh/banner
|
||||
|
||||
|
||||
|
||||
The Requisite "in" Statement
|
||||
----------------------------
|
||||
|
@ -94,4 +94,4 @@ There are a few rules to remember when extending states:
|
|||
overwritten
|
||||
3. extend is a top level declaration, like an ID declaration, cannot be
|
||||
declared twice in a single SLS
|
||||
4. Many IDs can be extended under the extend declaration
|
||||
4. Many IDs can be extended under the extend declaration
|
|
@ -51,4 +51,4 @@ see states failhard if an admin is not actively aware that the failhard has
|
|||
been set.
|
||||
|
||||
To use the global failhard set failhard: True in the master configuration
|
||||
file.
|
||||
file.
|
|
@ -6,4 +6,4 @@ Global State Arguments
|
|||
|
||||
.. note::
|
||||
|
||||
This documentation has been moved :ref:`here <requisites>`.
|
||||
This documentation has been moved :ref:`here <requisites>`.
|
|
@ -401,4 +401,4 @@ components.
|
|||
- <name>
|
||||
- <name>
|
||||
- <Requisite Declaration>:
|
||||
- <Requisite Reference>
|
||||
- <Requisite Reference>
|
|
@ -60,4 +60,4 @@ would look like this:
|
|||
|
||||
exclude:
|
||||
- sls: http
|
||||
- id: /etc/vimrc
|
||||
- id: /etc/vimrc
|
|
@ -188,7 +188,7 @@ module requires the `pip`_ package for proper name and version parsing.
|
|||
|
||||
In most of the common cases, Salt is clever enough to transparently reload the
|
||||
modules. For example, if you install a package, Salt reloads modules because
|
||||
some other module or state might require just that package which was installed.
|
||||
some other module or state might require just that package which was installed.
|
||||
|
||||
On some edge-cases salt might need to be told to reload the modules. Consider
|
||||
the following state file which we'll call ``pep8.sls``:
|
||||
|
@ -207,8 +207,8 @@ the following state file which we'll call ``pep8.sls``:
|
|||
- cmd: python-pip
|
||||
|
||||
|
||||
The above example installs `pip`_ using ``easy_install`` from `setuptools`_ and
|
||||
installs `pep8`_ using :mod:`pip <salt.states.pip_state>`, which, as told
|
||||
The above example installs `pip`_ using ``easy_install`` from `setuptools`_ and
|
||||
installs `pep8`_ using :mod:`pip <salt.states.pip_state>`, which, as told
|
||||
earlier, requires `pip`_ to be installed system-wide. Let's execute this state:
|
||||
|
||||
.. code-block:: bash
|
||||
|
@ -268,7 +268,7 @@ state executed correctly.
|
|||
|
||||
So how do we solve this *edge-case*? ``reload_modules``!
|
||||
|
||||
``reload_modules`` is a boolean option recognized by salt on **all** available
|
||||
``reload_modules`` is a boolean option recognized by salt on **all** available
|
||||
states which forces salt to reload its modules once a given state finishes.
|
||||
|
||||
The modified state file would now be:
|
||||
|
@ -318,4 +318,3 @@ The output is:
|
|||
.. _`pep8`: https://pypi.python.org/pypi/pep8
|
||||
.. _`setuptools`: https://pypi.python.org/pypi/setuptools
|
||||
.. _`runners`: /ref/runners
|
||||
|
||||
|
|
|
@ -91,7 +91,7 @@ The SLS layer can be called directly to execute individual sls formulas.
|
|||
.. note::
|
||||
|
||||
SLS Formulas have historically been called "SLS files". This is because a
|
||||
single SLS was only constituted in a single file. Now the term
|
||||
single SLS was only constituted in a single file. Now the term
|
||||
"SLS Formula" better expresses how a compartmentalized SLS can be expressed
|
||||
in a much more dynamic way by combining pillar and other sources, and the
|
||||
SLS can be dynamically generated.
|
||||
|
@ -131,4 +131,4 @@ The overstate layer expresses the highest functional layer of Salt's automated
|
|||
logic systems. The Overstate allows for stateful and functional orchestration
|
||||
of routines from the master. The overstate defines in data execution stages
|
||||
which minions should execute states, or functions, and in what order using
|
||||
requisite logic.
|
||||
requisite logic.
|
|
@ -5,4 +5,3 @@ The Orchestrate Runner
|
|||
.. note::
|
||||
|
||||
This documentation has been moved :ref:`here <orchestrate-runner>`.
|
||||
|
||||
|
|
|
@ -184,4 +184,3 @@ a state to the end of the line. To do this, set the order to ``last``:
|
|||
vim:
|
||||
pkg.installed:
|
||||
- order: last
|
||||
|
||||
|
|
|
@ -5,4 +5,3 @@ OverState System
|
|||
.. note::
|
||||
|
||||
This documentation has been moved :ref:`here <states-overstate>`.
|
||||
|
||||
|
|
|
@ -155,4 +155,4 @@ In this example, the state is being instructed to use a custom module to invoke
|
|||
commands.
|
||||
|
||||
Arbitrary module redirects can be used to dramatically change the behavior of a
|
||||
given state.
|
||||
given state.
|
|
@ -22,7 +22,7 @@ sls
|
|||
top
|
||||
Read in the ``top_file`` option and execute states based on that top file
|
||||
on the Salt Master
|
||||
|
||||
|
||||
Examples:
|
||||
---------
|
||||
|
||||
|
|
|
@ -30,4 +30,4 @@ states can still be run by calling test=False:
|
|||
|
||||
salt '*' state.highstate test=False
|
||||
salt '*' state.sls test=False
|
||||
salt '*' state.single test=False
|
||||
salt '*' state.single test=False
|
|
@ -365,4 +365,3 @@ are set as in the :ref:`above multi-environment example
|
|||
.. note::
|
||||
When in doubt, the simplest way to configure your states is with a single
|
||||
top.sls in the ``base`` environment.
|
||||
|
||||
|
|
|
@ -91,4 +91,4 @@ include option.
|
|||
|
||||
.. code-block:: jinja
|
||||
|
||||
{{ sls }}
|
||||
{{ sls }}
|
|
@ -101,8 +101,8 @@ A State Module must return a dict containing the following keys/values:
|
|||
Test State
|
||||
==========
|
||||
|
||||
All states should check for and support ``test`` being passed in the options.
|
||||
This will return data about what changes would occur if the state were actually
|
||||
All states should check for and support ``test`` being passed in the options.
|
||||
This will return data about what changes would occur if the state were actually
|
||||
run. An example of such a check could look like this:
|
||||
|
||||
.. code-block:: python
|
||||
|
|
Loading…
Add table
Reference in a new issue