diff --git a/ansible b/ansible index 8e20ed3714b..96d39a0dff9 160000 --- a/ansible +++ b/ansible @@ -1 +1 @@ -Subproject commit 8e20ed3714b7a43279ecfd38a7812b28e1533f03 +Subproject commit 96d39a0dff9ccba4074479ca42eac0068733b803 diff --git a/build-site.py b/build-site.py index 37ae50a9834..5570818ccfb 100755 --- a/build-site.py +++ b/build-site.py @@ -20,6 +20,7 @@ __docformat__ = 'restructuredtext' import os import sys +import traceback from sphinx.application import Sphinx from os import path @@ -68,12 +69,7 @@ class SphinxBuilder(object): # print "Run 'make htmlman' to recreate the problem." #print "Your docs are now in %s" % outdir except ImportError, ie: - print >> sys.stderr, "You don't seem to have the following which" - print >> sys.stderr, "are required to make documentation:" - print >> sys.stderr, "\tsphinx.application.Sphinx" - print >> sys.stderr, "This is usually available from the python-sphinx package" - print >> sys.stderr, "=== Error message received while attempting to build===" - print >> sys.stderr, ie + traceback.print_exc() except Exception, ex: print >> sys.stderr, "FAIL! exiting ... (%s)" % ex diff --git a/html/YAMLScripts.html b/html/YAMLScripts.html index 1d0df432806..f252982648e 100644 --- a/html/YAMLScripts.html +++ b/html/YAMLScripts.html @@ -23,8 +23,8 @@ - - + +
@@ -34,10 +34,10 @@ index
  • - next |
  • - previous |
  • Ansible v0.0.1 documentation »
    • @@ -50,7 +50,9 @@

    YAML Scripts

    -

    This page provides a basic overview of correct YAML syntax.

    +

    This page provides a basic overview of correct YAML syntax, which is how Ansible +playbooks (our configuration management language) are expressed. +You may also wish to read playbook examples and will quickly pick this up from those.

    YAML Basics

    For ansible, every YAML script must be a list at it’s root-most @@ -111,7 +113,7 @@ languages: dotnet: Lame

    That’s all you really need to know about YAML to get started writing -Ansible scripts.

    +Ansible playbooks.

    See also

    @@ -137,11 +139,11 @@ languages:

    Previous topic

    -

    Getting Started

    +

    Ansible Modules

    Next topic

    -

    Patterns

    +

    Playbooks

    This Page

    © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
    \ No newline at end of file diff --git a/html/_sources/YAMLScripts.txt b/html/_sources/YAMLScripts.txt index de59528b785..32d76aff149 100644 --- a/html/_sources/YAMLScripts.txt +++ b/html/_sources/YAMLScripts.txt @@ -1,8 +1,9 @@ YAML Scripts ============ -This page provides a basic overview of correct YAML syntax. - +This page provides a basic overview of correct YAML syntax, which is how Ansible +playbooks (our configuration management language) are expressed. +You may also wish to read playbook examples and will quickly pick this up from those. YAML Basics ----------- @@ -74,7 +75,7 @@ Finally, you can combine these data structures:: dotnet: Lame That's all you really need to know about YAML to get started writing -`Ansible` scripts. +`Ansible` playbooks. .. seealso:: diff --git a/html/_sources/api.txt b/html/_sources/api.txt index 1cc8454a67d..a3ddea45951 100644 --- a/html/_sources/api.txt +++ b/html/_sources/api.txt @@ -1,55 +1,35 @@ API -=== - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +``` + +The Python API is very powerful, and is how the ansible CLI and ansible-playbook +are implemented. + +It's pretty simple:: + + import ansible.runner + + runner = ansible.runner.Runner( + module_name='ping', + module_args='', + pattern='web*', + forks=10 + ) + datastructure = runner.run() + +The run method returns results per host, grouped by whether they +could be contacted or not. Return types are module specific, as +expressed in the 'ansible-modules' documentation.:: + + { + "dark" : { + "web1.example.com" : "failure message" + } + "contacted" : { + "web2.example.com" : 1 + } + } + +A module can return any type of JSON data it wants, so Ansible can +be used as a framework to rapidly build powerful applications and scripts. + + diff --git a/html/_sources/communicate.txt b/html/_sources/communicate.txt index 8e4d12a3b0b..cd718ddcbfb 100644 --- a/html/_sources/communicate.txt +++ b/html/_sources/communicate.txt @@ -1,55 +1,9 @@ -Communicate -=========== +Communicate and Get Involved +=========================== -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. +* Join the `ansible-project mailing list `_ on Google Groups +* Join `#ansible `_ on the `freenode IRC network `_ +* Visit the `project page `_ on Github -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. + - View the `issue tracker `_ -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. diff --git a/html/_sources/examples.txt b/html/_sources/examples.txt index 44194c9ff0b..0a5df0d90d8 100644 --- a/html/_sources/examples.txt +++ b/html/_sources/examples.txt @@ -1,71 +1,65 @@ Examples ======== -Examples 1 -`````````` - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - - -Examples 2 -`````````` - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Examples 3 -`````````` - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -Examples 3 -`````````` - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Examples 4 -`````````` - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +.. seealso:: + + :doc:`modules` + A list of available modules + :doc:`playbooks` + Alternative ways to use ansible + + +Parallelism and Shell Commands +`````````````````````````````` + +Reboot all web servers in Atlanta, 10 at a time:: + + ssh-agent bash + 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. + + +Example 2: 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.:: + + 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. + + +Examples 3: File Transfer & Templating +`````````````````````````````````````` + +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 below) 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. + +Examples 3: 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. + + diff --git a/html/_sources/gettingstarted.txt b/html/_sources/gettingstarted.txt index 247faf96c03..638039c4a93 100644 --- a/html/_sources/gettingstarted.txt +++ b/html/_sources/gettingstarted.txt @@ -1,67 +1,100 @@ Getting Started =============== -How to ansible - +How to download ansible and get started using it .. seealso:: + :doc:`examples` + Examples of basic commands :doc:`YAMLScripts` - Complete documentation of the YAML syntax `ansible` understands. - - -What you need -------------- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. + Complete documentation of the YAML syntax `ansible` understands for playbooks. + :doc:`playbooks` + Learning ansible's configuration management language + :doc:`modules` + Learn about modules that ship with ansible + +Requirements +```````````` + +Requirements are extremely minimal. + +If you are running python 2.6 on the **overlord** machine, you will +need: + +* ``paramiko`` +* ``PyYAML`` +* ``python-jinja2`` (for playbooks) + +If you are running less than Python 2.6, you will also need: + +* The Python 2.4 or 2.5 backport of the ``multiprocessing`` module + + - `Installation and Testing Instructions `_ + +* ``simplejson`` + +On the managed nodes, to use templating, you will need: + +* ``python-jinja2`` (you can install this with ansible) + +Developer Requirements +`````````````````````` + +For developers, you may wish to have: + +* ``asciidoc`` (for building manpage documentation) +* ``python-sphinx`` (for building content for ansible.github.com) + + +Getting Ansible +``````````````` + +Tagged releases are available as tar.gz files from the Ansible github +project page: + +* `Ansible/downloads `_ + +You can also clone the git repository yourself and install Ansible in +one of two ways: + + +Python Distutils +++++++++++++++++ + +You can also install Ansible using Python Distutils:: + + $ git clone git://github.com/ansible/ansible.git + $ cd ./ansible + $ sudo make install + +Via RPM ++++++++ + +In the near future, pre-built RPMs will be available through your distribution. Until that time you +can use the ``make rpm`` command:: + + $ git clone git://github.com/ansible/ansible.git + $ cd ./ansible + $ make rpm + $ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm + +Your first commands +``````````````````` + +Edit /etc/ansible/hosts and put one or more remote systems in it, for which you have your SSH +key in ``authorized_keys``:: + + 192.168.1.50 + aserver.example.org + bserver.example.org + +Now try this: + + ssh-agent bash + ssh-add ~/.ssh/id_rsa + ansible all -m ping + +Congratulations. You've just contacted your nodes with Ansible. It's now time to read some +of the more real-world examples. + diff --git a/html/_sources/index.txt b/html/_sources/index.txt index c26aabef7b7..4ab721e4e24 100644 --- a/html/_sources/index.txt +++ b/html/_sources/index.txt @@ -5,102 +5,48 @@ Ansible ======= -Ansible is a extra-simple tool/API for doing 'parallel remote things' -over SSH -- whether executing commands, running "modules", or -executing larger 'playbooks' that can serve as a configuration -management or deployment system. +Ansible is a radically simple deployment, configuration, and command execution framework. +Other tools in this space have been too complicated for too long, require too much bootstrapping, +and have too much learning curve. Ansible is dead simple and painless to extend. For comparison, Puppet and Chef have about 60k lines of code. Ansible's core is a little over 1000 lines. -While `Func installation `_ which I -co-wrote, aspired to avoid using SSH and have it's own daemon -infrastructure, Ansible aspires to be quite different and more -minimal, but still able to grow more modularly over time. This is -based on talking to a lot of users of various tools and wishing to -eliminate problems with connectivity and long running daemons, or not -picking tool `X` because they preferred to code in `Y`. Further, -playbooks take things a whole step further, building the config and -deployment system I always wanted to build. +Ansible isn't just for configuration -- it's also great for Ad-Hoc tasks, +quickly firing off commands against nodes. Where Ansible excels though, is expressing complex multi-node deployment processes, executing complex sequences of commands on different hosts through the "playbooks" feature. -Why use Ansible versus something else? (Fabric, Capistrano, +Ansible does not require programming in any particular language -- you can write modules +as scripts or programs that return simple JSON. + +Why use Ansible versus something else? (Puppet, Chef, Fabric, Capistrano, mCollective, Func, SaltStack, etc?) It will have far less code, it will be more correct, and it will be the easiest thing to hack on and use you'll ever see -- regardless of your favorite language of choice. -Want to only code plugins in bash or clojure? Ansible doesn't care. -The docs will fit on one page and the source will be blindingly -obvious. +Systems management doesn't have to be complicated. Ansible's docs will remain +short & simple, and the source will be blindingly obvious. -Design Principles -````````````````` +Design Goals +```````````` * Dead simple setup * Super fast & parallel by default -* No server or client daemons; use existing SSHd +* No server or client daemons; use existing SSHd out of the box * No additional software required on client boxes * Modules can be written in ANY language * Awesome API for creating very powerful distributed scripts * Be usable as non-root * Create the easiest config management system to use, ever. +About the Author +```````````````` -Requirements -```````````` - -Requirements are extremely minimal. - -If you are running python 2.6 on the **overlord** machine, you will -need: - -* ``paramiko`` -* ``PyYAML`` -* ``python-jinja2`` (for playbooks) -* ``Asciidoc`` (for building documentation) - -If you are running less than Python 2.6, you will also need: - -* The Python 2.4 or 2.5 backport of the ``multiprocessing`` module - - - `Installation and Testing Instructions `_ - -* ``simplejson`` - -On the managed nodes, to use templating, you will need: - -* ``python-jinja2`` (you can install this with ansible) - - -Getting Ansible -``````````````` - -Tagged releases are available as tar.gz files from the Ansible github -project page: +Michael DeHaan is a Raleigh, NC based software developer and architect. He created other +DevOps programs such as Cobbler, the popular Linux install server. +Cobbler is used to deploy mission critical systems all over the planet, in industries +ranging from massively multiplayer gaming, core internet infrastructure, finance, +chip design, and more. Michael also helped co-author of Func, which is used +to orchestrate systems in lots of diverse places. -* `Ansible/downloads `_ - -You can also clone the git repository yourself and install Ansible in -one of two ways: - - -Python Distutils -++++++++++++++++ - -You can install Ansible using Python Distutils:: - - $ git clone git://github.com/ansible/ansible.git - $ cd ./ansible - $ sudo make install - - -Via RPM -+++++++ - -In the future, pre-built RPMs may be available. Until that time you -can use the ``make rpm`` command:: - - $ git clone git://github.com/ansible/ansible.git - $ cd ./ansible - $ make rpm - $ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm - +Ansible is an GPLv3 licensed open source project, so see the contributions section for how to +get involved. Contents ======== @@ -109,21 +55,11 @@ Contents :maxdepth: 3 gettingstarted - YAMLScripts patterns modules + YAMLScripts playbooks examples api communicate man - - -Communicate or Get Involved -=========================== - -* Join the `ansible-project mailing list `_ on Google Groups -* Join `#ansible `_ on the `freenode IRC network `_ -* Visit the `project page `_ on Github - - - View the `issue tracker `_ diff --git a/html/_sources/man.txt b/html/_sources/man.txt index d25477bf110..41dd4e650ee 100644 --- a/html/_sources/man.txt +++ b/html/_sources/man.txt @@ -3,19 +3,10 @@ Man Pages ========= -Ansile ships with a handfull of manpages to help you on your journey. +Ansible's manpage lists available command line options. ansible(1) ---------- * `View ansible.1 `_ -ansible-modules(5) ------------------- - -* `View ansible-modules.5 `_ - -ansible-playbook(5) -------------------- - -* `View ansible-playbook.5 `_ diff --git a/html/_sources/modules.txt b/html/_sources/modules.txt index b303ee6ccb2..540aad2bf7d 100644 --- a/html/_sources/modules.txt +++ b/html/_sources/modules.txt @@ -1,55 +1,201 @@ -Modules -======= - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +Ansible Modules +=============== + +.. seealso:: + + :doc:`examples` + Examples of using modules in /usr/bin/ansible + :doc:`playbooks` + Examples of using modules with /usr/bin/ansible-playbook + :doc:`api` + Examples of using modules with the Python API + + +About Modules +````````````` + +Ansible ships with a number of modules that can be executed directly on remote hosts or through +ansible playbooks. + + +Idempotence +``````````` + +Most modules other than command are idempotent, meaning they will seek to avoid changes +unless a change needs to be made. When using ansible playbooks, these modules can +trigger change events. Unless otherwise noted, all modules support change hooks. + + +command +``````` + +The command module takes the command name followed by a list of arguments, space delimited. +This is the only module that does not use key=value style parameters. + +Example usage:: + + /sbin/shutdown -t now + +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. + + +copy +```` + +The copy module moves a file on the local box to remote locations. + +*src*:: + +Local absolute path to a file to copy to the remote server + + +*dest*:: + +Remote absolute path where the file should end up + + +This module also returns md5sum information about the resultant file. + + +facter +`````` + +Runs the discovery program 'facter' on the remote system, returning +JSON data that can be useful for inventory purposes. + +Requires that 'facter' and 'ruby-json' be installed on the remote end. + +This module is informative only - it takes no parameters & does not support change hooks, +nor does it make any changes on the system. + + +git +``` + +Deploys software from git checkouts. + +*repo*:: + +git or http protocol address of the repo to checkout + +*dest*:: + +where to check it out, an absolute directory path + +*version*:: + +what version to check out -- either the git SHA, the literal string 'HEAD', or a tag name + + +ohai +```` + +Similar to the facter module, this returns JSON inventory data. Ohai +data is a bit more verbose and nested than facter. + +Requires that 'ohai' be installed on the remote end. + +This module is information only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system. + + +ping +```` + +A trivial test module, this module always returns the integer '1' on +successful contact. + +This module does not support change hooks. + +This module is informative only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system. + + +service +``````` + +Controls services on remote machines. + +*state* + +Values are 'started', 'stopped', or 'restarted'. Started/stopped +are idempotent actions that will not run commands unless neccessary. +'restarted' will always bounce the service + + +*name* + +The name of the service + + +setup +````` + +Writes a JSON file containing key/value data, for use in templating. +Call this once before using the template modules. Playbooks will +execute this module automatically as the first step in each play. + +If facter or ohai are installed, variables from these programs will also +be snapshotted into the JSON file for usage in templating. These variables +are prefixed with 'facter_' and 'ohai_" so it's easy to tell their source. + +*metadata* + +Optionally overrides the default JSON file location of /etc/ansible/setup or ~/ansible/setup +depending on what remote user has been specified. + +If used, also supply the metadata parameter to the template module. + +*anything* + +any other parameters can be named basically anything, and set a key=value +pair in the JSON file for use in templating. + + +template +```````` + +Templates a file out to a remote server. Call the setup module prior to usage. + +*src* + +path of a Jinja2 formatted template on the local server + + +*dest* + +location to render the template on the remote server + + +*metadata* + +location of a JSON file to use to supply template data. Default is /etc/ansible/setup +which is the same as the default for the setup module. Change if running as a non-root +remote user who does not have permissions on /etc/ansible. + + +This module also returns md5sum information about the resultant file. + + +user +```` + +This module is in plan. + + +yum +``` + +This module is in plan. + + +WRITING YOUR OWN MODULES +```````````````````````` + +To write your own modules, simply follow the convention of those already available in +/usr/share/ansible. Modules must return JSON but can be written in any language. +Modules should return hashes, but hashes can be nested. +To support change hooks, modules should return hashes with a changed: True/False +element at the top level. Modules can also choose to indicate a failure scenario +by returning a top level 'failure' element with a True value, and a 'msg' element +describing the nature of the failure. Other values are up to the module. diff --git a/html/_sources/patterns.txt b/html/_sources/patterns.txt index d0ae6b5d37d..6b73114199e 100644 --- a/html/_sources/patterns.txt +++ b/html/_sources/patterns.txt @@ -1,55 +1,69 @@ Patterns ======== -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +How to select hosts you wish to manage + +.. seealso:: + + :doc:`examples` + Examples of basic commands + :doc:`playbooks` + Learning ansible's configuration management language + +Ansible works against multiple systems in your infrastructure at the +same time. It does this by selecting portions of systems listed in Ansible's inventory file, +which defaults to /etc/ansible/hosts, and looks like this:: + + mail.example.com + + [webservers] + foo.example.com + bar.example.com + + [dbservers] + one.example.com + two.example.com + three.example.com + +Targetting All Systems +`````````````````````` + +The pattern 'all' or '*' targets all systems in the inventory file. + +Specific Hosts +`````````````` + +It is possible to address specific hosts: + + one.example.com + one.example.com:two.example.com + +Groups +`````` + +The following patterns address one or more groups: + + webservers + webservers:dbservers + +There is also a magic group 'ungrouped' which selects systems not in a group. + +Wildcards +````````` + +Individual hosts, but not groups, can also be referenced using wildcards: + + *.example.com + *.com + +Mixing Things Up +```````````````` + +Specific hosts, wildcards, and groups can all be mixed in the same pattern + + one*.com:dbservers + +It is not possible to target a host not in the inventory file. + + + diff --git a/html/_sources/playbooks.txt b/html/_sources/playbooks.txt index 677403b5bc6..065005b94e8 100644 --- a/html/_sources/playbooks.txt +++ b/html/_sources/playbooks.txt @@ -1,55 +1,118 @@ Playbooks ========= -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +.. seealso:: + + :doc:`YAMLScripts` + Learn about YAML syntax + :doc:`modules` + Learn about available modules and writing your own + :doc:`patterns` + Learn about how to select hosts + + +Playbooks are a completely different way to use ansible and are particularly awesome. + +They are the basis for a really simple configuration management and deployment system, unlike any that already exist, and one that is very well suited to deploying complex multi-machine applications. While you might run the main ansible program for ad-hoc tasks, playbooks are more likely to be kept in source control and used to push out your configuration or assure the configurations of your remote systems are in spec. + + +Playbook Example +```````````````` + +Playbooks are expressed in YAML format and have a minimum of syntax. Each playbook is composed +of one or more patterns in a list. By composing a playbook of multiple patterns, it is possible +to orchestrate multi-machine deployments, running certain steps on all machines in +the webservers group, then certain steps on the database server group, then more commands +back on the webservers group, etc:: + +--- +- hosts: all + vars: + http_port: 80 + max_clients: 200 + user: root + tasks: + - include: base.yml somevar=3 othervar=4 + - name: write the apache config file + action: template src=/srv/httpd.j2 dest=/etc/httpd.conf + notify: + - restart apache + - name: ensure apache is running + action: service name=httpd state=started + handlers: + - include: handlers.yml + +Hosts line +`````````` + +The hosts line is alist of one or more groups or host patterns, seperated by colons. + + webservers:dbservers:*.foo.example.com + +Vars section +```````````` + +A list of variables that can be used in the 'action' lines of the template, or in +included templates. Variables are deferenced like this:: + + {{ varname }} + +These variables will be pushed down to the managed systems for use in templating operations. + +Further, if there are discovered variables about the system (say, if facter or ohai were +installed) these variables bubble up back into the playbook, and can be used on each +system just like explicitly set variables. Facter variables are prefixed with 'facter' +and Ohai variables are prefixed with 'ohai'. + +Tasks list +`````````` + +Tasks are executed in order, one at a time, against all machines matched by the host +pattern, before moving on to the next task. Failed tasks are taken out of the rotation. + +Task name and comment +````````` + +Each task has a name (required) and optional comment. This is for informational purposes only + +Task action +``````````` + +The action line is the name of an ansible module followed by parameters. Usually these +are expressed in key=value form, except for the command module, which looks just like a Linux/Unix +command line. See the module documentation for more info. + +Notify statements +````````````````` + +Nearly all modules are written to be 'idempotent' and can signal when they have affected a change +on the remote system. If a notify statement is used, the named handler will be run against +each system where a change was effected, but NOT on systems where no change occurred. + +Handlers +```````` + +Handlers are lists of tasks, not really any different from regular tasks, that are referenced +by name. + +Includes +```````` + +Not all tasks have to be listed directly in the main file. An include file can contain +a list of tasks (in YAML) as well, optionally passing extra variables into the file. +Variables passed in can be deferenced like this: + + {{ variable }} + +Asynchronous Actions and Polling +```````````````````````````````` + +(Information on this feature is pending) + +Executing A Playbook +```````````````````` + +To run a playbook:: + + ansible-playbook playbook.yml + 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 cbefb35547f..92aa0ccbf7f 100644 --- a/html/api.html +++ b/html/api.html @@ -23,7 +23,7 @@ - + @@ -34,7 +34,7 @@ index
  • - next |

  • API

    -

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor.

    -

    Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra.

    -

    Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue.

    -

    In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper.

    -

    Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat.

    +

    The Python API is very powerful, and is how the ansible CLI and ansible-playbook +are implemented.

    +

    It’s pretty simple:

    +
    import ansible.runner
+
+runner = ansible.runner.Runner(
+   module_name='ping',
+   module_args='',
+   pattern='web*',
+   forks=10
+)
+datastructure = runner.run()
+
    +
    +

    The run method returns results per host, grouped by whether they +could be contacted or not. Return types are module specific, as +expressed in the ‘ansible-modules’ documentation.:

    +
    {
+    "dark" : {
+       "web1.example.com" : "failure message"
+    }
+    "contacted" : {
+       "web2.example.com" : 1
+    }
+}
    +
    +

    A module can return any type of JSON data it wants, so Ansible can +be used as a framework to rapidly build powerful applications and scripts.

    • @@ -111,7 +91,7 @@ hendrerit mi tincidunt dui fermentum placerat.

    title="previous chapter">Examples

    Next topic

    Communicate

    + title="next chapter">Communicate and Get Involved

    This Page

    © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
    \ No newline at end of file diff --git a/html/communicate.html b/html/communicate.html index c6260025219..7ad2a0c23a1 100644 --- a/html/communicate.html +++ b/html/communicate.html @@ -7,7 +7,7 @@ - Communicate — Ansible v0.0.1 documentation + Communicate and Get Involved — Ansible v0.0.1 documentation - + @@ -34,7 +34,7 @@ index
  • - next |

  • Getting Started

    -

    How to ansible

    +

    How to download ansible and get started using it

    See also

    +
    Examples
    +
    Examples of basic commands
    YAML Scripts
    -
    Complete documentation of the YAML syntax ansible understands.
    +
    Complete documentation of the YAML syntax ansible understands for playbooks.
    +
    Playbooks
    +
    Learning ansible’s configuration management language
    +
    Ansible Modules
    +
    Learn about modules that ship with ansible
    -
    -

    What you need

    -

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor.

    -

    Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra.

    -

    Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue.

    -

    In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper.

    -

    Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat.

    +
    +

    Requirements

    +

    Requirements are extremely minimal.

    +

    If you are running python 2.6 on the overlord machine, you will +need:

    +
      +
    • paramiko
      • +
    • PyYAML
      • +
    • python-jinja2 (for playbooks)
      • +
    +

    If you are running less than Python 2.6, you will also need:

    + +

    On the managed nodes, to use templating, you will need:

    +
      +
    • python-jinja2 (you can install this with ansible)
      • +
    +
    +
    +

    Developer Requirements

    +

    For developers, you may wish to have:

    +
      +
    • asciidoc (for building manpage documentation)
      • +
    • python-sphinx (for building content for ansible.github.com)
      • +
    +
    +
    +

    Getting Ansible

    +

    Tagged releases are available as tar.gz files from the Ansible github +project page:

    + +

    You can also clone the git repository yourself and install Ansible in +one of two ways:

    +
    +

    Python Distutils

    +

    You can also install Ansible using Python Distutils:

    +
    $ git clone git://github.com/ansible/ansible.git
+$ cd ./ansible
+$ sudo make install
    +
    +
    +
    +

    Via RPM

    +

    In the near future, pre-built RPMs will be available through your distribution. Until that time you +can use the make rpm command:

    +
    $ git clone git://github.com/ansible/ansible.git
+$ cd ./ansible
+$ make rpm
+$ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm
    +
    +
    +
    +
    +

    Your first commands

    +

    Edit /etc/ansible/hosts and put one or more remote systems in it, for which you have your SSH +key in authorized_keys:

    +
    192.168.1.50
+aserver.example.org
+bserver.example.org
    +
    +

    Now try this:

    +
    +
    ssh-agent bash +ssh-add ~/.ssh/id_rsa +ansible all -m ping
    +

    Congratulations. You’ve just contacted your nodes with Ansible. It’s now time to read some +of the more real-world examples.

    @@ -120,7 +150,14 @@ hendrerit mi tincidunt dui fermentum placerat.

    Table Of Contents

    @@ -129,8 +166,8 @@ hendrerit mi tincidunt dui fermentum placerat.

    Ansible

    Next topic

    -

    YAML Scripts

    +

    Patterns

    This Page

    @@ -46,25 +46,13 @@

    Man Pages

    -

    Ansile ships with a handfull of manpages to help you on your journey.

    +

    Ansible’s manpage lists available command line options.

    ansible(1)

    -
    -

    ansible-modules(5)

    - -
    -
    -

    ansible-playbook(5)

    - -
    @@ -77,15 +65,13 @@

    Previous topic

    Communicate

    + title="previous chapter">Communicate and Get Involved

    This Page

    © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
    \ No newline at end of file diff --git a/html/man/ansible-modules.5.html b/html/man/ansible-modules.5.html index 1a16ddec0ea..e9f992b290e 100644 --- a/html/man/ansible-modules.5.html +++ b/html/man/ansible-modules.5.html @@ -1,6 +1,6 @@ -ansible-modules

    Name

    ansible-modules — stock modules shipped with ansible

    DESCRIPTION

    Ansible ships with a number of modules that can be executed directly on remote hosts or through +ansible-modules

    Name

    ansible-modules — stock modules shipped with ansible

    DESCRIPTION

    Ansible ships with a number of modules that can be executed directly on remote hosts or through ansible playbooks.

    IDEMPOTENCE

    Most modules other than command are idempotent, meaning they will seek to avoid changes unless a change needs to be made. When using ansible playbooks, these modules can trigger change events, as described in ansible-playbooks(5).

    Unless otherwise noted, all modules support change hooks.

    command

    The command module takes the command name followed by a list of arguments, space delimited. diff --git a/html/man/ansible-playbook.5.html b/html/man/ansible-playbook.5.html index 8c4b8c1d355..ad1d534af30 100644 --- a/html/man/ansible-playbook.5.html +++ b/html/man/ansible-playbook.5.html @@ -1,6 +1,6 @@ -ansible-modules

    Name

    ansible-playbook — format and function of an ansible playbook file

    DESCRIPTION

    Ansible ships with ansible-playbook, a tool for running playbooks. +ansible-modules

    Name

    ansible-playbook — format and function of an ansible playbook file

    DESCRIPTION

    Ansible ships with ansible-playbook, a tool for running playbooks. Playbooks can represent frequent tasks, desired system configurations, or deployment processes.

    FORMAT

    Playbooks are written in YAML.

    EXAMPLE

    See:

    • https://github.com/mpdehaan/ansible/blob/master/examples/playbook.yml diff --git a/html/man/ansible.1.html b/html/man/ansible.1.html index c2c76bfaccb..ba76d1444f1 100644 --- a/html/man/ansible.1.html +++ b/html/man/ansible.1.html @@ -1,6 +1,6 @@ -ansible

      Name

      ansible — run a command somewhere else

      Synopsis

      ansible <host-pattern> [-f forks] [-m module_name] [-a args]

      DESCRIPTION

      Ansible is an extra-simple tool/framework/API for doing 'remote things' over +ansible

      Name

      ansible — run a command somewhere else

      Synopsis

      ansible <host-pattern> [-f forks] [-m module_name] [-a args]

      DESCRIPTION

      Ansible is an extra-simple tool/framework/API for doing 'remote things' over SSH.

      ARGUMENTS

      host-pattern
      diff --git a/html/modules.html b/html/modules.html index 88a446519e9..7c2a1569016 100644 --- a/html/modules.html +++ b/html/modules.html @@ -7,7 +7,7 @@ - Modules — Ansible v0.0.1 documentation + Ansible Modules — Ansible v0.0.1 documentation - + @@ -34,7 +34,7 @@ index
    • - next |
    • -
      -

      Modules

      -

      Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor.

      -

      Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra.

      -

      Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue.

      -

      In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper.

      -

      Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat.

      +
      +

      Ansible Modules

      +
      +

      See also

      +
      +
      Examples
      +
      Examples of using modules in /usr/bin/ansible
      +
      Playbooks
      +
      Examples of using modules with /usr/bin/ansible-playbook
      +
      API
      +
      Examples of using modules with the Python API
      +
      +
      +
      +

      About Modules

      +

      Ansible ships with a number of modules that can be executed directly on remote hosts or through +ansible playbooks.

      +
      +
      +

      Idempotence

      +

      Most modules other than command are idempotent, meaning they will seek to avoid changes +unless a change needs to be made. When using ansible playbooks, these modules can +trigger change events. Unless otherwise noted, all modules support change hooks.

      +
      +
      +

      command

      +

      The command module takes the command name followed by a list of arguments, space delimited. +This is the only module that does not use key=value style parameters.

      +

      Example usage:

      +
      /sbin/shutdown -t now
      +
      +

      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.

      +
      +
      +

      copy

      +

      The copy module moves a file on the local box to remote locations.

      +

      src:

      +

      Local absolute path to a file to copy to the remote server

      +

      dest:

      +

      Remote absolute path where the file should end up

      +

      This module also returns md5sum information about the resultant file.

      +
      +
      +

      facter

      +

      Runs the discovery program ‘facter’ on the remote system, returning +JSON data that can be useful for inventory purposes.

      +

      Requires that ‘facter’ and ‘ruby-json’ be installed on the remote end.

      +

      This module is informative only - it takes no parameters & does not support change hooks, +nor does it make any changes on the system.

      +
      +
      +

      git

      +

      Deploys software from git checkouts.

      +

      repo:

      +

      git or http protocol address of the repo to checkout

      +

      dest:

      +

      where to check it out, an absolute directory path

      +

      version:

      +

      what version to check out – either the git SHA, the literal string ‘HEAD’, or a tag name

      +
      +
      +

      ohai

      +

      Similar to the facter module, this returns JSON inventory data. Ohai +data is a bit more verbose and nested than facter.

      +

      Requires that ‘ohai’ be installed on the remote end.

      +

      This module is information only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system.

      +
      +
      +

      ping

      +

      A trivial test module, this module always returns the integer ‘1’ on +successful contact.

      +

      This module does not support change hooks.

      +

      This module is informative only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system.

      +
      +
      +

      service

      +

      Controls services on remote machines.

      +

      state

      +

      Values are ‘started’, ‘stopped’, or ‘restarted’. Started/stopped +are idempotent actions that will not run commands unless neccessary. +‘restarted’ will always bounce the service

      +

      name

      +

      The name of the service

      +
      +
      +

      setup

      +

      Writes a JSON file containing key/value data, for use in templating. +Call this once before using the template modules. Playbooks will +execute this module automatically as the first step in each play.

      +

      If facter or ohai are installed, variables from these programs will also +be snapshotted into the JSON file for usage in templating. These variables +are prefixed with ‘facter‘ and ‘ohai” so it’s easy to tell their source.

      +

      metadata

      +

      Optionally overrides the default JSON file location of /etc/ansible/setup or ~/ansible/setup +depending on what remote user has been specified.

      +

      If used, also supply the metadata parameter to the template module.

      +

      anything

      +

      any other parameters can be named basically anything, and set a key=value +pair in the JSON file for use in templating.

      +
      +
      +

      template

      +

      Templates a file out to a remote server. Call the setup module prior to usage.

      +

      src

      +

      path of a Jinja2 formatted template on the local server

      +

      dest

      +

      location to render the template on the remote server

      +

      metadata

      +

      location of a JSON file to use to supply template data. Default is /etc/ansible/setup +which is the same as the default for the setup module. Change if running as a non-root +remote user who does not have permissions on /etc/ansible.

      +

      This module also returns md5sum information about the resultant file.

      +
      +
      +

      user

      +

      This module is in plan.

      +
      +
      +

      yum

      +

      This module is in plan.

      +
      +
      +

      WRITING YOUR OWN MODULES

      +

      To write your own modules, simply follow the convention of those already available in +/usr/share/ansible. Modules must return JSON but can be written in any language. +Modules should return hashes, but hashes can be nested. +To support change hooks, modules should return hashes with a changed: True/False +element at the top level. Modules can also choose to indicate a failure scenario +by returning a top level ‘failure’ element with a True value, and a ‘msg’ element +describing the nature of the failure. Other values are up to the module.

      +
      @@ -106,12 +189,33 @@ hendrerit mi tincidunt dui fermentum placerat.

      +

      Table Of Contents

      + +

      Previous topic

      Patterns

      Next topic

      -

      Playbooks

      +

      YAML Scripts

      This Page

      © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
      \ No newline at end of file diff --git a/html/patterns.html b/html/patterns.html index 2a4d00a68a7..b421d63923b 100644 --- a/html/patterns.html +++ b/html/patterns.html @@ -23,8 +23,8 @@ - - + +
      @@ -34,10 +34,10 @@ index
    • - next |
    • - previous |
    • Ansible v0.0.1 documentation »
    @@ -50,54 +50,64 @@

    Patterns

    -

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor.

    -

    Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra.

    -

    Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue.

    -

    In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper.

    -

    Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat.

    +

    How to select hosts you wish to manage

    +
    +

    See also

    +
    +
    Examples
    +
    Examples of basic commands
    +
    Playbooks
    +
    Learning ansible’s configuration management language
    +
    +
    +

    Ansible works against multiple systems in your infrastructure at the +same time. It does this by selecting portions of systems listed in Ansible’s inventory file, +which defaults to /etc/ansible/hosts, and looks like this:

    +
    mail.example.com
+
+[webservers]
+foo.example.com
+bar.example.com
+
+[dbservers]
+one.example.com
+two.example.com
+three.example.com
+
    +
    +
    +

    Targetting All Systems

    +

    The pattern ‘all’ or ‘*’ targets all systems in the inventory file.

    +
    +
    +

    Specific Hosts

    +

    It is possible to address specific hosts:

    +
    +
    one.example.com +one.example.com:two.example.com
    +
    +
    +

    Groups

    +

    The following patterns address one or more groups:

    +
    +
    webservers +webservers:dbservers
    +

    There is also a magic group ‘ungrouped’ which selects systems not in a group.

    +
    +
    +

    Wildcards

    +

    Individual hosts, but not groups, can also be referenced using wildcards:

    +
    +
    *.example.com +*.com
    +
    +
    +

    Mixing Things Up

    +

    Specific hosts, wildcards, and groups can all be mixed in the same pattern

    +
    +
    one*.com:dbservers
    +

    It is not possible to target a host not in the inventory file.

    +
    @@ -106,12 +116,24 @@ hendrerit mi tincidunt dui fermentum placerat.

    +

    Table Of Contents

    + +

    Previous topic

    -

    YAML Scripts

    +

    Getting Started

    Next topic

    Modules

    + title="next chapter">Ansible Modules

    This Page

    © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
    \ No newline at end of file diff --git a/html/playbooks.html b/html/playbooks.html index be57c481344..57231156664 100644 --- a/html/playbooks.html +++ b/html/playbooks.html @@ -24,7 +24,7 @@ - +
    @@ -37,7 +37,7 @@ next |
  • - previous |
  • Ansible v0.0.1 documentation »
    • @@ -50,54 +50,118 @@

    Playbooks

    -

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor.

    -

    Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra.

    -

    Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue.

    -

    In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper.

    -

    Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat.

    +
    +

    See also

    +
    +
    YAML Scripts
    +
    Learn about YAML syntax
    +
    Ansible Modules
    +
    Learn about available modules and writing your own
    +
    Patterns
    +
    Learn about how to select hosts
    +
    +
    +

    Playbooks are a completely different way to use ansible and are particularly awesome.

    +

    They are the basis for a really simple configuration management and deployment system, unlike any that already exist, and one that is very well suited to deploying complex multi-machine applications. While you might run the main ansible program for ad-hoc tasks, playbooks are more likely to be kept in source control and used to push out your configuration or assure the configurations of your remote systems are in spec.

    +
    +

    Playbook Example

    +

    Playbooks are expressed in YAML format and have a minimum of syntax. Each playbook is composed +of one or more patterns in a list. By composing a playbook of multiple patterns, it is possible +to orchestrate multi-machine deployments, running certain steps on all machines in +the webservers group, then certain steps on the database server group, then more commands +back on the webservers group, etc:

    +
    ---
+- hosts: all
    +
    +
    +
    +
    vars:
    +
    http_port: 80 +max_clients: 200
    +
    +

    user: root +tasks: +- include: base.yml somevar=3 othervar=4 +- name: write the apache config file

    +
    +
    action: template src=/srv/httpd.j2 dest=/etc/httpd.conf +notify: +- restart apache
    +
      +
    • name: ensure apache is running +action: service name=httpd state=started
      • +
    +
    +
    handlers:
    +
      +
    • include: handlers.yml
      • +
    +
    +
    +
    +
    +
    +

    Hosts line

    +

    The hosts line is alist of one or more groups or host patterns, seperated by colons.

    +
    +
    webservers:dbservers:*.foo.example.com
    +
    +
    +

    Vars section

    +

    A list of variables that can be used in the ‘action’ lines of the template, or in +included templates. Variables are deferenced like this:

    +
    {{ varname }}
    +
    +

    These variables will be pushed down to the managed systems for use in templating operations.

    +

    Further, if there are discovered variables about the system (say, if facter or ohai were +installed) these variables bubble up back into the playbook, and can be used on each +system just like explicitly set variables. Facter variables are prefixed with ‘facter’ +and Ohai variables are prefixed with ‘ohai’.

    +
    +
    +

    Tasks list

    +

    Tasks are executed in order, one at a time, against all machines matched by the host +pattern, before moving on to the next task. Failed tasks are taken out of the rotation.

    +
    +
    +

    Task name and comment

    +

    Each task has a name (required) and optional comment. This is for informational purposes only

    +
    +
    +

    Task action

    +

    The action line is the name of an ansible module followed by parameters. Usually these +are expressed in key=value form, except for the command module, which looks just like a Linux/Unix +command line. See the module documentation for more info.

    +
    +
    +

    Notify statements

    +

    Nearly all modules are written to be ‘idempotent’ and can signal when they have affected a change +on the remote system. If a notify statement is used, the named handler will be run against +each system where a change was effected, but NOT on systems where no change occurred.

    +
    +
    +

    Handlers

    +

    Handlers are lists of tasks, not really any different from regular tasks, that are referenced +by name.

    +
    +
    +

    Includes

    +

    Not all tasks have to be listed directly in the main file. An include file can contain +a list of tasks (in YAML) as well, optionally passing extra variables into the file. +Variables passed in can be deferenced like this:

    +
    +
    {{ variable }}
    +
    +
    +

    Asynchronous Actions and Polling

    +

    (Information on this feature is pending)

    +
    +
    +

    Executing A Playbook

    +

    To run a playbook:

    +
    ansible-playbook playbook.yml
    +
    +
    @@ -106,9 +170,27 @@ hendrerit mi tincidunt dui fermentum placerat.

    +

    Table Of Contents

    + +

    Previous topic

    -

    Modules

    +

    YAML Scripts

    Next topic

    Examples

    @@ -120,7 +202,7 @@ hendrerit mi tincidunt dui fermentum placerat.

    © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
    \ No newline at end of file diff --git a/html/search.html b/html/search.html index 66351de19bc..e870053d704 100644 --- a/html/search.html +++ b/html/search.html @@ -90,8 +90,8 @@
    © Copyright 2012 Michael DeHaan. - Last updated on Mar 07, 2012. - Created using Sphinx 1.0.7. + Last updated on Mar 08, 2012. + Created using Sphinx 1.0.8.
    \ No newline at end of file diff --git a/html/searchindex.js b/html/searchindex.js index a0bf1f8f129..418bbdb16db 100644 --- a/html/searchindex.js +++ b/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:5,rhoncu:[0,2,3,4,6,7,8],donec:[0,2,3,4,6,7,8],mcollect:1,code:1,lacu:[0,2,3,4,6,7,8],nunc:[0,2,3,4,6,7,8],vel:[0,2,3,4,6,7,8],blindingli:1,sourc:1,everi:5,fals:5,consequat:[0,2,3,4,6,7,8],veri:1,risu:[0,2,3,4,6,7,8],luctu:[0,2,3,4,6,7,8],level:5,list:[5,1],vivamu:[0,2,3,4,6,7,8],item:5,dotnet:5,saltstack:1,phasellu:[0,2,3,4,6,7,8],ornar:[0,2,3,4,6,7,8],second:5,design:1,eleifend:[0,2,3,4,6,7,8],further:1,what:[0,1],diam:[0,2,3,4,6,7,8],abl:1,nec:[0,2,3,4,6,7,8],abbrevi:5,ever:1,elimin:1,eckersberg:5,leo:[0,2,3,4,6,7,8],valu:5,aliquam:[0,2,3,4,6,7,8],box:1,larger:1,adipisc:[0,2,3,4,6,7,8],venenati:[0,2,3,4,6,7,8],permit:5,nulla:[0,2,3,4,6,7,8],iaculi:[0,2,3,4,6,7,8],via:1,regardless:[5,1],tempu:[0,2,3,4,6,7,8],extra:1,modul:[1,2,9],prefer:1,qui:[0,2,3,4,6,7,8],api:[1,7],instal:1,should:5,from:1,tar:1,commun:[1,3],visit:1,two:[5,1],noarch:1,sagitti:[0,2,3,4,6,7,8],until:1,more:1,nequ:[0,2,3,4,6,7,8],sshd:1,easiest:1,must:5,join:1,habitass:[0,2,3,4,6,7,8],setup:1,can:[5,1],ero:[0,2,3,4,6,7,8],root:[5,1],employe:5,yamllint:5,ultric:[0,2,3,4,6,7,8],sudo:1,templat:1,knows_oop:5,tag:1,want:1,nullam:[0,2,3,4,6,7,8],alwai:1,newlin:5,puru:[0,2,3,4,6,7,8],lame:5,capistrano:1,write:5,how:0,etiam:[0,2,3,4,6,7,8],config:1,arcu:[0,2,3,4,6,7,8],clone:1,usabl:1,tristiqu:[0,2,3,4,6,7,8],mai:1,associ:5,grow:1,man:[1,9],github:1,sit:[0,2,3,4,6,7,8],favorit:1,turpi:[0,2,3,4,6,7,8],element:5,issu:1,mango:5,combin:5,talk:1,help:9,over:1,orang:5,becaus:1,elit:[0,2,3,4,5,6,7,8],rpmbuild:1,comma:5,vita:[0,2,3,4,6,7,8],still:1,overlord:1,group:1,fit:1,yaml:[5,0,1],infrastructur:1,mail:1,sapien:[0,2,3,4,6,7,8],non:[0,1,2,3,4,6,7,8],thei:1,food:5,nibh:[0,2,3,4,6,7,8],egesta:[0,2,3,4,6,7,8],jinja2:1,choic:1,multiprocess:1,name:5,simpl:[5,1],viverra:[0,2,3,4,6,7,8],porta:[0,2,3,4,6,7,8],separ:5,each:5,metu:[0,2,3,4,6,7,8],auctor:[0,2,3,4,6,7,8],realli:5,backport:1,connect:1,out:5,network:1,content:1,correct:[5,1],hendrerit:[0,2,3,4,6,7,8],base:1,dictionari:5,morbi:[0,2,3,4,6,7,8],molli:[0,2,3,4,6,7,8],bash:1,care:1,vestibulum:[0,2,3,4,6,7,8],pyyaml:1,indent:5,maecena:[0,2,3,4,6,7,8],thing:1,principl:1,fusc:[0,2,3,4,6,7,8],softwar:1,obviou:1,yourself:1,instruct:1,"long":1,enim:[0,2,3,4,6,7,8],differ:1,script:[5,0,1],data:5,system:1,parallel:1,molesti:[0,2,3,4,6,7,8],john:5,banana:5,option:5,tool:1,specifi:5,quam:[0,2,3,4,6,7,8],accumsan:[0,2,3,4,6,7,8],serv:1,provid:5,sollicitudin:[0,2,3,4,6,7,8],structur:5,charact:5,faucibu:[0,2,3,4,6,7,8],uses_cv:5,pre:1,ani:1,ant:[0,2,3,4,6,7,8],download:1,have:1,need:[5,0,1],tellu:[0,2,3,4,6,7,8],paramiko:1,built:1,also:[5,0,1],client:1,massa:[0,2,3,4,6,7,8],take:1,which:1,pulvinar:[0,2,3,4,6,7,8],begin:5,distribut:1,deploy:1,most:5,why:1,augu:[0,2,3,4,6,7,8],doc:1,lectu:[0,2,3,4,6,7,8],sodal:[0,2,3,4,6,7,8],likes_emac:5,clojur:1,dolor:[0,2,3,4,6,7,8],modularli:1,awesom:1,laoreet:[0,2,3,4,6,7,8],blandit:[0,2,3,4,6,7,8],syntax:[5,0],playbook:[1,4,9],hack:1,involv:1,onli:1,configur:1,releas:1,than:1,consectetur:[0,2,3,4,6,7,8],variu:[0,2,3,4,6,7,8],variou:1,get:[5,0,1],bibendum:[0,2,3,4,6,7,8],ssh:1,malesuada:[0,2,3,4,6,7,8],requir:1,uvh:1,nisi:[0,2,3,4,6,7,8],nisl:[0,2,3,4,6,7,8],remot:1,cra:[0,2,3,4,6,7,8],orci:[0,2,3,4,6,7,8],wrote:1,view:[1,9],suscipit:[0,2,3,4,6,7,8],see:[5,0,1],sed:[0,2,3,4,6,7,8],sem:[0,2,3,4,6,7,8],project:1,manpag:9,pattern:[1,6],someth:1,written:1,ligula:[0,2,3,4,6,7,8],between:5,irc:1,elementum:[0,2,3,4,6,7,8],kei:5,handful:9,aspir:1,job:5,magna:[0,2,3,4,6,7,8],amet:[0,2,3,4,6,7,8],addit:[5,1],plugin:1,tempor:[0,2,3,4,6,7,8],etc:1,placerat:[0,2,3,4,6,7,8],com:1,proin:[0,2,3,4,6,7,8],overview:5,rpm:1,matti:[0,2,3,4,6,7,8],quit:1,pretium:[0,2,3,4,6,7,8],suspendiss:[0,2,3,4,6,7,8],basic:[5,1],feugiat:[0,2,3,4,6,7,8],scelerisqu:[0,2,3,4,6,7,8],rubi:5,vulput:[0,2,3,4,6,7,8],understand:0,pellentesqu:[0,2,3,4,6,7,8],func:1,emploi:5,tortor:[0,2,3,4,6,7,8],"while":1,dictum:[0,2,3,4,6,7,8],erat:[0,2,3,4,6,7,8],sever:5,develop:5,minim:1,make:1,platea:[0,2,3,4,6,7,8],same:5,member:5,python:[5,1],document:[0,1],ansibl:[5,0,9,1],complet:0,pick:1,fruit:5,user:1,extrem:1,distutil:1,squar:5,whole:1,exampl:[1,8],command:1,thi:[5,1],execut:1,less:1,skill:5,languag:[5,1],versu:1,hac:[0,2,3,4,6,7,8],simplejson:1,els:1,build:1,ipsum:[0,2,3,4,6,7,8],tincidunt:[0,2,3,4,6,7,8],know:5,daemon:1,like:5,integ:[0,2,3,4,6,7,8],server:1,"boolean":5,velit:[0,2,3,4,6,7,8],page:[5,1,9],dead:1,est:[0,2,3,4,6,7,8],avoid:1,ultrici:[0,2,3,4,6,7,8],tracker:1,machin:1,run:1,power:1,dui:[0,2,3,4,6,7,8],step:1,repositori:1,"super":1,aenean:[0,2,3,4,6,7,8],about:5,justo:[0,2,3,4,6,7,8],libero:[0,2,3,4,6,7,8],surround:5,manag:1,quisqu:[0,2,3,4,6,7,8],own:1,"final":5,your:[5,1,9],praesent:[0,2,3,4,6,7,8],git:1,fabric:1,wai:[5,1],interdum:[0,2,3,4,6,7,8],fast:1,avail:1,start:[5,0,1],appl:5,porttitor:[0,2,3,4,6,7,8],lot:1,form:5,eget:[0,2,3,4,6,7,8],lint:5,loborti:[0,2,3,4,6,7,8],ullamcorp:[0,2,3,4,6,7,8],line:5,"true":5,freenod:1,strawberri:5,whether:1,wish:1,record:5,problem:1,tasti:5,creat:1,doesn:1,repres:5,ansil:9,exist:1,file:[5,1],mauri:[0,2,3,4,6,7,8],ship:9,urna:[0,2,3,4,6,7,8],conval:[0,2,3,4,6,7,8],googl:1,nam:[0,2,3,4,6,7,8],"default":1,bracket:5,futur:1,dignissim:[0,2,3,4,6,7,8],test:1,you:[5,0,9,1],node:1,dapibu:[0,2,3,4,6,7,8],journei:9,gravida:[0,2,3,4,6,7,8],asciidoc:1,feli:[0,2,3,4,6,7,8],aliquet:[0,2,3,4,6,7,8],lorem:[0,2,3,4,6,7,8],dictumst:[0,2,3,4,6,7,8],rutrum:[0,2,3,4,6,7,8],time:1,far:1,fermentum:[0,2,3,4,6,7,8]},objtypes:{},titles:["Getting Started","Ansible","Modules","Communicate","Playbooks","YAML Scripts","Patterns","API","Examples","Man Pages"],objnames:{},filenames:["gettingstarted","index","modules","communicate","playbooks","YAMLScripts","patterns","api","examples","man"]}) \ No newline at end of file +Search.setIndex({objects:{},terms:{all:[0,1,2,4,5,6,8],code:[1,2,8],donec:[],mcollect:1,prefix:[2,4,8],rhoncu:[],lacu:[],follow:[6,2,4],scp:8,nunc:[],bubbl:4,depend:2,fusc:[],program:[1,2,4],certain:4,vel:[],blindingli:1,spec:4,sourc:[1,2,4,8],everi:5,string:2,fals:[5,2],consequat:[],failur:[7,2],veri:[1,7,4],affect:4,risu:[],luctu:[],magic:6,level:[5,2],id_rsa:[0,8],list:[1,2,3,4,5,6,8,9],vivamu:[],item:5,ansible_librari:[],form:[5,4],dotnet:5,saltstack:1,mpdehaan:[],phasellu:[],ornar:[],natur:2,seper:4,chef:1,second:5,design:1,pass:4,eleifend:[],further:4,even:8,what:2,diam:[],favcolor:8,section:[1,4],abl:[],nec:[],abbrevi:5,version:[2,8],directori:2,ever:1,method:7,metadata:2,tar:0,suscipit:[],hash:2,eckersberg:5,here:[],leo:[],address:[6,2],path:2,sinc:8,valu:[5,2,4],aliquam:[],scelerisqu:[],great:1,purpos:[2,4],larger:[],host:[0,1,2,4,6,7,8],adipisc:[],prior:2,venenati:[],permit:5,action:[1,2,4],nulla:[],implement:7,iaculi:[],via:[0,1],regardless:[5,1],dictionari:5,accumsan:[],extra:4,apach:[4,8],modul:[0,1,2,4,7,8],prefer:[],put:[0,8],unix:4,api:[1,7,2],instal:[8,0,2,4,1],select:[6,4],httpd:4,from:[0,1,2,4,5,8],describ:2,would:8,commun:[1,3],visit:3,two:[5,0,6],noarch:0,dehaan:1,call:2,usr:[2,8],taken:4,sagitti:[],basi:4,checkout:2,until:0,more:[0,6,2,4,1],desir:[],idempot:[1,2,4],dbserver:[6,4],sbin:[2,8],agent:[0,8],particular:1,easiest:1,must:[5,2],none:[],join:3,ibm:[],module_arg:7,habitass:[],setup:[1,2,8],work:[6,8],critic:1,remain:1,tag:[0,2],can:[0,1,2,4,5,6,7,8],learn:[0,6,4,1],ero:[],root:[5,1,2,4],pick:5,employe:5,myapp:8,yamllint:5,ultric:[],process:[1,8],rpath:[],sudo:0,share:2,templat:[8,0,2,4,1],othervar:4,knows_oop:5,minimum:4,want:7,occur:4,nullam:[],alwai:2,multipl:[6,4,8],newlin:5,puru:[],sit:[],capistrano:1,ping:[0,7,2,1],write:[5,1,2,4,8],how:[0,1,2,4,5,6,7],etiam:[],yum:[1,2],simpl:[5,1,7,4,8],updat:8,arcu:[],express:[5,1,7,4],referenc:[6,4],clone:0,usabl:1,tristiqu:[],mai:[5,0],end:2,data:[5,7,2,8],parallel:[1,8],man:[1,9],repo:[2,8],github:[0,3],orchestr:[1,4],read:[5,0],bootstrap:1,favorit:1,turpi:[],element:[5,2],issu:3,inform:[2,4],mango:5,combin:5,asynchron:[1,4],order:4,talk:[],oper:[1,4,8],help:1,over:1,move:[2,4],orang:5,becaus:[],elit:5,rpmbuild:0,comma:5,vita:[],still:[],paramet:[2,4],jid:8,overlord:0,group:[1,7,3,4,6],cli:7,fit:[],yaml:[5,0,4,1],pend:[4,8],rapidli:7,infrastructur:[1,6],mail:[6,3],sapien:[],main:4,might:4,easier:[],non:[1,2],"return":[1,7,2],thei:[7,2,4,8],food:5,alist:4,nibh:[],egesta:[],"break":[],framework:[1,7],jinja2:[0,2,8],now:[0,2],nor:2,choic:1,multiprocess:0,name:[5,1,2,4],anyth:2,neccessari:[2,8],config:[1,4],viverra:[],datastructur:7,porta:[],separ:5,each:[5,2,4,8],stock:[],nearli:4,mean:2,metu:[],michael:1,auctor:[],realli:[5,4],contributor:[],backport:0,connect:[],our:5,todo:[],event:2,out:[5,1,2,4],variabl:[2,4,8],"try":0,shown:[],network:3,space:[1,2],reboot:8,content:[0,1],stuff:8,sshd:1,internet:1,correct:[5,1],red:8,state:[2,4,8],hendrerit:[],ntp:8,contain:[2,4],differ:[1,4,8],pub:8,control:[1,2,4,8],base:[1,4],lab:[],tempu:[],qui:[],org:0,molli:[],bash:[0,8],care:[],vestibulum:[],pyyaml:0,indent:5,maecena:[],could:7,fqdn:8,thing:[1,6],place:1,isn:1,principl:[],licens:1,first:[0,2,8,1],origin:[],softwar:[1,2],rang:1,notifi:[1,4,8],obviou:1,onc:2,number:2,yourself:0,hook:2,instruct:0,alreadi:[2,4],puppet:1,fast:1,enim:[],massiv:1,open:1,straight:8,given:8,convent:2,script:[0,1,4,5,7,8],associ:5,top:2,system:[0,1,2,4,6,8],messag:7,grow:[],too:1,statement:[1,4],molesti:[],john:5,banana:5,includ:[1,4],shell:[1,8],option:[5,9,2,4,8],tool:1,copi:[1,2,8],specifi:[5,2,8],quam:[],next:4,"short":1,kept:4,than:[0,2,8],serv:[],liter:2,target:[1,6],provid:5,sollicitudin:[],heavyweight:[],structur:5,charact:5,project:[0,3,8,1],architect:1,were:4,minut:[],uses_cv:5,pre:0,sai:4,runner:7,ani:[1,7,2,4,8],ant:[],download:0,have:[0,2,4,1],need:[5,0,2,8],tellu:[],seek:2,paramiko:0,engin:8,built:0,contact:[0,7,2],note:[2,8],also:[0,1,2,4,5,6,8],client:1,massa:[],build:[0,7],indic:2,environ:[],divers:1,pulvinar:[],begin:5,sure:[],unless:2,distribut:[0,1],deploy:[1,4],track:8,who:2,discov:4,most:[5,2],plai:2,regular:4,plan:2,deploi:[1,2,4,8],pair:2,why:1,porttitor:[],simplic:[],doc:1,later:8,cover:8,doe:[1,2,6],sodal:[],bracket:5,snapshot:2,clojur:[],wildcard:[1,6],dolor:[],someth:[1,8],awesom:[1,4],laoreet:[],blandit:[],verbos:2,syntax:[5,0,4],bring:[],directli:[2,4,8],raleigh:1,particularli:4,playbook:[0,1,2,4,5,6,7,8],permiss:2,hack:1,radic:1,pki:[],trivial:2,varnam:4,involv:[1,3],absolut:2,onli:[2,4],explicitli:4,locat:2,just:[8,0,4,1],pretti:7,configur:[5,0,6,4,1],releas:0,written:[1,2,4,8],should:[5,2],consectetur:[],somevar:4,congratul:0,variu:[],local:2,yml:4,long_running_oper:8,contribut:1,variou:[],get:[5,0,3,8,1],financ:1,stop:2,mission:1,bibendum:[],ssl:[],ssh:[0,8],malesuada:[],requir:[0,2,4,1],uvh:0,nisi:[],bar:6,lame:5,nisl:[],remot:[0,2,4,8],cra:[],orci:[],through:[0,2,1],where:[1,2,4],wrote:[],view:[3,9],set:[2,4],creator:[],elimin:[],see:[0,1,2,4,5,6,8],sed:[],result:[7,2],fail:4,sem:[],extend:1,ntp_server:8,faucibu:[],statu:8,kei:[5,0,2,4],databas:4,modularli:[],discoveri:2,restart:[2,4,8],behind:[],won:8,languag:[5,0,6,2,1],between:5,"import":7,irc:3,altern:8,elementum:[],manpag:[0,9],handful:[],aspir:[],style:2,job:[5,8],aserv:0,magna:[],webapp:8,amet:[],addit:[5,1],delimit:2,plugin:[],goal:1,against:[1,4,6],tempor:[],etc:[0,1,2,4,6,8],befor:[2,4],mani:8,placerat:[],com:[0,7,4,6],proin:[],sha:2,assur:4,simpli:2,author:1,overview:5,format:[2,4,8],inspir:[],colon:4,shutdown:2,linux:[1,4],poll:[1,4,8],rpm:[0,1],matti:[],dui:[],pretium:[],multiplay:1,morbi:[],three:6,been:[1,2],json:[1,7,2],much:1,basic:[5,0,6,2,1],ungroup:6,feugiat:[],quickli:[5,1],box:[1,2],fire:1,rubi:[5,2,8],vulput:[],argument:2,understand:0,pellentesqu:[],func:1,atlanta:8,job_statu:8,those:[5,2],emploi:5,authorized_kei:0,multi:[1,4],tortor:[],look:[6,4,8],nequ:[],hoc:[1,4],servic:[1,2,4],md5sum:2,batch:[],"while":4,overrid:2,ipsum:[],cobbler:1,real:0,motd:8,max_client:4,them:8,erat:[],conf:[4,8],module_nam:7,ship:[0,2],sever:5,http_port:4,develop:[5,0,1],inventori:[6,2],minim:0,make:[0,2,8],platea:[],same:[5,6,2,8],member:5,python:[0,1,2,5,7,8],complex:[1,4],success:2,fedora:[],document:[0,7,4],ansibl:[0,1,2,3,4,5,6,7,8,9],complet:[0,4],finish:[],http:2,webserv:[6,4,8],nest:2,painless:1,effect:4,dai:[],fruit:5,user:[1,2,4],ownership:[],extrem:0,php:8,distutil:[0,1],chang:[2,4,8],squar:5,exceedingli:[],task:[1,4,8],off:1,scenario:2,whole:[],well:[2,4],spent:[],exampl:[0,1,2,4,5,6,7,8],command:[0,1,2,4,6,8,9],thi:[0,1,2,4,5,6,8],choos:2,usual:4,comment:[1,4],protocol:2,execut:[1,2,4],less:[0,1],when:[2,4,8],skill:5,simultan:8,ligula:[],previous:[],web:[7,8],versu:1,easi:2,mix:[1,6],trigger:2,hac:[],except:4,littl:1,add:[0,8],other:[1,2,8],els:1,unlik:4,hat:[],match:4,take:2,bin:[2,8],applic:[7,4],which:[0,1,2,4,5,6],ohai:[1,2,4,8],dest:[2,4,8],tincidunt:[],dark:7,game:1,know:5,background:[1,8],world:0,bit:2,daemon:1,like:[5,6,4,8],specif:[1,7,8,6],signal:4,manual:[],integ:2,server:[1,2,4,8],edit:0,"boolean":5,either:2,velit:[],popular:1,async:[],page:[5,0,9,3,1],deal:[],suppli:2,some:0,back:4,dead:1,tumblr:[],home:[],librari:[],tmp:8,render:2,avoid:2,though:1,ultrici:[],per:7,tracker:3,unit:[],pattern:[1,7,4,6],foo:[6,4,8],complic:1,machin:[0,2,4,8],core:1,run:[0,7,2,4,8],power:[1,7],quit:[],lose:8,usag:[2,8],asciidoc:0,web2:7,step:[2,4],web1:7,repositori:0,"super":1,aenean:[],simpler:8,comparison:1,about:[5,0,2,4,1],gplv3:1,justo:[],libero:[],surround:5,manag:[5,0,6,4,1],srv:[4,8],quisqu:[],industri:1,own:[1,2,4],"final":5,bounc:2,automat:2,compos:4,down:4,ensur:4,perl:8,bserver:0,your:[0,1,2,4,5,6,8],praesent:[],git:[0,2,8,1],type:7,fabric:1,wai:[5,0,4,8],interdum:[],transfer:[1,8],dictum:[],support:[2,8],rotat:4,"long":[1,2,8],avail:[0,9,2,4,8],start:[5,0,2,4,1],appl:5,augu:[],lot:[1,8],suit:4,"var":[1,4],individu:6,fork:7,head:[2,8],doctyp:[],simplejson:0,eget:[],handler:[1,4,8],lint:5,msg:2,loborti:[],ullamcorp:[],line:[5,1,9,4,8],"true":[5,2],freenod:3,info:4,strawberri:5,made:[2,8],possibl:[6,4,8],whether:7,wish:[5,0,6],tell:[2,8],planet:1,record:5,below:8,limit:[1,8],suspendiss:[],otherwis:2,problem:[],similar:2,chip:1,facter:[1,2,4,8],curv:1,featur:[1,4],tasti:5,creat:1,lectu:[],doesn:1,repres:5,ansil:[],deferenc:4,file:[0,1,2,4,5,6,8],mauri:[],exist:[1,4],check:[2,8],urna:[],conval:[],googl:3,excel:1,nam:[],"default":[1,2,6],likes_emac:5,futur:0,dignissim:[],test:[0,2],you:[0,1,4,5,6,8],node:[0,1],dapibu:[],journei:[],gravida:[],sequenc:1,devop:1,push:4,est:[],feli:[],aliquet:[],src:[2,4,8],lorem:[],"60k":1,dictumst:[],sphinx:0,rutrum:[],anywher:[],descript:[],portion:6,time:[0,1,2,4,6,8],far:1,serious:[],fermentum:[]},objtypes:{},titles:["Getting Started","Ansible","Ansible Modules","Communicate and Get Involved","Playbooks","YAML Scripts","Patterns","API","Examples","Man Pages"],objnames:{},filenames:["gettingstarted","index","modules","communicate","playbooks","YAMLScripts","patterns","api","examples","man"]}) \ No newline at end of file diff --git a/rst/YAMLScripts.rst b/rst/YAMLScripts.rst index de59528b785..32d76aff149 100644 --- a/rst/YAMLScripts.rst +++ b/rst/YAMLScripts.rst @@ -1,8 +1,9 @@ YAML Scripts ============ -This page provides a basic overview of correct YAML syntax. - +This page provides a basic overview of correct YAML syntax, which is how Ansible +playbooks (our configuration management language) are expressed. +You may also wish to read playbook examples and will quickly pick this up from those. YAML Basics ----------- @@ -74,7 +75,7 @@ Finally, you can combine these data structures:: dotnet: Lame That's all you really need to know about YAML to get started writing -`Ansible` scripts. +`Ansible` playbooks. .. seealso:: diff --git a/rst/api.rst b/rst/api.rst index 1cc8454a67d..a3ddea45951 100644 --- a/rst/api.rst +++ b/rst/api.rst @@ -1,55 +1,35 @@ API -=== - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +``` + +The Python API is very powerful, and is how the ansible CLI and ansible-playbook +are implemented. + +It's pretty simple:: + + import ansible.runner + + runner = ansible.runner.Runner( + module_name='ping', + module_args='', + pattern='web*', + forks=10 + ) + datastructure = runner.run() + +The run method returns results per host, grouped by whether they +could be contacted or not. Return types are module specific, as +expressed in the 'ansible-modules' documentation.:: + + { + "dark" : { + "web1.example.com" : "failure message" + } + "contacted" : { + "web2.example.com" : 1 + } + } + +A module can return any type of JSON data it wants, so Ansible can +be used as a framework to rapidly build powerful applications and scripts. + + diff --git a/rst/communicate.rst b/rst/communicate.rst index 8e4d12a3b0b..cd718ddcbfb 100644 --- a/rst/communicate.rst +++ b/rst/communicate.rst @@ -1,55 +1,9 @@ -Communicate -=========== +Communicate and Get Involved +=========================== -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. +* Join the `ansible-project mailing list `_ on Google Groups +* Join `#ansible `_ on the `freenode IRC network `_ +* Visit the `project page `_ on Github -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. + - View the `issue tracker `_ -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. diff --git a/rst/examples.rst b/rst/examples.rst index 44194c9ff0b..0a5df0d90d8 100644 --- a/rst/examples.rst +++ b/rst/examples.rst @@ -1,71 +1,65 @@ Examples ======== -Examples 1 -`````````` - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - - -Examples 2 -`````````` - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Examples 3 -`````````` - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -Examples 3 -`````````` - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Examples 4 -`````````` - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +.. seealso:: + + :doc:`modules` + A list of available modules + :doc:`playbooks` + Alternative ways to use ansible + + +Parallelism and Shell Commands +`````````````````````````````` + +Reboot all web servers in Atlanta, 10 at a time:: + + ssh-agent bash + 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. + + +Example 2: 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.:: + + 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. + + +Examples 3: File Transfer & Templating +`````````````````````````````````````` + +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 below) 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. + +Examples 3: 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. + + diff --git a/rst/gettingstarted.rst b/rst/gettingstarted.rst index 247faf96c03..638039c4a93 100644 --- a/rst/gettingstarted.rst +++ b/rst/gettingstarted.rst @@ -1,67 +1,100 @@ Getting Started =============== -How to ansible - +How to download ansible and get started using it .. seealso:: + :doc:`examples` + Examples of basic commands :doc:`YAMLScripts` - Complete documentation of the YAML syntax `ansible` understands. - - -What you need -------------- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. + Complete documentation of the YAML syntax `ansible` understands for playbooks. + :doc:`playbooks` + Learning ansible's configuration management language + :doc:`modules` + Learn about modules that ship with ansible + +Requirements +```````````` + +Requirements are extremely minimal. + +If you are running python 2.6 on the **overlord** machine, you will +need: + +* ``paramiko`` +* ``PyYAML`` +* ``python-jinja2`` (for playbooks) + +If you are running less than Python 2.6, you will also need: + +* The Python 2.4 or 2.5 backport of the ``multiprocessing`` module + + - `Installation and Testing Instructions `_ + +* ``simplejson`` + +On the managed nodes, to use templating, you will need: + +* ``python-jinja2`` (you can install this with ansible) + +Developer Requirements +`````````````````````` + +For developers, you may wish to have: + +* ``asciidoc`` (for building manpage documentation) +* ``python-sphinx`` (for building content for ansible.github.com) + + +Getting Ansible +``````````````` + +Tagged releases are available as tar.gz files from the Ansible github +project page: + +* `Ansible/downloads `_ + +You can also clone the git repository yourself and install Ansible in +one of two ways: + + +Python Distutils +++++++++++++++++ + +You can also install Ansible using Python Distutils:: + + $ git clone git://github.com/ansible/ansible.git + $ cd ./ansible + $ sudo make install + +Via RPM ++++++++ + +In the near future, pre-built RPMs will be available through your distribution. Until that time you +can use the ``make rpm`` command:: + + $ git clone git://github.com/ansible/ansible.git + $ cd ./ansible + $ make rpm + $ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm + +Your first commands +``````````````````` + +Edit /etc/ansible/hosts and put one or more remote systems in it, for which you have your SSH +key in ``authorized_keys``:: + + 192.168.1.50 + aserver.example.org + bserver.example.org + +Now try this: + + ssh-agent bash + ssh-add ~/.ssh/id_rsa + ansible all -m ping + +Congratulations. You've just contacted your nodes with Ansible. It's now time to read some +of the more real-world examples. + diff --git a/rst/index.rst b/rst/index.rst index c26aabef7b7..4ab721e4e24 100644 --- a/rst/index.rst +++ b/rst/index.rst @@ -5,102 +5,48 @@ Ansible ======= -Ansible is a extra-simple tool/API for doing 'parallel remote things' -over SSH -- whether executing commands, running "modules", or -executing larger 'playbooks' that can serve as a configuration -management or deployment system. +Ansible is a radically simple deployment, configuration, and command execution framework. +Other tools in this space have been too complicated for too long, require too much bootstrapping, +and have too much learning curve. Ansible is dead simple and painless to extend. For comparison, Puppet and Chef have about 60k lines of code. Ansible's core is a little over 1000 lines. -While `Func installation `_ which I -co-wrote, aspired to avoid using SSH and have it's own daemon -infrastructure, Ansible aspires to be quite different and more -minimal, but still able to grow more modularly over time. This is -based on talking to a lot of users of various tools and wishing to -eliminate problems with connectivity and long running daemons, or not -picking tool `X` because they preferred to code in `Y`. Further, -playbooks take things a whole step further, building the config and -deployment system I always wanted to build. +Ansible isn't just for configuration -- it's also great for Ad-Hoc tasks, +quickly firing off commands against nodes. Where Ansible excels though, is expressing complex multi-node deployment processes, executing complex sequences of commands on different hosts through the "playbooks" feature. -Why use Ansible versus something else? (Fabric, Capistrano, +Ansible does not require programming in any particular language -- you can write modules +as scripts or programs that return simple JSON. + +Why use Ansible versus something else? (Puppet, Chef, Fabric, Capistrano, mCollective, Func, SaltStack, etc?) It will have far less code, it will be more correct, and it will be the easiest thing to hack on and use you'll ever see -- regardless of your favorite language of choice. -Want to only code plugins in bash or clojure? Ansible doesn't care. -The docs will fit on one page and the source will be blindingly -obvious. +Systems management doesn't have to be complicated. Ansible's docs will remain +short & simple, and the source will be blindingly obvious. -Design Principles -````````````````` +Design Goals +```````````` * Dead simple setup * Super fast & parallel by default -* No server or client daemons; use existing SSHd +* No server or client daemons; use existing SSHd out of the box * No additional software required on client boxes * Modules can be written in ANY language * Awesome API for creating very powerful distributed scripts * Be usable as non-root * Create the easiest config management system to use, ever. +About the Author +```````````````` -Requirements -```````````` - -Requirements are extremely minimal. - -If you are running python 2.6 on the **overlord** machine, you will -need: - -* ``paramiko`` -* ``PyYAML`` -* ``python-jinja2`` (for playbooks) -* ``Asciidoc`` (for building documentation) - -If you are running less than Python 2.6, you will also need: - -* The Python 2.4 or 2.5 backport of the ``multiprocessing`` module - - - `Installation and Testing Instructions `_ - -* ``simplejson`` - -On the managed nodes, to use templating, you will need: - -* ``python-jinja2`` (you can install this with ansible) - - -Getting Ansible -``````````````` - -Tagged releases are available as tar.gz files from the Ansible github -project page: +Michael DeHaan is a Raleigh, NC based software developer and architect. He created other +DevOps programs such as Cobbler, the popular Linux install server. +Cobbler is used to deploy mission critical systems all over the planet, in industries +ranging from massively multiplayer gaming, core internet infrastructure, finance, +chip design, and more. Michael also helped co-author of Func, which is used +to orchestrate systems in lots of diverse places. -* `Ansible/downloads `_ - -You can also clone the git repository yourself and install Ansible in -one of two ways: - - -Python Distutils -++++++++++++++++ - -You can install Ansible using Python Distutils:: - - $ git clone git://github.com/ansible/ansible.git - $ cd ./ansible - $ sudo make install - - -Via RPM -+++++++ - -In the future, pre-built RPMs may be available. Until that time you -can use the ``make rpm`` command:: - - $ git clone git://github.com/ansible/ansible.git - $ cd ./ansible - $ make rpm - $ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm - +Ansible is an GPLv3 licensed open source project, so see the contributions section for how to +get involved. Contents ======== @@ -109,21 +55,11 @@ Contents :maxdepth: 3 gettingstarted - YAMLScripts patterns modules + YAMLScripts playbooks examples api communicate man - - -Communicate or Get Involved -=========================== - -* Join the `ansible-project mailing list `_ on Google Groups -* Join `#ansible `_ on the `freenode IRC network `_ -* Visit the `project page `_ on Github - - - View the `issue tracker `_ diff --git a/rst/man.rst b/rst/man.rst index d25477bf110..41dd4e650ee 100644 --- a/rst/man.rst +++ b/rst/man.rst @@ -3,19 +3,10 @@ Man Pages ========= -Ansile ships with a handfull of manpages to help you on your journey. +Ansible's manpage lists available command line options. ansible(1) ---------- * `View ansible.1 `_ -ansible-modules(5) ------------------- - -* `View ansible-modules.5 `_ - -ansible-playbook(5) -------------------- - -* `View ansible-playbook.5 `_ diff --git a/rst/modules.rst b/rst/modules.rst index b303ee6ccb2..540aad2bf7d 100644 --- a/rst/modules.rst +++ b/rst/modules.rst @@ -1,55 +1,201 @@ -Modules -======= - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +Ansible Modules +=============== + +.. seealso:: + + :doc:`examples` + Examples of using modules in /usr/bin/ansible + :doc:`playbooks` + Examples of using modules with /usr/bin/ansible-playbook + :doc:`api` + Examples of using modules with the Python API + + +About Modules +````````````` + +Ansible ships with a number of modules that can be executed directly on remote hosts or through +ansible playbooks. + + +Idempotence +``````````` + +Most modules other than command are idempotent, meaning they will seek to avoid changes +unless a change needs to be made. When using ansible playbooks, these modules can +trigger change events. Unless otherwise noted, all modules support change hooks. + + +command +``````` + +The command module takes the command name followed by a list of arguments, space delimited. +This is the only module that does not use key=value style parameters. + +Example usage:: + + /sbin/shutdown -t now + +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. + + +copy +```` + +The copy module moves a file on the local box to remote locations. + +*src*:: + +Local absolute path to a file to copy to the remote server + + +*dest*:: + +Remote absolute path where the file should end up + + +This module also returns md5sum information about the resultant file. + + +facter +`````` + +Runs the discovery program 'facter' on the remote system, returning +JSON data that can be useful for inventory purposes. + +Requires that 'facter' and 'ruby-json' be installed on the remote end. + +This module is informative only - it takes no parameters & does not support change hooks, +nor does it make any changes on the system. + + +git +``` + +Deploys software from git checkouts. + +*repo*:: + +git or http protocol address of the repo to checkout + +*dest*:: + +where to check it out, an absolute directory path + +*version*:: + +what version to check out -- either the git SHA, the literal string 'HEAD', or a tag name + + +ohai +```` + +Similar to the facter module, this returns JSON inventory data. Ohai +data is a bit more verbose and nested than facter. + +Requires that 'ohai' be installed on the remote end. + +This module is information only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system. + + +ping +```` + +A trivial test module, this module always returns the integer '1' on +successful contact. + +This module does not support change hooks. + +This module is informative only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system. + + +service +``````` + +Controls services on remote machines. + +*state* + +Values are 'started', 'stopped', or 'restarted'. Started/stopped +are idempotent actions that will not run commands unless neccessary. +'restarted' will always bounce the service + + +*name* + +The name of the service + + +setup +````` + +Writes a JSON file containing key/value data, for use in templating. +Call this once before using the template modules. Playbooks will +execute this module automatically as the first step in each play. + +If facter or ohai are installed, variables from these programs will also +be snapshotted into the JSON file for usage in templating. These variables +are prefixed with 'facter_' and 'ohai_" so it's easy to tell their source. + +*metadata* + +Optionally overrides the default JSON file location of /etc/ansible/setup or ~/ansible/setup +depending on what remote user has been specified. + +If used, also supply the metadata parameter to the template module. + +*anything* + +any other parameters can be named basically anything, and set a key=value +pair in the JSON file for use in templating. + + +template +```````` + +Templates a file out to a remote server. Call the setup module prior to usage. + +*src* + +path of a Jinja2 formatted template on the local server + + +*dest* + +location to render the template on the remote server + + +*metadata* + +location of a JSON file to use to supply template data. Default is /etc/ansible/setup +which is the same as the default for the setup module. Change if running as a non-root +remote user who does not have permissions on /etc/ansible. + + +This module also returns md5sum information about the resultant file. + + +user +```` + +This module is in plan. + + +yum +``` + +This module is in plan. + + +WRITING YOUR OWN MODULES +```````````````````````` + +To write your own modules, simply follow the convention of those already available in +/usr/share/ansible. Modules must return JSON but can be written in any language. +Modules should return hashes, but hashes can be nested. +To support change hooks, modules should return hashes with a changed: True/False +element at the top level. Modules can also choose to indicate a failure scenario +by returning a top level 'failure' element with a True value, and a 'msg' element +describing the nature of the failure. Other values are up to the module. diff --git a/rst/patterns.rst b/rst/patterns.rst index d0ae6b5d37d..6b73114199e 100644 --- a/rst/patterns.rst +++ b/rst/patterns.rst @@ -1,55 +1,69 @@ Patterns ======== -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +How to select hosts you wish to manage + +.. seealso:: + + :doc:`examples` + Examples of basic commands + :doc:`playbooks` + Learning ansible's configuration management language + +Ansible works against multiple systems in your infrastructure at the +same time. It does this by selecting portions of systems listed in Ansible's inventory file, +which defaults to /etc/ansible/hosts, and looks like this:: + + mail.example.com + + [webservers] + foo.example.com + bar.example.com + + [dbservers] + one.example.com + two.example.com + three.example.com + +Targetting All Systems +`````````````````````` + +The pattern 'all' or '*' targets all systems in the inventory file. + +Specific Hosts +`````````````` + +It is possible to address specific hosts: + + one.example.com + one.example.com:two.example.com + +Groups +`````` + +The following patterns address one or more groups: + + webservers + webservers:dbservers + +There is also a magic group 'ungrouped' which selects systems not in a group. + +Wildcards +````````` + +Individual hosts, but not groups, can also be referenced using wildcards: + + *.example.com + *.com + +Mixing Things Up +```````````````` + +Specific hosts, wildcards, and groups can all be mixed in the same pattern + + one*.com:dbservers + +It is not possible to target a host not in the inventory file. + + + diff --git a/rst/playbooks.rst b/rst/playbooks.rst index 677403b5bc6..75da6a66253 100644 --- a/rst/playbooks.rst +++ b/rst/playbooks.rst @@ -1,55 +1,118 @@ Playbooks ========= -Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim -placerat nibh, non feugiat risus varius vitae. Donec eu libero -lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in -magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, -dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus -mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae -luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis -ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, -rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies -tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis -egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna -sem. Donec arcu felis, faucibus et malesuada non, blandit vitae -metus. Fusce nec sapien dolor. - -Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, -pretium quis sapien. Duis felis metus, sodales sit amet gravida in, -pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin -eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, -suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada -molestie, nisi nunc placerat libero, vel vulputate elit tellus et -augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat -egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan -lorem eget leo dictum viverra. - -Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean -ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar -quam. Suspendisse nec massa vel augue laoreet ultricies in convallis -dolor. Mauris sodales porta enim, non ultricies dolor luctus -in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, -erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra -arcu sem a ante. Praesent nec metus vestibulum augue eleifend -suscipit. In feugiat, sem nec dignissim consequat, velit tortor -scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh -turpis. Proin ac nisi ligula, a pretium augue. - -In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed -ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, -eget lobortis mi magna sed metus. Cras justo est, tempus quis -adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et -luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae -nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc -sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet -lacus. Maecenas interdum viverra laoreet. Quisque elementum -sollicitudin ullamcorper. - -Pellentesque mauris sem, malesuada at lobortis in, porta eget -urna. Duis aliquet quam eget risus elementum quis auctor ligula -gravida. Phasellus et ullamcorper libero. Nam elementum ultricies -tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat -tristique lobortis. Suspendisse est enim, tristique eu convallis id, -rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin -hendrerit mi tincidunt dui fermentum placerat. +.. seealso:: + + :doc:`YAMLScripts` + Learn about YAML syntax + :doc:`modules` + Learn about available modules and writing your own + :doc:`patterns` + Learn about how to select hosts + + +Playbooks are a completely different way to use ansible and are particularly awesome. + +They are the basis for a really simple configuration management and deployment system, unlike any that already exist, and one that is very well suited to deploying complex multi-machine applications. While you might run the main ansible program for ad-hoc tasks, playbooks are more likely to be kept in source control and used to push out your configuration or assure the configurations of your remote systems are in spec. + + +Playbook Example +```````````````` + +Playbooks are expressed in YAML format and have a minimum of syntax. Each playbook is composed +of one or more patterns in a list. By composing a playbook of multiple patterns, it is possible +to orchestrate multi-machine deployments, running certain steps on all machines in +the webservers group, then certain steps on the database server group, then more commands +back on the webservers group, etc:: + + --- + - hosts: all + vars: + http_port: 80 + max_clients: 200 + user: root + tasks: + - include: base.yml somevar=3 othervar=4 + - name: write the apache config file + action: template src=/srv/httpd.j2 dest=/etc/httpd.conf + notify: + - restart apache + - name: ensure apache is running + action: service name=httpd state=started + handlers: + - include: handlers.yml + +Hosts line +`````````` + +The hosts line is alist of one or more groups or host patterns, seperated by colons.:: + + webservers:dbservers:*.foo.example.com + +Vars section +```````````` + +A list of variables that can be used in the 'action' lines of the template, or in +included templates. Variables are deferenced like this:: + + {{ varname }} + +These variables will be pushed down to the managed systems for use in templating operations. + +Further, if there are discovered variables about the system (say, if facter or ohai were +installed) these variables bubble up back into the playbook, and can be used on each +system just like explicitly set variables. Facter variables are prefixed with 'facter' +and Ohai variables are prefixed with 'ohai'. + +Tasks list +`````````` + +Tasks are executed in order, one at a time, against all machines matched by the host +pattern, before moving on to the next task. Failed tasks are taken out of the rotation. + +Task name and comment +````````` + +Each task has a name (required) and optional comment. This is for informational purposes only + +Task action +``````````` + +The action line is the name of an ansible module followed by parameters. Usually these +are expressed in key=value form, except for the command module, which looks just like a Linux/Unix +command line. See the module documentation for more info. + +Notify statements +````````````````` + +Nearly all modules are written to be 'idempotent' and can signal when they have affected a change +on the remote system. If a notify statement is used, the named handler will be run against +each system where a change was effected, but NOT on systems where no change occurred. + +Handlers +```````` + +Handlers are lists of tasks, not really any different from regular tasks, that are referenced +by name. + +Includes +```````` + +Not all tasks have to be listed directly in the main file. An include file can contain +a list of tasks (in YAML) as well, optionally passing extra variables into the file. +Variables passed in can be deferenced like this: + + {{ variable }} + +Asynchronous Actions and Polling +```````````````````````````````` + +(Information on this feature is pending) + +Executing A Playbook +```````````````````` + +To run a playbook:: + + ansible-playbook playbook.yml +