mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
248 lines
No EOL
12 KiB
HTML
248 lines
No EOL
12 KiB
HTML
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>Ansible — Ansible v0.0.1 documentation</title>
|
|
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '0.0.1',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<link rel="top" title="Ansible v0.0.1 documentation" href="#" />
|
|
<link rel="next" title="Getting Started" href="gettingstarted.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="gettingstarted.html" title="Getting Started"
|
|
accesskey="N">next</a> |</li>
|
|
<li><a href="#">Ansible v0.0.1 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="ansible">
|
|
<h1>Ansible<a class="headerlink" href="#ansible" title="Permalink to this headline">¶</a></h1>
|
|
<p>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.</p>
|
|
<p>While <a class="reference external" href="http://fedorahosted.org/func">Func installation</a> 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 <cite>X</cite> because they preferred to code in <cite>Y</cite>. Further,
|
|
playbooks take things a whole step further, building the config and
|
|
deployment system I always wanted to build.</p>
|
|
<p>Why use Ansible versus something else? (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.</p>
|
|
<div class="section" id="design-principles">
|
|
<h2>Design Principles<a class="headerlink" href="#design-principles" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li>Dead simple setup</li>
|
|
<li>Super fast & parallel by default</li>
|
|
<li>No server or client daemons; use existing SSHd</li>
|
|
<li>No additional software required on client boxes</li>
|
|
<li>Modules can be written in ANY language</li>
|
|
<li>Awesome API for creating very powerful distributed scripts</li>
|
|
<li>Be usable as non-root</li>
|
|
<li>Create the easiest config management system to use, ever.</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="requirements">
|
|
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
|
|
<p>Requirements are extremely minimal.</p>
|
|
<p>If you are running python 2.6 on the <strong>overlord</strong> machine, you will
|
|
need:</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal"><span class="pre">paramiko</span></tt></li>
|
|
<li><tt class="docutils literal"><span class="pre">PyYAML</span></tt></li>
|
|
<li><tt class="docutils literal"><span class="pre">python-jinja2</span></tt> (for playbooks)</li>
|
|
<li><tt class="docutils literal"><span class="pre">Asciidoc</span></tt> (for building documentation)</li>
|
|
</ul>
|
|
<p>If you are running less than Python 2.6, you will also need:</p>
|
|
<ul class="simple">
|
|
<li>The Python 2.4 or 2.5 backport of the <tt class="docutils literal"><span class="pre">multiprocessing</span></tt> module<ul>
|
|
<li><a class="reference external" href="http://code.google.com/p/python-multiprocessing/wiki/Install">Installation and Testing Instructions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><tt class="docutils literal"><span class="pre">simplejson</span></tt></li>
|
|
</ul>
|
|
<p>On the managed nodes, to use templating, you will need:</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal"><span class="pre">python-jinja2</span></tt> (you can install this with ansible)</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="getting-ansible">
|
|
<h2>Getting Ansible<a class="headerlink" href="#getting-ansible" title="Permalink to this headline">¶</a></h2>
|
|
<p>Tagged releases are available as tar.gz files from the Ansible github
|
|
project page:</p>
|
|
<ul class="simple">
|
|
<li><a class="reference external" href="https://github.com/ansible/ansible/downloads">Ansible/downloads</a></li>
|
|
</ul>
|
|
<p>You can also clone the git repository yourself and install Ansible in
|
|
one of two ways:</p>
|
|
<div class="section" id="python-distutils">
|
|
<h3>Python Distutils<a class="headerlink" href="#python-distutils" title="Permalink to this headline">¶</a></h3>
|
|
<p>You can install Ansible using Python Distutils:</p>
|
|
<div class="highlight-python"><pre>$ git clone git://github.com/ansible/ansible.git
|
|
$ cd ./ansible
|
|
$ sudo make install</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="via-rpm">
|
|
<h3>Via RPM<a class="headerlink" href="#via-rpm" title="Permalink to this headline">¶</a></h3>
|
|
<p>In the future, pre-built RPMs may be available. Until that time you
|
|
can use the <tt class="docutils literal"><span class="pre">make</span> <span class="pre">rpm</span></tt> command:</p>
|
|
<div class="highlight-python"><pre>$ git clone git://github.com/ansible/ansible.git
|
|
$ cd ./ansible
|
|
$ make rpm
|
|
$ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="contents">
|
|
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="gettingstarted.html">Getting Started</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#what-you-need">What you need</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="YAMLScripts.html">YAML Scripts</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="YAMLScripts.html#yaml-basics">YAML Basics</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Patterns</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="modules.html">Modules</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="playbooks.html">Playbooks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="examples.html#examples-1">Examples 1</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="examples.html#examples-2">Examples 2</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="examples.html#examples-3">Examples 3</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="examples.html#id1">Examples 3</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="examples.html#examples-4">Examples 4</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="communicate.html">Communicate</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="man.html">Man Pages</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="man.html#ansible-1">ansible(1)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="man.html#ansible-modules-5">ansible-modules(5)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="man.html#ansible-playbook-5">ansible-playbook(5)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="communicate-or-get-involved">
|
|
<h1>Communicate or Get Involved<a class="headerlink" href="#communicate-or-get-involved" title="Permalink to this headline">¶</a></h1>
|
|
<ul class="simple">
|
|
<li>Join the <a class="reference external" href="http://groups.google.com/group/ansible-project">ansible-project mailing list</a> on Google Groups</li>
|
|
<li>Join <a class="reference external" href="irc://irc.freenode.net/#ansible">#ansible</a> on the <a class="reference external" href="http://freenode.net/">freenode IRC network</a></li>
|
|
<li>Visit the <a class="reference external" href="https://github.com/ansible/ansible">project page</a> on Github<ul>
|
|
<li>View the <a class="reference external" href="https://github.com/ansible/ansible/issues">issue tracker</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="#">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">Ansible</a><ul>
|
|
<li><a class="reference internal" href="#design-principles">Design Principles</a></li>
|
|
<li><a class="reference internal" href="#requirements">Requirements</a></li>
|
|
<li><a class="reference internal" href="#getting-ansible">Getting Ansible</a><ul>
|
|
<li><a class="reference internal" href="#python-distutils">Python Distutils</a></li>
|
|
<li><a class="reference internal" href="#via-rpm">Via RPM</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#contents">Contents</a><ul>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#communicate-or-get-involved">Communicate or Get Involved</a></li>
|
|
</ul>
|
|
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="gettingstarted.html"
|
|
title="next chapter">Getting Started</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/index.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" size="18" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="gettingstarted.html" title="Getting Started"
|
|
>next</a> |</li>
|
|
<li><a href="#">Ansible v0.0.1 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2012 Michael DeHaan.
|
|
Last updated on Mar 07, 2012.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
|
|
</div>
|
|
</body>
|
|
</html> |