Add contents to various pages with more than one topic per page.

This commit is contained in:
Michael DeHaan 2013-12-26 14:32:01 -05:00
parent 8733b5da8b
commit 1c29f043b4
19 changed files with 41 additions and 2 deletions

View file

@ -1,6 +1,8 @@
Python API Python API
========== ==========
.. contents:: Topics
There are several interesting ways to use Ansible from an API perspective. You can use There are several interesting ways to use Ansible from an API perspective. You can use
the Ansible python API to control nodes, you can extend Ansible to respond to various python events, you can the Ansible python API to control nodes, you can extend Ansible to respond to various python events, you can
write various plugins, and you can plug in inventory data from external data sources. This document write various plugins, and you can plug in inventory data from external data sources. This document

View file

@ -1,6 +1,8 @@
Developing Dynamic Inventory Sources Developing Dynamic Inventory Sources
==================================== ====================================
.. contents:: Topics
As described in `intro_inventory_dynamic`, ansible can pull inventory information from dynamic sources, including cloud sources. As described in `intro_inventory_dynamic`, ansible can pull inventory information from dynamic sources, including cloud sources.
How do we write a new one? How do we write a new one?

View file

@ -1,6 +1,8 @@
Developing Modules Developing Modules
================== ==================
.. contents:: Topics
Ansible modules are reusable units of magic that can be used by the Ansible API, Ansible modules are reusable units of magic that can be used by the Ansible API,
or by the `ansible` or `ansible-playbook` programs. or by the `ansible` or `ansible-playbook` programs.

View file

@ -1,6 +1,8 @@
Developing Plugins Developing Plugins
================== ==================
.. contents:: Topics
Ansible is pluggable in a lot of other ways separate from inventory scripts and callbacks. Many of these features are there to cover fringe use cases and are infrequently needed, and others are pluggable simply because they are there to implement core features Ansible is pluggable in a lot of other ways separate from inventory scripts and callbacks. Many of these features are there to cover fringe use cases and are infrequently needed, and others are pluggable simply because they are there to implement core features
in ansible and were most convenient to be made pluggable. in ansible and were most convenient to be made pluggable.

View file

@ -1,6 +1,8 @@
Introduction To Ad-Hoc Commands Introduction To Ad-Hoc Commands
=============================== ===============================
.. contents:: Topics
.. highlight:: bash .. highlight:: bash
The following examples show how to use `/usr/bin/ansible` for running The following examples show how to use `/usr/bin/ansible` for running

View file

@ -1,6 +1,8 @@
The Ansible Configuration File The Ansible Configuration File
++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++
.. contents:: Topics
.. highlight:: bash .. highlight:: bash
Certain things in Ansible are adjustable in a configuration file. In general, the stock configuration is probably Certain things in Ansible are adjustable in a configuration file. In general, the stock configuration is probably

View file

@ -3,6 +3,8 @@
Dynamic Inventory Dynamic Inventory
================= =================
.. contents:: Topics
Often a user of a configuration management system will want to keep inventory Often a user of a configuration management system will want to keep inventory
in a different software system. Ansible provides a basic text-based system as described in in a different software system. Ansible provides a basic text-based system as described in
:doc:`intro_inventory` but what if you want to use something else? :doc:`intro_inventory` but what if you want to use something else?

View file

@ -1,10 +1,12 @@
Getting Started Getting Started
=============== ===============
.. contents:: Topics
.. _gs_about: .. _gs_about:
About Foreword
````` ````````
Now that you've read :doc:`intro_installation` and installed Ansible, it's time to dig in and get Now that you've read :doc:`intro_installation` and installed Ansible, it's time to dig in and get
started with some commands. started with some commands.

View file

@ -3,6 +3,8 @@
Inventory Inventory
========= =========
.. contents:: Topics
Ansible works against multiple systems in your infrastructure at the Ansible works against multiple systems in your infrastructure at the
same time. It does this by selecting portions of systems listed in same time. It does this by selecting portions of systems listed in
Ansible's inventory file, which defaults to being saved in Ansible's inventory file, which defaults to being saved in

View file

@ -1,6 +1,8 @@
Patterns Patterns
++++++++ ++++++++
.. contents:: Topics
Patterns in Ansible are how we decide which hosts to manage. This can mean what hosts to communicate with, but in terms Patterns in Ansible are how we decide which hosts to manage. This can mean what hosts to communicate with, but in terms
of :doc:`playbooks` it actually means what hosts to apply a particular configuration or IT process to. of :doc:`playbooks` it actually means what hosts to apply a particular configuration or IT process to.

View file

@ -5,6 +5,8 @@ Here are some tips for making the most of Ansible playbooks.
You can find some example playbooks illustrating these best practices in our `ansible-examples repository <https://github.com/ansible/ansible-examples>`_. (NOTE: These may not use all of the features in the latest release, but are still an excellent reference!). You can find some example playbooks illustrating these best practices in our `ansible-examples repository <https://github.com/ansible/ansible-examples>`_. (NOTE: These may not use all of the features in the latest release, but are still an excellent reference!).
.. contents:: Topics
.. _content_organization: .. _content_organization:
Content Organization Content Organization

