Document vars_prompt in playbooks

13 years ago · fbc48a0d23
parent 59d2f57d64
commit fbc48a0d23
17 changed files with 44 additions and 16 deletions
--- a/YAMLSyntax.html
+++ b/YAMLSyntax.html
@ -246,7 +246,7 @@ languages:
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/api.html
+++ b/api.html
@ -331,7 +331,7 @@ a conf.d file appropriately or something similar.  Who knows.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/examples.html
+++ b/examples.html
@ -340,7 +340,7 @@ a simplified syntax for this.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/faq.html
+++ b/faq.html
@ -337,7 +337,7 @@ tasks &#8211; whether for a QA sytem, build system, or anything you can think of
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/genindex.html
+++ b/genindex.html
@ -161,7 +161,7 @@ s.parentNode.insertBefore(ga, s);
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/gettingstarted.html
+++ b/gettingstarted.html
@ -300,7 +300,7 @@ explore, but you already have a fully working infrastructure!</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/index.html
+++ b/index.html
@ -378,7 +378,7 @@ Puppet Labs, and rPath.  Reach Michael by email <a class="reference external" hr
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/man.html
+++ b/man.html
@ -195,7 +195,7 @@ examples of these tools in use.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/man/ansible-playbook.1.html
+++ b/man/ansible-playbook.1.html
@ -1,6 +1,6 @@
 <?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="id531517"></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
+<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="id351907"></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">
 <span class="strong"><strong>filename.yml</strong></span>
--- a/man/ansible.1.html
+++ b/man/ansible.1.html
@ -1,6 +1,6 @@
 <?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="id495370"></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="id439323"></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">
 <span class="strong"><strong>host-pattern</strong></span>
 </span></dt><dd>
--- a/moduledev.html
+++ b/moduledev.html
@ -395,7 +395,7 @@ Stop by the mailing list to inquire about requirements.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/modules.html
+++ b/modules.html
@ -540,7 +540,7 @@ yum pkg=httpd ensure=installed</pre>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/patterns.html
+++ b/patterns.html
@ -241,7 +241,7 @@ wildcards:</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/playbooks.html
+++ b/playbooks.html
@ -381,6 +381,19 @@ sharing your playbook source with them.</p>
 somevar: somevalue
 password: magic</pre>
 </div>
+<p>Alternatively, you may wish to prompt the user for certain input, and can
+do so with the similarly named &#8216;vars_prompt&#8217; section:</p>
+<div class="highlight-python"><pre>---
+- hosts: all
+  user: root
+  vars:
+    from: "camelot"
+  vars_prompt:
+    name: "what is your name?"
+    quest: "what is your quest?"
+    favcolor: "what is your favorite color?"</pre>
+</div>
+<p>There are full examples of both of these items in the github examples/playbooks directory.</p>
 </div>
 <div class="section" id="conditional-execution">
 <h3>Conditional Execution<a class="headerlink" href="#conditional-execution" title="Permalink to this headline">¶</a></h3>
@ -623,7 +636,7 @@ Let&#8217;s run a playbook using a parallelism level of 10:</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/rst/playbooks.rst
+++ b/rst/playbooks.rst
@ -253,6 +253,21 @@ The contents of each variables file is a simple YAML dictionary, like this::
    somevar: somevalue
    password: magic

+Alternatively, you may wish to prompt the user for certain input, and can
+do so with the similarly named 'vars_prompt' section::
+
+    ---
+    - hosts: all
+      user: root
+      vars:
+        from: "camelot"
+      vars_prompt:
+        name: "what is your name?"
+        quest: "what is your quest?"
+        favcolor: "what is your favorite color?"
+
+There are full examples of both of these items in the github examples/playbooks directory.
+

 Conditional Execution
 +++++++++++++++++++++
--- a/search.html
+++ b/search.html
@ -178,7 +178,7 @@ s.parentNode.insertBefore(ga, s);
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Apr 02, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/searchindex.js
+++ b/searchindex.js