mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
fix tags and reuse of link name (annoying habit of sphinx to require uniqueness in HREFs)
This commit is contained in:
parent
a29d532711
commit
b3f0678f2d
18 changed files with 106 additions and 30 deletions
|
@ -290,7 +290,7 @@ languages:
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
2
api.html
2
api.html
|
@ -466,7 +466,7 @@ e.g.
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -319,7 +319,7 @@ This way you have an audit trail describing when and why you changed the rules a
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -397,7 +397,7 @@ a simplified syntax for this.</p>
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
2
faq.html
2
faq.html
|
@ -410,7 +410,7 @@ tasks – whether for a QA sytem, build system, or anything you can think of
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -205,7 +205,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -389,7 +389,7 @@ explore, but you already have a fully working infrastructure!</p>
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -261,7 +261,7 @@ is templated and transferred, is the example of a task.</p>
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -415,7 +415,7 @@ Puppet Labs, and is now with <a class="reference external" href="http://rpath.co
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -453,7 +453,7 @@ JSON is probably the simplest way to go.</p>
|
|||
<div class="section" id="sharing-your-module">
|
||||
<h2>Sharing Your Module<a class="headerlink" href="#sharing-your-module" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you think your module is generally useful to others, a good place to share it
|
||||
is in <a href="https://github.com/ansible/ansible-resources">Ansible Resources</a>. This is maintained
|
||||
is in <a class="reference external" href="https://github.com/ansible/ansible-resources">Ansible Resources</a>. This is maintained
|
||||
as a simple repo with pointers to other github projects.</p>
|
||||
<p>Contrib modules here can be implemented in a variety of languages.
|
||||
We would like to build up as many of these as possible in as many languages as possible.</p>
|
||||
|
@ -471,6 +471,8 @@ the program. Stop by the mailing list to inquire about requirements.</p>
|
|||
<dl class="last docutils">
|
||||
<dt><a class="reference internal" href="modules.html"><em>Ansible Modules</em></a></dt>
|
||||
<dd>Learn about available modules</dd>
|
||||
<dt><a class="reference external" href="https://github.com/ansible/ansible-resources">Ansible Resources</a></dt>
|
||||
<dd>User contributed playbooks, modules, and articles</dd>
|
||||
<dt><a class="reference external" href="https://github.com/ansible/ansible/tree/devel/library">Github modules directory</a></dt>
|
||||
<dd>Browse source of core modules</dd>
|
||||
<dt><a class="reference external" href="http://groups.google.com/group/ansible-project">Mailing List</a></dt>
|
||||
|
@ -510,9 +512,9 @@ the program. Stop by the mailing list to inquire about requirements.</p>
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
94
modules.html
94
modules.html
|
@ -155,6 +155,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
<li><a class="reference internal" href="#authorized-key">authorized_key</a></li>
|
||||
<li><a class="reference internal" href="#command">command</a></li>
|
||||
<li><a class="reference internal" href="#copy">copy</a></li>
|
||||
<li><a class="reference internal" href="#easy-install">easy_install</a></li>
|
||||
<li><a class="reference internal" href="#facter">facter</a></li>
|
||||
<li><a class="reference internal" href="#fetch">fetch</a></li>
|
||||
<li><a class="reference internal" href="#file">file</a></li>
|
||||
|
@ -172,10 +173,12 @@ s.parentNode.insertBefore(ga, s);
|
|||
<li><a class="reference internal" href="#service">service</a></li>
|
||||
<li><a class="reference internal" href="#setup">setup</a></li>
|
||||
<li><a class="reference internal" href="#shell">shell</a></li>
|
||||
<li><a class="reference internal" href="#supervisorctl">supervisorctl</a></li>
|
||||
<li><a class="reference internal" href="#template">template</a></li>
|
||||
<li><a class="reference internal" href="#user">user</a></li>
|
||||
<li><a class="reference internal" href="#virt">virt</a></li>
|
||||
<li><a class="reference internal" href="#yum">yum</a></li>
|
||||
<li><a class="reference internal" href="#additional-contrib-modules">Additional Contrib Modules</a></li>
|
||||
<li><a class="reference internal" href="#writing-your-own-modules">Writing your own modules</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
@ -473,6 +476,43 @@ relative.</td>
|
|||
<div class="highlight-python"><pre>copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="easy-install">
|
||||
<h2>easy_install<a class="headerlink" href="#easy-install" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The easy_install module installs Python libraries.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="17%" />
|
||||
<col width="9%" />
|
||||
<col width="8%" />
|
||||
<col width="66%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr><th class="head">parameter</th>
|
||||
<th class="head">required</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head">comments</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr><td>name</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>a Python library name</td>
|
||||
</tr>
|
||||
<tr><td>virtualenv</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<td>an optional virtualenv directory path to install into, if the virtualenv
|
||||
does not exist it is created automatically</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Example action from Ansible <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>easy_install name=flask
|
||||
easy_install name=flask==0.8
|
||||
easy_install name=flask virtualenv=/srv/webapps/my_app/venv</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="facter">
|
||||
<span id="id6"></span><h2>facter<a class="headerlink" href="#facter" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Runs the discovery program ‘facter’ on the remote system, returning
|
||||
|
@ -1287,8 +1327,42 @@ use your best judgement.</p>
|
|||
<div class="highlight-python"><pre>shell somescript.sh >> somelog.txt</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="supervisorctl">
|
||||
<span id="id20"></span><h2>supervisorctl<a class="headerlink" href="#supervisorctl" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Manage the state of a program or group of programs running via Supervisord</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="17%" />
|
||||
<col width="9%" />
|
||||
<col width="8%" />
|
||||
<col width="66%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr><th class="head">parameter</th>
|
||||
<th class="head">required</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head">comments</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr><td>name</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>The name of the supervisord program/process to manage</td>
|
||||
</tr>
|
||||
<tr><td>state</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>‘started’, ‘stopped’ or ‘restarted’</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Example action from a playbook:</p>
|
||||
<div class="highlight-python"><pre>supervisorctl name=my_app state=started</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="template">
|
||||
<span id="id20"></span><h2>template<a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id21"></span><h2>template<a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Templates a file out to a remote server.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
@ -1328,7 +1402,7 @@ a relative or absolute path.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="user">
|
||||
<span id="id21"></span><h2>user<a class="headerlink" href="#user" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id22"></span><h2>user<a class="headerlink" href="#user" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Creates user accounts, manipulates existing user accounts, and removes user accounts.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
@ -1427,7 +1501,7 @@ user name=mdehaan state=absent force=yes</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="virt">
|
||||
<span id="id22"></span><h2>virt<a class="headerlink" href="#virt" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id23"></span><h2>virt<a class="headerlink" href="#virt" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Manages virtual machines supported by libvirt. Requires that libvirt be installed
|
||||
on the managed machine.</p>
|
||||
<table border="1" class="docutils">
|
||||
|
@ -1487,7 +1561,7 @@ ansible host -m virt -a "command=virttype"</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="yum">
|
||||
<span id="id23"></span><h2>yum<a class="headerlink" href="#yum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id24"></span><h2>yum<a class="headerlink" href="#yum" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Will install, upgrade, remove, and list packages with the yum package manager.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
@ -1528,9 +1602,9 @@ yum name=httpd state=removed
|
|||
yum name=httpd state=installed</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="additional-modules">
|
||||
<h2>Additional Contrib Modules</h2>
|
||||
<p>In addition to the following built-in modules, community modules are available at <a href="http://github.com/ansible/ansible-resources">http://github.com/ansible/ansible-resources</a>.</p>
|
||||
<div class="section" id="additional-contrib-modules">
|
||||
<h2>Additional Contrib Modules<a class="headerlink" href="#additional-contrib-modules" title="Permalink to this headline">¶</a></h2>
|
||||
<p>In addition to the following built-in modules, community modules are available at <a class="reference external" href="http://github.com/ansible/ansible-resources">Ansible Resources</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="writing-your-own-modules">
|
||||
<h2>Writing your own modules<a class="headerlink" href="#writing-your-own-modules" title="Permalink to this headline">¶</a></h2>
|
||||
|
@ -1538,7 +1612,7 @@ yum name=httpd state=installed</pre>
|
|||
<div class="admonition-see-also admonition seealso">
|
||||
<p class="first admonition-title">See also</p>
|
||||
<dl class="last docutils">
|
||||
<dt><a class="reference external" href="https://github.com/ansible/ansible-resources"><em>Ansible Resources</em></a></dt>
|
||||
<dt><a class="reference external" href="https://github.com/ansible/ansible-resources">Ansible Resources</a></dt>
|
||||
<dd>User contributed playbooks, modules, and articles</dd>
|
||||
<dt><a class="reference internal" href="examples.html"><em>Command Line</em></a></dt>
|
||||
<dd>Examples of using modules in /usr/bin/ansible</dd>
|
||||
|
@ -1585,9 +1659,9 @@ yum name=httpd state=installed</pre>
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
|
@ -381,7 +381,7 @@ a <a class="reference external" href="https://github.com/ansible/ansible/blob/de
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -536,7 +536,7 @@ package is installed. Try it!</p>
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -615,7 +615,7 @@ logs from ansible-pull runs would be an excellent way to gather and analyze remo
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
@ -182,7 +182,7 @@ Example action from Ansible :doc:`playbooks`::
|
|||
|
||||
|
||||
|
||||
.. _easy_install
|
||||
.. easy_install
|
||||
|
||||
easy_install
|
||||
````````````
|
||||
|
@ -938,7 +938,7 @@ See :doc:`moduledev`.
|
|||
|
||||
.. seealso::
|
||||
|
||||
`Ansible Resources <https://github.com/ansible/ansible-resources>`_
|
||||
`Ansible Resources (Contrib) <https://github.com/ansible/ansible-resources>`_
|
||||
User contributed playbooks, modules, and articles
|
||||
:doc:`examples`
|
||||
Examples of using modules in /usr/bin/ansible
|
||||
|
|
|
@ -222,7 +222,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -264,7 +264,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
</p>
|
||||
<p>
|
||||
© Copyright 2012 Michael DeHaan.<br/>
|
||||
Last updated on Aug 08, 2012.<br/>
|
||||
Last updated on Aug 09, 2012.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
Loading…
Reference in a new issue