archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Reinstate page nav, various TOC structure cleanup

Browse Source
pull/1256/head
Michael DeHaan 13 years ago
parent 3a1bbac3a7
commit 31c353543c
18 changed files with 236 additions and 30 deletions
Show Stats Download Patch File Download Diff File

11
YAMLSyntax.html
Unescape Escape View File

@ -123,6 +123,17 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">YAML Syntax</a><ul>
<li><a class="reference internal" href="#yaml-basics">YAML Basics</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

1
_themes/bootstrap/layout.html
Unescape Escape View File

@ -11,6 +11,7 @@
<ul class="nav"> <ul class="nav">
{% block sidebartoc %} {% block sidebartoc %}
{% include "globaltoc.html" %} {% include "globaltoc.html" %}
{% include "localtoc.html" %}
{% endblock %} {% endblock %}
</ul> </ul>
<ul class="nav secondary-nav"> <ul class="nav secondary-nav">

15
api.html
Unescape Escape View File

@ -123,6 +123,21 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">API &amp; Integrations</a><ul>
<li><a class="reference internal" href="#python-api">Python API</a><ul>
<li><a class="reference internal" href="#detailed-api-example">Detailed API Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#external-inventory">External Inventory</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

16
examples.html
Unescape Escape View File

@ -123,6 +123,22 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Command Line Examples</a><ul>
<li><a class="reference internal" href="#parallelism-and-shell-commands">Parallelism and Shell Commands</a></li>
<li><a class="reference internal" href="#file-transfer-templating">File Transfer &amp; Templating</a></li>
<li><a class="reference internal" href="#managing-packages">Managing Packages</a></li>
<li><a class="reference internal" href="#deploying-from-source-control">Deploying From Source Control</a></li>
<li><a class="reference internal" href="#managing-services">Managing Services</a></li>
<li><a class="reference internal" href="#time-limited-background-operations">Time Limited Background Operations</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

24
faq.html
Unescape Escape View File

@ -123,6 +123,30 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Frequently Asked Questions</a><ul>
<li><a class="reference internal" href="#what-inspired-ansible">What inspired Ansible?</a></li>
<li><a class="reference internal" href="#comparisons">Comparisons</a><ul>
<li><a class="reference internal" href="#vs-func">vs Func?</a></li>
<li><a class="reference internal" href="#vs-puppet">vs Puppet?</a></li>
<li><a class="reference internal" href="#vs-chef">vs Chef?</a></li>
<li><a class="reference internal" href="#vs-capistrano-fabric">vs Capistrano/Fabric?</a></li>
</ul>
</li>
<li><a class="reference internal" href="#other-questions">Other Questions</a><ul>
<li><a class="reference internal" href="#how-does-ansible-scale">How does Ansible scale?</a></li>
<li><a class="reference internal" href="#are-transports-other-than-ssh-supported">Are transports other than SSH supported?</a></li>
<li><a class="reference internal" href="#what-are-some-ideal-uses-for-ansible">What are some ideal uses for Ansible?</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

5
genindex.html
Unescape Escape View File

@ -121,6 +121,11 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"></span>
</li> </li>
</ul> </ul>

18
gettingstarted.html
Unescape Escape View File

@ -123,6 +123,24 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Downloads &amp; Getting Started</a><ul>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#developer-requirements">Developer Requirements</a></li>
<li><a class="reference internal" href="#getting-ansible">Getting Ansible</a><ul>
<li><a class="reference internal" href="#python-distutils">Python Distutils</a></li>
<li><a class="reference internal" href="#via-rpm">Via RPM</a></li>
</ul>
</li>
<li><a class="reference internal" href="#your-first-commands">Your first commands</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

33
index.html
Unescape Escape View File

