From fae963a6d2136b3774ba2d6cefd3aed746707e32 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Fri, 9 Mar 2012 18:29:01 -0500 Subject: [PATCH] Docs build + attempt to add image to website --- html/YAMLScripts.html | 4 +- html/_static/basic.css | 9 +- html/_static/searchtools.js | 13 ++- html/api.html | 2 +- html/examples.html | 43 ++++++-- html/genindex.html | 2 +- html/gettingstarted.html | 33 ++++-- html/index.html | 67 ++++++----- html/man.html | 2 +- html/man/ansible-modules.5.html | 2 +- html/man/ansible-playbook.5.html | 2 +- html/man/ansible.1.html | 2 +- html/modules.html | 184 ++++++++++++++++++------------- html/mpd_rings.jpg | Bin 0 -> 55000 bytes html/objects.inv | Bin 265 -> 317 bytes html/patterns.html | 14 ++- html/playbooks.html | 20 ++-- html/search.html | 2 +- html/searchindex.js | 2 +- rst/index.rst | 14 ++- 20 files changed, 256 insertions(+), 161 deletions(-) create mode 100644 html/mpd_rings.jpg diff --git a/html/YAMLScripts.html b/html/YAMLScripts.html index 146f074932c..15f544e35ee 100644 --- a/html/YAMLScripts.html +++ b/html/YAMLScripts.html @@ -158,7 +158,7 @@ represent all the options you can use to write an ansible file. In addition, all YAML files (regardless of their association with ansible or not) should start with ---.