View file

@ -3,6 +3,8 @@ Check Mode ("Dry Run")
.. versionadded:: 1.1 .. versionadded:: 1.1
.. contents:: Topics
When ansible-playbook is executed with --check it will not make any changes on remote systems. Instead, any module When ansible-playbook is executed with --check it will not make any changes on remote systems. Instead, any module
instrumented to support 'check mode' (which contains most of the primary core modules, but it is not required that all modules do instrumented to support 'check mode' (which contains most of the primary core modules, but it is not required that all modules do
this) will report what changes they would have made rather than making them. Other modules that do not support check mode will also take no action, but just will not report what changes they might have made. this) will report what changes they would have made rather than making them. Other modules that do not support check mode will also take no action, but just will not report what changes they might have made.

View file

@ -1,6 +1,9 @@
Conditionals Conditionals
============ ============
.. contents:: Topics
Often the result of a play may depend on the value of a variable, fact (something learned about the remote system), Often the result of a play may depend on the value of a variable, fact (something learned about the remote system),
or previous task result. In some cases, the values of variables may depend on other variables. or previous task result. In some cases, the values of variables may depend on other variables.
Further, additional groups can be created to manage hosts based on Further, additional groups can be created to manage hosts based on

View file

@ -1,6 +1,8 @@
Delegation, Rolling Updates, and Local Actions Delegation, Rolling Updates, and Local Actions
============================================== ==============================================
.. contents:: Topics
Being designed for multi-tier deployments since the beginning, Ansible is great at doing things on one host on behalf of another, or doing local steps with reference to some remote hosts. Being designed for multi-tier deployments since the beginning, Ansible is great at doing things on one host on behalf of another, or doing local steps with reference to some remote hosts.
This in particular this is very applicable when setting up continuous deployment infrastructure or zero downtime rolling updates, where you might be talking with load balancers or monitoring systems. This in particular this is very applicable when setting up continuous deployment infrastructure or zero downtime rolling updates, where you might be talking with load balancers or monitoring systems.

View file

@ -1,6 +1,8 @@
Error Handling In Playbooks Error Handling In Playbooks
=========================== ===========================
.. contents:: Topics
Ansible normally has defaults that make sure to check the return codes of commands and modules and Ansible normally has defaults that make sure to check the return codes of commands and modules and
it fails fast -- forcing an error to be dealt with unless you decide otherwise. it fails fast -- forcing an error to be dealt with unless you decide otherwise.

View file

@ -7,6 +7,8 @@ in Ansible, and are typically used to load variables or templates with informati
.. note:: This is considered an advanced feature, and many users will probably not rely on these features. .. note:: This is considered an advanced feature, and many users will probably not rely on these features.
.. contents:: Topics
.. _getting_file_contents: .. _getting_file_contents:
Intro to Lookups: Getting File Contents Intro to Lookups: Getting File Contents

View file

@ -6,6 +6,8 @@ repeat a polling step until a certain result is reached.
This chapter is all about how to use loops in playbooks. This chapter is all about how to use loops in playbooks.
.. contents:: Topics
.. _standard_loops: .. _standard_loops:
Standard Loops Standard Loops

View file

@ -1,6 +1,8 @@
Playbook Roles and Include Statements Playbook Roles and Include Statements
===================================== =====================================
.. contents:: Topics
Introduction Introduction
```````````` ````````````

View file

@ -1,6 +1,8 @@
Variables Variables
========= =========
.. contents:: Topics
While automation exists to make it easier to make things repeatable, all of your systems are likely not exactly alike. While automation exists to make it easier to make things repeatable, all of your systems are likely not exactly alike.
All of your systems are likely not the same. On some systems you may want to set some behavior All of your systems are likely not the same. On some systems you may want to set some behavior