@ -122,6 +122,23 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Introducing Ansible</a><ul>
<li><a class="reference internal" href="#architecture">Architecture</a></li>
<li><a class="reference internal" href="#design-goals">Design Goals</a></li>
<li><a class="reference internal" href="#resources">Resources</a></li>
</ul>
</li>
<li><a class="reference internal" href="#contents">Contents</a><ul>
<li><a class="reference internal" href="#about-the-author">About the Author</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>
@ -251,13 +268,15 @@ you with questions about Ansible.</p>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="playbooks.html">Playbooks</a><ul> <li class="toctree-l1"><a class="reference internal" href="playbooks.html">Playbooks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#playbook-example">Playbook Example</a></li> <li class="toctree-l2"><a class="reference internal" href="playbooks.html#playbook-example">Playbook Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#hosts-line">Hosts line</a></li> <li class="toctree-l2"><a class="reference internal" href="playbooks.html#basics">Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#user-line">User line</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#hosts-line">Hosts line</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#vars-section">Vars section</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#user-line">User line</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#tasks-list">Tasks list</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#vars-section">Vars section</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#task-name-and-action">Task name and action</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#tasks-list">Tasks list</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#notify-statements">Notify statements</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#task-name-and-action">Task name and action</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#handlers">Handlers</a></li> </ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#notify-statements-handlers">Notify statements &amp; Handlers</a></li>
<li class="toctree-l2"><a class="reference internal" href="playbooks.html#power-tricks">Power Tricks</a><ul> <li class="toctree-l2"><a class="reference internal" href="playbooks.html#power-tricks">Power Tricks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="playbooks.html#external-variables-and-sensitive-data">External Variables And Sensitive Data</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#external-variables-and-sensitive-data">External Variables And Sensitive Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="playbooks.html#include-files-and-reuse">Include Files And Reuse</a></li> <li class="toctree-l3"><a class="reference internal" href="playbooks.html#include-files-and-reuse">Include Files And Reuse</a></li>

12
man.html
Unescape Escape View File

@ -122,6 +122,18 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1 current"><a class="current reference internal" href="">Man Pages</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Man Pages</a><ul>
<li><a class="reference internal" href="#ansible-1">ansible(1)</a></li>
<li><a class="reference internal" href="#ansible-playbook-1">ansible-playbook(1)</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

2
man/ansible-playbook.1.html
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?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"> <!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="id422529"></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 &lt;filename.yml&gt; … [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 <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="id398465"></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 &lt;filename.yml&gt; … [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"> 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 class="strong"><strong>filename.yml</strong></span>
</span></dt><dd> </span></dt><dd>