In YAML a list can be represented in two ways. In one way all members -of a list are lines beginning at the same indenta`tion level starting +of a list are lines beginning at the same indentation level starting with a - character:

---
 # A list of tasty fruits
@@ -229,7 +229,7 @@ languages:
     

         © Copyright 2012 Michael DeHaan.

       Last updated on Mar 09, 2012.

-      Created using Sphinx 1.0.7.

+      Created using Sphinx 1.0.8.
diff --git a/html/_static/basic.css b/html/_static/basic.css index 32630d54c9f..eb22a94218a 100644 --- a/html/_static/basic.css +++ b/html/_static/basic.css @@ -79,6 +79,14 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar input[type="text"] { + width: 170px; +} + +div.sphinxsidebar input[type="submit"] { + width: 30px; +} + img { border: 0; } @@ -236,7 +244,6 @@ img.align-center, .figure.align-center, object.align-center { } .align-center { - clear: both; text-align: center; } diff --git a/html/_static/searchtools.js b/html/_static/searchtools.js index dae92b5e5a6..4a78f9130e5 100644 --- a/html/_static/searchtools.js +++ b/html/_static/searchtools.js @@ -363,10 +363,13 @@ var Search = { var fullname = (prefix ? prefix + '.' : '') + name; if (fullname.toLowerCase().indexOf(object) > -1) { match = objects[prefix][name]; - 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]; + 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]; switch (match[2]) { case 1: objectResults.push(result); break; case 0: importantResults.push(result); break; @@ -489,7 +492,7 @@ var Search = { listItem.slideDown(5, function() { displayNextItem(); }); - }); + }, "text"); } else { // no source available, just display title Search.output.append(listItem); diff --git a/html/api.html b/html/api.html index 216ff3df892..df4adbf648b 100644 --- a/html/api.html +++ b/html/api.html @@ -222,7 +222,7 @@ command line tools ansible

© Copyright 2012 Michael DeHaan.
Last updated on Mar 09, 2012.
- Created using Sphinx 1.0.7.
+ Created using Sphinx 1.0.8.

diff --git a/html/examples.html b/html/examples.html index c3d72f8ac66..ea0694aadc4 100644 --- a/html/examples.html +++ b/html/examples.html @@ -172,28 +172,44 @@ ssh-add ~/.ssh/id_rsa.pub ansible atlanta -a "/sbin/reboot" -f 10

The -f 10 specifies the usage of 10 simultaneous processes.

-

Note that other than the command module, ansible modules do not work like simple scripts. They make the remote system look like you state, and run the commands neccessary to get it there. This is commonly refered to -as ‘idempotency’.

+
+

Note

+

Note that other than the command module, ansible modules do +not work like simple scripts. They make the remote system look like +you state, and run the commands necessary to get it there. This +is commonly referred to as ‘idempotent’.

+

File Transfer & Templating

-

Ansible can SCP lots of files to multiple machines in parallel, and optionally use them as template sources.

+

Ansible can SCP lots of files to multiple machines in parallel, and +optionally use them as template sources.

To just transfer a file directly to many different servers:

ansible atlanta copy -a "/etc/hosts /tmp/hosts"
-

To use templating, first run the setup module to put the template variables you would like to use on the remote host. Then use the template module to write the files using the templates. Templates are written in Jinja2 format. Playbooks (covered elsewhere in the documentation) will run the setup module for you, making this even simpler.:

+

To use templating, first run the setup module to put the template +variables you would like to use on the remote host. Then use the +template module to write the files using the templates. Templates are +written in Jinja2 format. Playbooks (covered elsewhere in the +documentation) will run the setup module for you, making this even +simpler.:

ansible webservers -m setup    -a "favcolor=red ntp_server=192.168.1.1"
 ansible webservers -m template -a "src=/srv/motd.j2 dest=/etc/motd"
 ansible webservers -m template -a "src=/srv/ntp.j2 dest=/etc/ntp.conf"
-

Need something like the fqdn in a template? If facter or ohai are installed, data from these projects will also be made available to the template engine, using ‘facter’ and ‘ohai’ prefixes for each.

+

Need something like the fqdn in a template? If facter or ohai are +installed, data from these projects will also be made available to the +template engine, using ‘facter’ and ‘ohai’ prefixes for each.

Deploying From Source Control

Deploy your webapp straight from git:

ansible webservers -m git -a "repo=git://foo dest=/srv/myapp version=HEAD"
-

Since ansible modules can notify change handlers (see ‘Playbooks’) it is possible to tell ansible to run specific tasks when the code is updated, such as deploying Perl/Python/PHP/Ruby directly from git and then restarting apache.

+

Since ansible modules can notify change handlers (see +Playbooks) it is possible to tell ansible to run specific tasks +when the code is updated, such as deploying Perl/Python/PHP/Ruby +directly from git and then restarting apache.

Managing Services

@@ -206,13 +222,18 @@ ansible webservers -m template -a "src=/srv/ntp.j2 dest=/etc/ntp.conf"

Time Limited Background Operations

-

Long running operations can be backgrounded, and their status can be checked on later. The same job ID is given to the same task on all hosts, so you won’t lose track. Polling support is pending in the command line.:

+

Long running operations can be backgrounded, and their status can be +checked on later. The same job ID is given to the same task on all +hosts, so you won’t lose track. Polling support is pending in the +command line.:

ansible all -B 3600 -a "/usr/bin/long_running_operation --do-stuff"
 ansible all -n job_status -a jid=123456789
-

Any module other than ‘copy’ or ‘template’ can be backgrounded. Typically you’ll be backgrounding shell -commands or software upgrades only.

-

After the time limit (in seconds) runs out (-B), the process on the remote nodes will be killed.

+

Any module other than copy or template can be +backgrounded. Typically you’ll be backgrounding shell commands or +software upgrades only.

+

After the time limit (in seconds) runs out (-B), the process on +the remote nodes will be killed.

@@ -224,7 +245,7 @@ commands or software upgrades only.

© Copyright 2012 Michael DeHaan.
Last updated on Mar 09, 2012.
- Created using Sphinx 1.0.7.
+ Created using Sphinx 1.0.8.

diff --git a/html/genindex.html b/html/genindex.html index 1031a2838ba..22e1bd77e95 100644 --- a/html/genindex.html +++ b/html/genindex.html @@ -151,7 +151,7 @@

© Copyright 2012 Michael DeHaan.
Last updated on Mar 09, 2012.
- Created using Sphinx 1.0.7.
+ Created using Sphinx 1.0.8.

diff --git a/html/gettingstarted.html b/html/gettingstarted.html index be97e75af9b..70401b6a99f 100644 --- a/html/gettingstarted.html +++ b/html/gettingstarted.html @@ -27,7 +27,7 @@ - +