Merge pull request #38 from tbielawa/littlefixes
little fixes here and there (docs, makefile)
This commit is contained in:
commit
d584cdf501
23 changed files with 120 additions and 118 deletions
10
.gitignore
vendored
10
.gitignore
vendored
|
@ -1,9 +1,13 @@
|
|||
# Old compiled python stuff
|
||||
*.py[co]
|
||||
.buildinfo
|
||||
objects.inv
|
||||
.doctrees
|
||||
# package building stuff
|
||||
build
|
||||
# Emacs backup files...
|
||||
*~
|
||||
.\#*
|
||||
.doctrees
|
||||
# Generated docs stuff
|
||||
ansible*.xml
|
||||
.buildinfo
|
||||
objects.inv
|
||||
.doctrees
|
||||
|
|
4
Makefile
4
Makefile
|
@ -19,8 +19,8 @@ htmldocs:
|
|||
./build-site.py rst
|
||||
|
||||
clean:
|
||||
-rm .buildinfo
|
||||
-rm *.inv
|
||||
-rm -f .buildinfo
|
||||
-rm -f *.inv
|
||||
-rm -rf *.doctrees
|
||||
@echo "Cleaning up byte compiled python stuff"
|
||||
find . -regex ".*\.py[co]$$" -delete
|
||||
|
|
|
@ -246,7 +246,7 @@ languages:
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -79,14 +79,6 @@ div.sphinxsidebar input {
|
|||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input[type="text"] {
|
||||
width: 170px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input[type="submit"] {
|
||||
width: 30px;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
}
|
||||
|
@ -244,6 +236,7 @@ img.align-center, .figure.align-center, object.align-center {
|
|||
}
|
||||
|
||||
.align-center {
|
||||
clear: both;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
|
|
|
@ -363,13 +363,10 @@ var Search = {
|
|||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
match = objects[prefix][name];
|
||||
descr = objnames[match[1]][2] + _(', in ') + titles[match[0]];
|
||||
anchor = match[3];
|
||||
if (anchor == '')
|
||||
anchor = fullname;
|
||||
else if (anchor == '-')
|
||||
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||
result = [filenames[match[0]], fullname, '#'+anchor, descr];
|
||||
descr = objnames[match[1]] + _(', in ') + titles[match[0]];
|
||||
// XXX the generated anchors are not generally correct
|
||||
// XXX there may be custom prefixes
|
||||
result = [filenames[match[0]], fullname, '#'+fullname, descr];
|
||||
switch (match[2]) {
|
||||
case 1: objectResults.push(result); break;
|
||||
case 0: importantResults.push(result); break;
|
||||
|
@ -492,7 +489,7 @@ var Search = {
|
|||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, "text");
|
||||
});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
|
|
|
@ -18,8 +18,9 @@ ansible-playbook <filename.yml> ... [options]
|
|||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
*Ansible playbooks* are a configuration and multinode deployment system. Ansible-playbook is the tool
|
||||
used to run them. See the project home page (link below) for more information.
|
||||
*Ansible playbooks* are a configuration and multinode deployment
|
||||
system. Ansible-playbook is the tool used to run them. See the
|
||||
project home page (link below) for more information.
|
||||
|
||||
|
||||
ARGUMENTS
|
||||
|
@ -34,19 +35,19 @@ OPTIONS
|
|||
-------
|
||||
|
||||
|
||||
*-i*, *--inventory*::
|
||||
*-i* 'PATH', *--inventory=*'PATH'::
|
||||
|
||||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
||||
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
|
||||
|
||||
|
||||
*-M*, *--module-path*::
|
||||
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
|
||||
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
|
||||
|
||||
|
||||
*-f*, *--forks*::
|
||||
*-f* 'NUM', *--forks=*'NUM'::
|
||||
|
||||
Desired level of parallelism. Default 5.
|
||||
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
|
||||
|
||||
|
||||
*-k*, *--ask-pass*::
|
||||
|
@ -54,9 +55,9 @@ Desired level of parallelism. Default 5.
|
|||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
||||
|
||||
|
||||
*-T*, *--timeout*::
|
||||
*-T* 'SECONDS', *--timeout=*'SECONDS'::
|
||||
|
||||
Connection timeout to use when trying to talk to hosts, in seconds.
|
||||
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
|
|
|
@ -27,37 +27,38 @@ ARGUMENTS
|
|||
|
||||
*host-pattern*::
|
||||
|
||||
A name of a group in the inventory file, a shell-like glob selecting hosts in inventory
|
||||
file, or any combination of the two seperated by semicolons.
|
||||
A name of a group in the inventory file, a shell-like glob selecting
|
||||
hosts in inventory file, or any combination of the two separated by
|
||||
semicolons.
|
||||
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
|
||||
*-i*, *--inventory*::
|
||||
*-i* 'PATH', *--inventory=*'PATH'::
|
||||
|
||||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
||||
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
|
||||
|
||||
|
||||
*-f*, *--forks*::
|
||||
*-f* 'NUM', *--forks=*'NUM'::
|
||||
|
||||
Level of parallelism. Specify as an integer, the default is 5.
|
||||
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
|
||||
|
||||
|
||||
*-m*, *--module-name*::
|
||||
*-m* 'NAME', *--module-name=*'NAME'::
|
||||
|
||||
Module name to execute.
|
||||
Execute the module called 'NAME'.
|
||||
|
||||
|
||||
*-M*, *--module-path*::
|
||||
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
|
||||
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
|
||||
|
||||
|
||||
*-a*, *--args*::
|
||||
*-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_'::
|
||||
|
||||
Arguments to pass to the module
|
||||
The 'ARGUMENTS' to pass to the module.
|
||||
|
||||
|
||||
*-k*, *--ask-pass*::
|
||||
|
@ -70,29 +71,30 @@ Prompt for the SSH password instead of assuming key-based authentication with ss
|
|||
Try to output everything on one line.
|
||||
|
||||
|
||||
*-t*, *--tree*::
|
||||
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
|
||||
|
||||
Save contents in this output directory, with the results named in a file named after each host.
|
||||
Save contents in this output 'DIRECTORY', with the results saved in a
|
||||
file named after each host.
|
||||
|
||||
|
||||
*-T*, *--timeout*::
|
||||
*-T* 'SECONDS', *--timeout=*'SECONDS'::
|
||||
|
||||
Connection timeout to use when trying to talk to hosts, in seconds.
|
||||
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
||||
|
||||
|
||||
*-B*, *--background*::
|
||||
*-B* 'NUM', *--background=*'NUM'::
|
||||
|
||||
Runs commands in the background, killing the task after N seconds.
|
||||
Run commands in the background, killing the task after 'NUM' seconds.
|
||||
|
||||
|
||||
*-P*, *--poll*::
|
||||
*-P* 'NUM', *--poll=*'NUM'::
|
||||
|
||||
Poll a background job every (this many) seconds. Requires -B.
|
||||
Poll a background job every 'NUM' seconds. Requires *-B*.
|
||||
|
||||
|
||||
*-u*, *--remote-user*::
|
||||
*-u* 'USERNAME', *--remote-user=*'USERNAME'::
|
||||
|
||||
Use this remote username instead of root
|
||||
Use this remote 'USERNAME' instead of root.
|
||||
|
||||
|
||||
INVENTORY
|
||||
|
|
2
api.html
2
api.html
|
@ -331,7 +331,7 @@ a conf.d file appropriately or something similar. Who knows.</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -330,7 +330,7 @@ a simplified syntax for this.</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
2
faq.html
2
faq.html
|
@ -337,7 +337,7 @@ tasks – whether for a QA sytem, build system, or anything you can think of
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -161,7 +161,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -300,7 +300,7 @@ explore, but you already have a fully working infrastructure!</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -371,7 +371,7 @@ Puppet Labs, and rPath. Reach Michael by email <a class="reference external" hr
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
2
man.html
2
man.html
|
@ -195,7 +195,7 @@ examples of these tools in use.</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -1,30 +1,31 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible-playbook</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="refentry" title="ansible-playbook" lang="en"><a id="id354843"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible-playbook — run an ansible playbook</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible-playbook <filename.yml> … [options]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible playbooks</strong></span> are a configuration and multinode deployment system. Ansible-playbook is the tool
|
||||
used to run them. See the project home page (link below) for more information.</p></div><div class="refsect1" title="ARGUMENTS"><a id="_arguments"></a><h2>ARGUMENTS</h2><div class="variablelist"><dl><dt><span class="term">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible-playbook</title><link rel="stylesheet" type="text/css" href="./docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="refentry" title="ansible-playbook" lang="en"><a id="id537662"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible-playbook — run an ansible playbook</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible-playbook <filename.yml> … [options]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible playbooks</strong></span> are a configuration and multinode deployment
|
||||
system. Ansible-playbook is the tool used to run them. See the
|
||||
project home page (link below) for more information.</p></div><div class="refsect1" title="ARGUMENTS"><a id="_arguments"></a><h2>ARGUMENTS</h2><div class="variablelist"><dl><dt><span class="term">
|
||||
<span class="strong"><strong>filename.yml</strong></span>
|
||||
</span></dt><dd>
|
||||
The names of one or more YAML format files to run as ansible playbooks.
|
||||
</dd></dl></div></div><div class="refsect1" title="OPTIONS"><a id="_options"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">
|
||||
<span class="strong"><strong>-i</strong></span>, <span class="strong"><strong>--inventory</strong></span>
|
||||
<span class="strong"><strong>-i</strong></span> <span class="emphasis"><em>PATH</em></span>, <span class="strong"><strong>--inventory=</strong></span><span class="emphasis"><em>PATH</em></span>
|
||||
</span></dt><dd>
|
||||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
||||
The <span class="emphasis"><em>PATH</em></span> to the inventory hosts file, which defaults to <span class="emphasis"><em>/etc/ansible/hosts</em></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-M</strong></span>, <span class="strong"><strong>--module-path</strong></span>
|
||||
<span class="strong"><strong>-M</strong></span> <span class="emphasis"><em>DIRECTORY</em></span>, <span class="strong"><strong>--module-path=</strong></span><span class="emphasis"><em>DIRECTORY</em></span>
|
||||
</span></dt><dd>
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
The <span class="emphasis"><em>DIRECTORY</em></span> to load modules from. The default is <span class="emphasis"><em>/usr/share/ansible</em></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-f</strong></span>, <span class="strong"><strong>--forks</strong></span>
|
||||
<span class="strong"><strong>-f</strong></span> <span class="emphasis"><em>NUM</em></span>, <span class="strong"><strong>--forks=</strong></span><span class="emphasis"><em>NUM</em></span>
|
||||
</span></dt><dd>
|
||||
Desired level of parallelism. Default 5.
|
||||
Level of parallelism. <span class="emphasis"><em>NUM</em></span> is specified as an integer, the default is 5.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-k</strong></span>, <span class="strong"><strong>--ask-pass</strong></span>
|
||||
</span></dt><dd>
|
||||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-T</strong></span>, <span class="strong"><strong>--timeout</strong></span>
|
||||
<span class="strong"><strong>-T</strong></span> <span class="emphasis"><em>SECONDS</em></span>, <span class="strong"><strong>--timeout=</strong></span><span class="emphasis"><em>SECONDS</em></span>
|
||||
</span></dt><dd>
|
||||
Connection timeout to use when trying to talk to hosts, in seconds.
|
||||
Connection timeout to use when trying to talk to hosts, in <span class="emphasis"><em>SECONDS</em></span>.
|
||||
</dd></dl></div></div><div class="refsect1" title="ENVIRONMENT"><a id="_environment"></a><h2>ENVIRONMENT</h2><p>The following environment variables may specified.</p><p>ANSIBLE_HOSTS — Override the default ansible hosts file</p><p>ANSIBLE_LIBRARY — Override the default ansible module library path</p></div><div class="refsect1" title="AUTHOR"><a id="_author"></a><h2>AUTHOR</h2><p>Ansible was originally written by Michael DeHaan. See the AUTHORS file
|
||||
for a complete list of contributors.</p></div><div class="refsect1" title="COPYRIGHT"><a id="_copyright"></a><h2>COPYRIGHT</h2><p>Copyright © 2012, Michael DeHaan</p><p>Ansible is released under the terms of the GPLv3 License.</p></div><div class="refsect1" title="SEE ALSO"><a id="_see_also"></a><h2>SEE ALSO</h2><p><span class="strong"><strong>ansible</strong></span>(1)</p><p>Extensive documentation as well as IRC and mailing list info
|
||||
is available on the ansible home page: <a class="ulink" href="https://ansible.github.com/" target="_top">https://ansible.github.com/</a></p></div></div></body></html>
|
||||
|
|
|
@ -1,31 +1,32 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="refentry" title="ansible" lang="en"><a id="id382252"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible — run a command somewhere else</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible <host-pattern> [-f forks] [-m module_name] [-a args]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible</strong></span> is an extra-simple tool/framework/API for doing 'remote things' over
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible</title><link rel="stylesheet" type="text/css" href="./docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="refentry" title="ansible" lang="en"><a id="id413895"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible — run a command somewhere else</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible <host-pattern> [-f forks] [-m module_name] [-a args]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible</strong></span> is an extra-simple tool/framework/API for doing 'remote things' over
|
||||
SSH.</p></div><div class="refsect1" title="ARGUMENTS"><a id="_arguments"></a><h2>ARGUMENTS</h2><div class="variablelist"><dl><dt><span class="term">
|
||||
<span class="strong"><strong>host-pattern</strong></span>
|
||||
</span></dt><dd>
|
||||
A name of a group in the inventory file, a shell-like glob selecting hosts in inventory
|
||||
file, or any combination of the two seperated by semicolons.
|
||||
A name of a group in the inventory file, a shell-like glob selecting
|
||||
hosts in inventory file, or any combination of the two separated by
|
||||
semicolons.
|
||||
</dd></dl></div></div><div class="refsect1" title="OPTIONS"><a id="_options"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">
|
||||
<span class="strong"><strong>-i</strong></span>, <span class="strong"><strong>--inventory</strong></span>
|
||||
<span class="strong"><strong>-i</strong></span> <span class="emphasis"><em>PATH</em></span>, <span class="strong"><strong>--inventory=</strong></span><span class="emphasis"><em>PATH</em></span>
|
||||
</span></dt><dd>
|
||||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
||||
The <span class="emphasis"><em>PATH</em></span> to the inventory hosts file, which defaults to <span class="emphasis"><em>/etc/ansible/hosts</em></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-f</strong></span>, <span class="strong"><strong>--forks</strong></span>
|
||||
<span class="strong"><strong>-f</strong></span> <span class="emphasis"><em>NUM</em></span>, <span class="strong"><strong>--forks=</strong></span><span class="emphasis"><em>NUM</em></span>
|
||||
</span></dt><dd>
|
||||
Level of parallelism. Specify as an integer, the default is 5.
|
||||
Level of parallelism. <span class="emphasis"><em>NUM</em></span> is specified as an integer, the default is 5.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-m</strong></span>, <span class="strong"><strong>--module-name</strong></span>
|
||||
<span class="strong"><strong>-m</strong></span> <span class="emphasis"><em>NAME</em></span>, <span class="strong"><strong>--module-name=</strong></span><span class="emphasis"><em>NAME</em></span>
|
||||
</span></dt><dd>
|
||||
Module name to execute.
|
||||
Execute the module called <span class="emphasis"><em>NAME</em></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-M</strong></span>, <span class="strong"><strong>--module-path</strong></span>
|
||||
<span class="strong"><strong>-M</strong></span> <span class="emphasis"><em>DIRECTORY</em></span>, <span class="strong"><strong>--module-path=</strong></span><span class="emphasis"><em>DIRECTORY</em></span>
|
||||
</span></dt><dd>
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
The <span class="emphasis"><em>DIRECTORY</em></span> to load modules from. The default is <span class="emphasis"><em>/usr/share/ansible</em></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-a</strong></span>, <span class="strong"><strong>--args</strong></span>
|
||||
<span class="strong"><strong>-a</strong></span> '<span class="emphasis"><em>ARGUMENTS</em></span>', <span class="strong"><strong>--args=</strong></span>'<span class="emphasis"><em>ARGUMENTS</em></span>'
|
||||
</span></dt><dd>
|
||||
Arguments to pass to the module
|
||||
The <span class="emphasis"><em>ARGUMENTS</em></span> to pass to the module.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-k</strong></span>, <span class="strong"><strong>--ask-pass</strong></span>
|
||||
</span></dt><dd>
|
||||
|
@ -35,25 +36,26 @@ Prompt for the SSH password instead of assuming key-based authentication with ss
|
|||
</span></dt><dd>
|
||||
Try to output everything on one line.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-t</strong></span>, <span class="strong"><strong>--tree</strong></span>
|
||||
<span class="strong"><strong>-t</strong></span> <span class="emphasis"><em>DIRECTORY</em></span>, <span class="strong"><strong>--tree=</strong></span><span class="emphasis"><em>DIRECTORY</em></span>
|
||||
</span></dt><dd>
|
||||
Save contents in this output directory, with the results named in a file named after each host.
|
||||
Save contents in this output <span class="emphasis"><em>DIRECTORY</em></span>, with the results saved in a
|
||||
file named after each host.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-T</strong></span>, <span class="strong"><strong>--timeout</strong></span>
|
||||
<span class="strong"><strong>-T</strong></span> <span class="emphasis"><em>SECONDS</em></span>, <span class="strong"><strong>--timeout=</strong></span><span class="emphasis"><em>SECONDS</em></span>
|
||||
</span></dt><dd>
|
||||
Connection timeout to use when trying to talk to hosts, in seconds.
|
||||
Connection timeout to use when trying to talk to hosts, in <span class="emphasis"><em>SECONDS</em></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-B</strong></span>, <span class="strong"><strong>--background</strong></span>
|
||||
<span class="strong"><strong>-B</strong></span> <span class="emphasis"><em>NUM</em></span>, <span class="strong"><strong>--background=</strong></span><span class="emphasis"><em>NUM</em></span>
|
||||
</span></dt><dd>
|
||||
Runs commands in the background, killing the task after N seconds.
|
||||
Run commands in the background, killing the task after <span class="emphasis"><em>NUM</em></span> seconds.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-P</strong></span>, <span class="strong"><strong>--poll</strong></span>
|
||||
<span class="strong"><strong>-P</strong></span> <span class="emphasis"><em>NUM</em></span>, <span class="strong"><strong>--poll=</strong></span><span class="emphasis"><em>NUM</em></span>
|
||||
</span></dt><dd>
|
||||
Poll a background job every (this many) seconds. Requires -B.
|
||||
Poll a background job every <span class="emphasis"><em>NUM</em></span> seconds. Requires <span class="strong"><strong>-B</strong></span>.
|
||||
</dd><dt><span class="term">
|
||||
<span class="strong"><strong>-u</strong></span>, <span class="strong"><strong>--remote-user</strong></span>
|
||||
<span class="strong"><strong>-u</strong></span> <span class="emphasis"><em>USERNAME</em></span>, <span class="strong"><strong>--remote-user=</strong></span><span class="emphasis"><em>USERNAME</em></span>
|
||||
</span></dt><dd>
|
||||
Use this remote username instead of root
|
||||
Use this remote <span class="emphasis"><em>USERNAME</em></span> instead of root.
|
||||
</dd></dl></div></div><div class="refsect1" title="INVENTORY"><a id="_inventory"></a><h2>INVENTORY</h2><p>Ansible stores the hosts it can potentially operate on in an inventory
|
||||
file. The syntax is one host per line. Groups headers are allowed and
|
||||
are included on their own line, enclosed in square brackets.</p></div><div class="refsect1" title="FILES"><a id="_files"></a><h2>FILES</h2><p>/etc/ansible/hosts — Default inventory file</p><p>/usr/share/ansible/ — Default module library</p></div><div class="refsect1" title="ENVIRONMENT"><a id="_environment"></a><h2>ENVIRONMENT</h2><p>The following environment variables may specified.</p><p>ANSIBLE_HOSTS — Override the default ansible hosts file</p><p>ANSIBLE_LIBRARY — Override the default ansible module library path</p></div><div class="refsect1" title="AUTHOR"><a id="_author"></a><h2>AUTHOR</h2><p>Ansible was originally written by Michael DeHaan. See the AUTHORS file
|
||||
|
|
|
@ -395,7 +395,7 @@ Stop by the mailing list to inquire about requirements.</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
18
modules.html
18
modules.html
|
@ -210,7 +210,7 @@ paths to commands must be fully qualified.</p>
|
|||
<p>This module does not support change hooks and returns the return code
|
||||
from the program as well as timing information about how long the
|
||||
command was running for.</p>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>command /sbin/shutdown -t now</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -229,7 +229,7 @@ absolute or relative path.</li>
|
|||
<li>Remote absolute path where the file should end up.</li>
|
||||
</ul>
|
||||
<p>This module also returns md5sum information about the resultant file.</p>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -267,7 +267,7 @@ to the file module are also available when running the <cite>copy</cite> or <cit
|
|||
<ul class="simple">
|
||||
<li>name of group that should own the file or directory, as would be given to <cite>chgrp</cite></li>
|
||||
</ul>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>file dest=/etc/foo.conf owner=foo group=foo mode=0644
|
||||
file dest=/some/path owner=foo group=foo state=directory
|
||||
file dest/path/to/delete state=absent</pre>
|
||||
|
@ -289,7 +289,7 @@ file dest/path/to/delete state=absent</pre>
|
|||
<li>What version to check out – either the git SHA, the literal string
|
||||
<tt class="docutils literal"><span class="pre">HEAD</span></tt>, or a tag name.</li>
|
||||
</ul>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -324,7 +324,7 @@ unless necessary. <tt class="docutils literal"><span class="pre">restarted</spa
|
|||
<ul class="simple">
|
||||
<li>The name of the service.</li>
|
||||
</ul>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>service name=httpd state=started
|
||||
service name=httpd state=stopped
|
||||
service name=httpd state=restarted</pre>
|
||||
|
@ -348,7 +348,7 @@ tell their source. All variables are then bubbled up to the caller.</p>
|
|||
<tt class="docutils literal"><span class="pre">key=value</span></tt> pair in the JSON file for use in templating.</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>vars:
|
||||
ntpserver: 'ntp.example.com'
|
||||
xyz: 1234</pre>
|
||||
|
@ -427,7 +427,7 @@ example in the github examples directory for what this looks like in a playbook.
|
|||
<ul class="simple">
|
||||
<li>Defaults to ‘present’. When ‘absent’, the user account will be removed if present.</li>
|
||||
</ul>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>user name=mdehaan comment=awesome passwd=awWxVV.JvmdHw createhome=yes
|
||||
user name=mdehaan state=absent</pre>
|
||||
</div>
|
||||
|
@ -449,7 +449,7 @@ user name=mdehaan state=absent</pre>
|
|||
various configuration attributes. Values include ‘installed’, ‘updates’,
|
||||
‘available’, ‘repos’, or any package specifier.</li>
|
||||
</ul>
|
||||
<p>Example action from a <tt class="xref doc docutils literal"><span class="pre">playbook</span></tt>:</p>
|
||||
<p>Example action from a <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>yum pkg=httpd ensure=latest
|
||||
yum pkg=httpd ensure=removed
|
||||
yum pkg=httpd ensure=installed</pre>
|
||||
|
@ -486,7 +486,7 @@ yum pkg=httpd ensure=installed</pre>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -241,7 +241,7 @@ wildcards:</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -246,7 +246,8 @@ documentation. The <cite>user</cite> is just the name of the user account:</p>
|
|||
other: 'magic'</pre>
|
||||
</div>
|
||||
<p>These variables can be used later in the playbook, or on the managed system (in templates), just like this:</p>
|
||||
<div class="highlight-python"><pre>{{ varname }}</pre>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="p">{{</span> <span class="n">varname</span> <span class="p">}}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Within playbooks themselves, but not within templates on the remote machines, it’s also legal
|
||||
to use nicer shorthand like this:</p>
|
||||
|
@ -465,7 +466,8 @@ include files to do this.</p>
|
|||
</div>
|
||||
<p>Variables passed in can be used in the include files too. Assume a variable named ‘user’. Using
|
||||
<cite>jinja2</cite> syntax, anywhere in the included file, you can say:</p>
|
||||
<div class="highlight-python"><pre>{{ user }}</pre>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="p">{{</span> <span class="n">user</span> <span class="p">}}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>I can also pass variables into includes directly. We might call this a ‘parameterized include’.</p>
|
||||
<p>For instance, if deploying multiple wordpress instances, I could
|
||||
|
@ -623,7 +625,7 @@ Let’s run a playbook using a parallelism level of 10:</p>
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -56,7 +56,7 @@ This module does not support change hooks and returns the return code
|
|||
from the program as well as timing information about how long the
|
||||
command was running for.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
command /sbin/shutdown -t now
|
||||
|
||||
|
@ -82,7 +82,7 @@ module.
|
|||
|
||||
This module also returns md5sum information about the resultant file.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644
|
||||
|
||||
|
@ -128,7 +128,7 @@ to the file module are also available when running the `copy` or `template` modu
|
|||
|
||||
* name of group that should own the file or directory, as would be given to `chgrp`
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
file dest=/etc/foo.conf owner=foo group=foo mode=0644
|
||||
file dest=/some/path owner=foo group=foo state=directory
|
||||
|
@ -153,7 +153,7 @@ Deploys software (or files) from git checkouts.
|
|||
* What version to check out -- either the git SHA, the literal string
|
||||
``HEAD``, or a tag name.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22
|
||||
|
||||
|
@ -198,7 +198,7 @@ Controls services on remote machines.
|
|||
|
||||
* The name of the service.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
service name=httpd state=started
|
||||
service name=httpd state=stopped
|
||||
|
@ -226,7 +226,7 @@ tell their source. All variables are then bubbled up to the caller.
|
|||
* Any other parameters can be named basically anything, and set a
|
||||
``key=value`` pair in the JSON file for use in templating.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
vars:
|
||||
ntpserver: 'ntp.example.com'
|
||||
|
@ -325,7 +325,7 @@ Creates user accounts, manipulates existing user accounts, and removes user acco
|
|||
|
||||
* Defaults to 'present'. When 'absent', the user account will be removed if present.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
user name=mdehaan comment=awesome passwd=awWxVV.JvmdHw createhome=yes
|
||||
user name=mdehaan state=absent
|
||||
|
@ -351,7 +351,7 @@ Will install, upgrade, remove, and list packages with the yum package manager.
|
|||
various configuration attributes. Values include 'installed', 'updates',
|
||||
'available', 'repos', or any package specifier.
|
||||
|
||||
Example action from a :doc:`playbook`::
|
||||
Example action from a :doc:`playbooks`::
|
||||
|
||||
yum pkg=httpd ensure=latest
|
||||
yum pkg=httpd ensure=removed
|
||||
|
|
|
@ -178,7 +178,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Mar 23, 2012.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue