Add auto-gen TOCs to a bunch of pages.

This commit is contained in:
Tim Bielawa 2012-08-28 15:41:10 -04:00
parent 47eea55d13
commit b9f7ea7198
10 changed files with 49 additions and 15 deletions

View file

@ -9,6 +9,10 @@ Also covered here, Ansible's
list of hosts, groups, and variables assigned to each host can be driven from
external sources. We'll start with the Python API.
.. contents:: `Table of contents`
:depth: 2
:backlinks: top
Python API
----------
@ -268,7 +272,7 @@ When the Ansible is interacting with a specific server, the EC2 inventory script
Both ``ec2_security_group_ids`` and ``ec2_security_group_names`` are comma-separated lists of all security groups. Each EC2 tag is a variable in the format ``ec2_tag_KEY``.
To see the complete list of variables available for an instance, run the script by itself:
To see the complete list of variables available for an instance, run the script by itself::
cd examples/scripts
./ec2_external_inventory.py --host ec2-12-12-12-12.compute-1.amazonaws.com

View file

@ -3,6 +3,10 @@ Best Practices
Here are some tips for making the most of Ansible.
.. contents::
:depth: 2
:backlinks: top
Always Mention State
++++++++++++++++++++

View file

@ -10,6 +10,11 @@ For configuration management and deployments, you'll want to pick up on
using `/usr/bin/ansible-playbook` -- the concepts port over directly.
(See :doc:`playbooks` for more information about those)
.. contents::
:depth: 2
:backlinks: top
Parallelism and Shell Commands
``````````````````````````````

View file

@ -1,6 +1,9 @@
FAQ
===
.. contents::
:backlinks: top
Why Is It Called Ansible?
-------------------------

View file

@ -1,6 +1,10 @@
Getting Started
===============
.. contents::
:depth: 2
:backlinks: top
Requirements
````````````

View file

@ -7,6 +7,11 @@ or by the `ansible` or `ansible-playbook` programs.
Modules can be written in any language and are found in the path specified
by `ANSIBLE_LIBRARY_PATH` or the ``--module-path`` command line option.
.. contents::
:depth: 2
:backlinks: top
Tutorial
````````
Let's build a module to get and set the system time. For starters, let's build

View file

@ -1,6 +1,14 @@
Ansible Modules
===============
.. contents::
:depth: 2
:backlinks: top
Introduction
````````````
Ansible ships with a number of modules (called the 'module library')
that can be executed directly on remote hosts or through :doc:`playbooks`.
Users can also write their own modules. These modules can control system
@ -34,20 +42,6 @@ to run additional tasks.
Let's see what's available in the Ansible module library, out of the box:
======================= ======================= =======================
:ref:`apt_repository` :ref:`apt` :ref:`assemble`
:ref:`authorized_key` :ref:`command` :ref:`copy`
:ref:`easy_install` :ref:`facter` :ref:`fetch`
:ref:`file` :ref:`get_url` :ref:`git`
:ref:`group` :ref:`mount` :ref:`mysql_db`
:ref:`mysql_user` :ref:`nagios` :ref:`ohai`
:ref:`ping` :ref:`pip` :ref:`postgresql_db`
:ref:`postgresql_user` :ref:`raw` :ref:`service`
:ref:`setup` :ref:`shell` :ref:`supervisorctl`
:ref:`template` :ref:`user` :ref:`virt`
:ref:`yum`
======================= ======================= =======================
.. include:: modules/apt_repository.rst
.. include:: modules/apt.rst
.. include:: modules/assemble.rst

View file

@ -7,6 +7,10 @@ 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.
.. contents:: `Table of contents`
:depth: 2
:backlinks: top
.. _inventoryformat:
Hosts and Groups

View file

@ -1,6 +1,13 @@
Playbooks
=========
.. contents::
:depth: 2
:backlinks: top
Introduction
````````````
Playbooks are a completely different way to use ansible than in task execution mode, and are
particularly powerful. Simply put, playbooks are the basis for a really simple
configuration management and multi-machine deployment system,

View file

@ -6,6 +6,10 @@ are not neccessary, but many of them will prove useful. If a feature doesn't se
relevant, feel free to skip it. For many people, the features documented in `playbooks` will
be 90% or more of what they use in Ansible.
.. contents::
:depth: 2
:backlinks: top
Tags
````