2
man/ansible.1.html
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?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"> <!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="id560223"></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 &lt;host-pattern&gt; [-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" 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="id405326"></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 &lt;host-pattern&gt; [-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"> 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 class="strong"><strong>host-pattern</strong></span>
</span></dt><dd> </span></dt><dd>

18
moduledev.html
Unescape Escape View File

@ -123,6 +123,24 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Module Development Guide</a><ul>
<li><a class="reference internal" href="#tutorial">Tutorial</a></li>
<li><a class="reference internal" href="#testing-modules">Testing Modules</a></li>
<li><a class="reference internal" href="#reading-input">Reading Input</a></li>
<li><a class="reference internal" href="#common-pitfalls">Common Pitfalls</a></li>
<li><a class="reference internal" href="#conventions">Conventions</a></li>
<li><a class="reference internal" href="#shorthand-vs-json">Shorthand Vs JSON</a></li>
<li><a class="reference internal" href="#sharing-your-module">Sharing Your Module</a></li>
<li><a class="reference internal" href="#getting-your-module-into-core">Getting Your Module Into Core</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

23
modules.html
Unescape Escape View File

@ -123,6 +123,29 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Ansible Modules</a><ul>
<li><a class="reference internal" href="#command">command</a></li>
<li><a class="reference internal" href="#copy">copy</a></li>
<li><a class="reference internal" href="#facter">facter</a></li>
<li><a class="reference internal" href="#file">file</a></li>
<li><a class="reference internal" href="#git">git</a></li>
<li><a class="reference internal" href="#ohai">ohai</a></li>
<li><a class="reference internal" href="#ping">ping</a></li>
<li><a class="reference internal" href="#service">service</a></li>
<li><a class="reference internal" href="#setup">setup</a></li>
<li><a class="reference internal" href="#shell">shell</a></li>
<li><a class="reference internal" href="#template">template</a></li>
<li><a class="reference internal" href="#yum">yum</a></li>
<li><a class="reference internal" href="#writing-your-own-modules">Writing your own modules</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

12
patterns.html
Unescape Escape View File

@ -123,6 +123,18 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">The Inventory File, Patterns, and Groups</a><ul>
<li><a class="reference internal" href="#inventory-file-format">Inventory File Format</a></li>
<li><a class="reference internal" href="#selecting-targets">Selecting Targets</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>

48
playbooks.html
Unescape Escape View File

@ -123,6 +123,34 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"><ul>
<li><a class="reference internal" href="#">Playbooks</a><ul>
<li><a class="reference internal" href="#playbook-example">Playbook Example</a></li>
<li><a class="reference internal" href="#basics">Basics</a><ul>
<li><a class="reference internal" href="#hosts-line">Hosts line</a></li>
<li><a class="reference internal" href="#user-line">User line</a></li>
<li><a class="reference internal" href="#vars-section">Vars section</a></li>
<li><a class="reference internal" href="#tasks-list">Tasks list</a></li>
<li><a class="reference internal" href="#task-name-and-action">Task name and action</a></li>
</ul>
</li>
<li><a class="reference internal" href="#notify-statements-handlers">Notify statements &amp; Handlers</a></li>
<li><a class="reference internal" href="#power-tricks">Power Tricks</a><ul>
<li><a class="reference internal" href="#external-variables-and-sensitive-data">External Variables And Sensitive Data</a></li>
<li><a class="reference internal" href="#include-files-and-reuse">Include Files And Reuse</a></li>
<li><a class="reference internal" href="#using-includes-to-assign-classes-of-systems">Using Includes To Assign Classes of Systems</a></li>
<li><a class="reference internal" href="#asynchronous-actions-and-polling">Asynchronous Actions and Polling</a></li>
</ul>
</li>
<li><a class="reference internal" href="#executing-a-playbook">Executing A Playbook</a></li>
</ul>
</li>
</ul>
</span>
</li> </li>
</ul> </ul>
@ -187,8 +215,10 @@ server group, then more commands back on the webservers group, etc.</p>
</div> </div>
<p>Below, we&#8217;ll break down what the various features of the playbook language are.</p> <p>Below, we&#8217;ll break down what the various features of the playbook language are.</p>
</div> </div>
<div class="section" id="basics">
<h2>Basics<a class="headerlink" href="#basics" title="Permalink to this headline"></a></h2>
<div class="section" id="hosts-line"> <div class="section" id="hosts-line">
<h2>Hosts line<a class="headerlink" href="#hosts-line" title="Permalink to this headline"></a></h2> <h3>Hosts line<a class="headerlink" href="#hosts-line" title="Permalink to this headline"></a></h3>
<p>The <cite>hosts</cite> line is a list of one or more groups or host patterns, <p>The <cite>hosts</cite> line is a list of one or more groups or host patterns,
separated by colons, as described in the <a class="reference internal" href="patterns.html#patterns"><em>The Inventory File, Patterns, and Groups</em></a> separated by colons, as described in the <a class="reference internal" href="patterns.html#patterns"><em>The Inventory File, Patterns, and Groups</em></a>
documentation. This is just like the first parameter to documentation. This is just like the first parameter to
@ -196,14 +226,14 @@ documentation. This is just like the first parameter to
<p>Each play gets to designate it&#8217;s own choice of patterns.</p> <p>Each play gets to designate it&#8217;s own choice of patterns.</p>
</div> </div>
<div class="section" id="user-line"> <div class="section" id="user-line">
<h2>User line<a class="headerlink" href="#user-line" title="Permalink to this headline"></a></h2> <h3>User line<a class="headerlink" href="#user-line" title="Permalink to this headline"></a></h3>
<p>Playbook steps on the remote system can be executed as any user. The default is root, <p>Playbook steps on the remote system can be executed as any user. The default is root,
but you can specify others. Sudo support is pending.:</p> but you can specify others. Sudo support is pending.:</p>
<div class="highlight-python"><pre>user: mdehaan</pre> <div class="highlight-python"><pre>user: mdehaan</pre>
</div> </div>
</div> </div>
<div class="section" id="vars-section"> <div class="section" id="vars-section">
<h2>Vars section<a class="headerlink" href="#vars-section" title="Permalink to this headline"></a></h2> <h3>Vars section<a class="headerlink" href="#vars-section" title="Permalink to this headline"></a></h3>
<p>The <cite>vars&#8217; section contains a list of variables and values that can be used in the plays. These <p>The <cite>vars&#8217; section contains a list of variables and values that can be used in the plays. These
can be used in templates or tasks and are dereferenced using can be used in templates or tasks and are dereferenced using
`jinja2</cite> syntax like this:</p> `jinja2</cite> syntax like this:</p>
@ -224,7 +254,7 @@ to write the hostname into the /etc/motd file, I could say:</p>
<p>But we&#8217;re getting ahead of ourselves. Let&#8217;s talk about tasks.</p> <p>But we&#8217;re getting ahead of ourselves. Let&#8217;s talk about tasks.</p>
</div> </div>
<div class="section" id="tasks-list"> <div class="section" id="tasks-list">
<h2>Tasks list<a class="headerlink" href="#tasks-list" title="Permalink to this headline"></a></h2> <h3>Tasks list<a class="headerlink" href="#tasks-list" title="Permalink to this headline"></a></h3>
<p>Each play contains a list of tasks. Tasks are executed in order, one <p>Each play contains a list of tasks. Tasks are executed in order, one
at a time, against all machines matched by the host pattern, at a time, against all machines matched by the host pattern,
before moving on to the next task.</p> before moving on to the next task.</p>
@ -239,7 +269,7 @@ same command again, which is totally ok if the command is something
like &#8216;chmod&#8217; or &#8216;setsebool&#8217;, etc.</p> like &#8216;chmod&#8217; or &#8216;setsebool&#8217;, etc.</p>
</div> </div>
<div class="section" id="task-name-and-action"> <div class="section" id="task-name-and-action">
<h2>Task name and action<a class="headerlink" href="#task-name-and-action" title="Permalink to this headline"></a></h2> <h3>Task name and action<a class="headerlink" href="#task-name-and-action" title="Permalink to this headline"></a></h3>
<p>Every task must have a name, which is included in the output from <p>Every task must have a name, which is included in the output from
running the playbook.</p> running the playbook.</p>
<p>The action line is the name of an ansible module followed by <p>The action line is the name of an ansible module followed by
@ -259,8 +289,9 @@ a variable called &#8216;vhost&#8217; in the &#8216;vars&#8217; section, you cou
</div> </div>
<p>Those same variables are usable in templates, which we&#8217;ll get to later.</p> <p>Those same variables are usable in templates, which we&#8217;ll get to later.</p>
</div> </div>
<div class="section" id="notify-statements"> </div>
<h2>Notify statements<a class="headerlink" href="#notify-statements" title="Permalink to this headline"></a></h2> <div class="section" id="notify-statements-handlers">
<h2>Notify statements &amp; Handlers<a class="headerlink" href="#notify-statements-handlers" title="Permalink to this headline"></a></h2>
<p>As we&#8217;ve mentioned, nearly all modules are written to be &#8216;idempotent&#8217; and can signal when <p>As we&#8217;ve mentioned, nearly all modules are written to be &#8216;idempotent&#8217; and can signal when
they have affected a change on the remote system. Playbooks recognize this and they have affected a change on the remote system. Playbooks recognize this and
have a basic event system that can be used to respond to change.</p> have a basic event system that can be used to respond to change.</p>
@ -280,9 +311,6 @@ change, but only if the file changes:</p>
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">Notify handlers are always run in the order written.</p> <p class="last">Notify handlers are always run in the order written.</p>
</div> </div>
</div>
<div class="section" id="handlers">
<h2>Handlers<a class="headerlink" href="#handlers" title="Permalink to this headline"></a></h2>
<p>Handlers are lists of tasks, not really any different from regular <p>Handlers are lists of tasks, not really any different from regular
tasks, that are referenced by name. Handlers are what notifiers tasks, that are referenced by name. Handlers are what notifiers
notify. If nothing notifies a handler, it will not run. Regardless notify. If nothing notifies a handler, it will not run. Regardless

19
rst/playbooks.rst
Unescape Escape View File

@ -53,9 +53,11 @@ For starters, here's a playbook that contains just one play.::
Below, we'll break down what the various features of the playbook language are. Below, we'll break down what the various features of the playbook language are.
Basics
``````
Hosts line Hosts line
``````````` ++++++++++
The `hosts` line is a list of one or more groups or host patterns, The `hosts` line is a list of one or more groups or host patterns,
separated by colons, as described in the :ref:`patterns` separated by colons, as described in the :ref:`patterns`
@ -65,7 +67,7 @@ documentation. This is just like the first parameter to
Each play gets to designate it's own choice of patterns. Each play gets to designate it's own choice of patterns.
User line User line
````````` +++++++++
Playbook steps on the remote system can be executed as any user. The default is root, Playbook steps on the remote system can be executed as any user. The default is root,
but you can specify others. Sudo support is pending.:: but you can specify others. Sudo support is pending.::
@ -73,7 +75,7 @@ but you can specify others. Sudo support is pending.::
user: mdehaan user: mdehaan
Vars section Vars section
```````````` ++++++++++++
The `vars' section contains a list of variables and values that can be used in the plays. These The `vars' section contains a list of variables and values that can be used in the plays. These
can be used in templates or tasks and are dereferenced using can be used in templates or tasks and are dereferenced using
@ -98,7 +100,7 @@ And in /srv/templates/motd.j2::
But we're getting ahead of ourselves. Let's talk about tasks. But we're getting ahead of ourselves. Let's talk about tasks.
Tasks list Tasks list
`````````` ++++++++++
Each play contains a list of tasks. Tasks are executed in order, one Each play contains a list of tasks. Tasks are executed in order, one
at a time, against all machines matched by the host pattern, at a time, against all machines matched by the host pattern,
@ -117,7 +119,7 @@ like 'chmod' or 'setsebool', etc.
Task name and action Task name and action
````````````````````` ++++++++++++++++++++
Every task must have a name, which is included in the output from Every task must have a name, which is included in the output from
running the playbook. running the playbook.
@ -142,8 +144,8 @@ a variable called 'vhost' in the 'vars' section, you could do this::
Those same variables are usable in templates, which we'll get to later. Those same variables are usable in templates, which we'll get to later.
Notify statements Notify statements & Handlers
````````````````` ````````````````````````````
As we've mentioned, nearly all modules are written to be 'idempotent' and can signal when As we've mentioned, nearly all modules are written to be 'idempotent' and can signal when
they have affected a change on the remote system. Playbooks recognize this and they have affected a change on the remote system. Playbooks recognize this and
@ -167,9 +169,6 @@ Next up, we'll show what a handler looks like.
.. note:: .. note::
Notify handlers are always run in the order written. Notify handlers are always run in the order written.
Handlers
````````
Handlers are lists of tasks, not really any different from regular Handlers are lists of tasks, not really any different from regular
tasks, that are referenced by name. Handlers are what notifiers tasks, that are referenced by name. Handlers are what notifiers
notify. If nothing notifies a handler, it will not run. Regardless notify. If nothing notifies a handler, it will not run. Regardless

5
search.html
Unescape Escape View File

@ -127,6 +127,11 @@ s.parentNode.insertBefore(ga, s);
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li> <li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a></li>
</ul> </ul>
</span> </span>
</li>
<li class="dropdown" data-dropdown="dropdown">
<a href="#"
class="dropdown-toggle">Page</a>
<span class="localtoc"></span>
</li> </li>
</ul> </ul>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long
Write Preview
Loading…
Cancel
Save