Skip to content

A
ansible
Commit 041cea13 by Michael DeHaan
Options

New Sphinx theme has sidebar navigation so don't need TOC on each page.

parent be78b50e
Showing with 0 additions and 99 deletions
docsite/rst/YAMLSyntax.rst
YAML Syntax YAML Syntax
=========== ===========
.. contents::
:depth: 2
This page provides a basic overview of correct YAML syntax, which is how Ansible This page provides a basic overview of correct YAML syntax, which is how Ansible
playbooks (our configuration management language) are expressed. playbooks (our configuration management language) are expressed.
......
docsite/rst/developing_api.rst
...@@ -13,9 +13,6 @@ as it has a very nice REST API that provides all of these things at a higher lev ...@@ -13,9 +13,6 @@ as it has a very nice REST API that provides all of these things at a higher lev
Ansible is written in its own API so you have a considerable amount of power across the board. Ansible is written in its own API so you have a considerable amount of power across the board.
This chapter discusses the Python API. This chapter discusses the Python API.
.. contents:: `Table of contents`
:depth: 2
.. _python_api: .. _python_api:
Python API Python API
......
docsite/rst/developing_inventory.rst
Developing Dynamic Inventory Sources Developing Dynamic Inventory Sources
==================================== ====================================
.. contents:: `Table of contents`
:depth: 2
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?
......
docsite/rst/developing_modules.rst
...@@ -13,9 +13,6 @@ Should you develop an interesting Ansible module, consider sending a pull reques ...@@ -13,9 +13,6 @@ Should you develop an interesting Ansible module, consider sending a pull reques
`github project <http://github.com/ansible/ansible>`_ to see about getting your module `github project <http://github.com/ansible/ansible>`_ to see about getting your module
included in the core project. included in the core project.
.. contents::
:depth: 2
.. _module_dev_tutorial: .. _module_dev_tutorial:
Tutorial Tutorial
......
docsite/rst/developing_plugins.rst
Developing Plugins Developing Plugins
================== ==================
.. contents::
:depth: 2
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.
......
docsite/rst/faq.rst
...@@ -3,9 +3,6 @@ Frequently Asked Questions ...@@ -3,9 +3,6 @@ Frequently Asked Questions
Here are some commonly-asked questions and their answers. Here are some commonly-asked questions and their answers.
.. contents::
:depth: 2
.. _users_and_ports: .. _users_and_ports:
How do I handle different machines needing different user accounts or ports to log in with? How do I handle different machines needing different user accounts or ports to log in with?
......
docsite/rst/glossary.rst
Glossary Glossary
======== ========
.. contents::
:depth: 2
The following is a list (and re-explanation) of term definitions used elsewhere in the Ansible documentation. The following is a list (and re-explanation) of term definitions used elsewhere in the Ansible documentation.
Consult the documentation home page for the full documentation and to see the terms in context, but this should be a good resource Consult the documentation home page for the full documentation and to see the terms in context, but this should be a good resource
......
docsite/rst/guide_aws.rst
Amazon Web Services Guide Amazon Web Services Guide
========================= =========================
.. contents::
:depth: 2
.. _aws_intro: .. _aws_intro:
Introduction Introduction
......
docsite/rst/guide_rax.rst
Rackspace Cloud Guide Rackspace Cloud Guide
===================== =====================
.. contents::
:depth: 3
.. _introduction: .. _introduction:
Introduction Introduction
......
docsite/rst/guide_rolling_upgrade.rst
Continuous Delivery and Rolling Upgrades Continuous Delivery and Rolling Upgrades
======================================== ========================================
.. contents::
:depth: 2
.. _lamp_introduction: .. _lamp_introduction:
Introduction Introduction
......
docsite/rst/guide_vagrant.rst
Using Vagrant and Ansible Using Vagrant and Ansible
========================= =========================
.. contents::
:depth: 2
.. _vagrant_intro: .. _vagrant_intro:
Introduction Introduction
......
docsite/rst/intro_adhoc.rst
...@@ -31,9 +31,6 @@ port over directly to the playbook language. ...@@ -31,9 +31,6 @@ port over directly to the playbook language.
If you haven't read :doc:`intro_inventory` already, please look that over a bit first If you haven't read :doc:`intro_inventory` already, please look that over a bit first
and then we'll get going. and then we'll get going.
.. contents::
:depth: 2
.. _parallelism_and_shell_commands: .. _parallelism_and_shell_commands:
Parallelism and Shell Commands Parallelism and Shell Commands
......
docsite/rst/intro_configuration.rst
...@@ -15,9 +15,6 @@ The mechanism for doing this is the "ansible.cfg" file, which is looked for in t ...@@ -15,9 +15,6 @@ The mechanism for doing this is the "ansible.cfg" file, which is looked for in t
If multiple file locations matching the above exist, the last location on the above list is used. Settings in files If multiple file locations matching the above exist, the last location on the above list is used. Settings in files
are not merged together. are not merged together.
.. contents::
:depth: 2
.. _getting_the_latest_configuration: .. _getting_the_latest_configuration:
Getting the latest configuration Getting the latest configuration
......
docsite/rst/intro_dynamic_inventory.rst
...@@ -16,9 +16,6 @@ Ansible easily supports all of these options via an external inventory system. ...@@ -16,9 +16,6 @@ Ansible easily supports all of these options via an external inventory system.
For information about writing your own dynamic inventory source, see :doc:`developing_inventory`. For information about writing your own dynamic inventory source, see :doc:`developing_inventory`.
.. contents::
:depth: 2
.. _cobbler_example: .. _cobbler_example:
......
docsite/rst/intro_getting_started.rst
Getting Started Getting Started
=============== ===============
.. contents::
:depth: 2
.. _gs_about: .. _gs_about:
About About
......
docsite/rst/intro_installation.rst
Installation Installation
============ ============
.. contents::
:depth: 2
.. _getting_ansible: .. _getting_ansible:
Getting Ansible Getting Ansible
......
docsite/rst/intro_inventory.rst
...@@ -12,9 +12,6 @@ Not only is this inventory configurable, but you can also use ...@@ -12,9 +12,6 @@ Not only is this inventory configurable, but you can also use
multiple inventory files at the same time (explained below) and also multiple inventory files at the same time (explained below) and also
pull inventory from dynamic or cloud sources, as described in :doc:`intro_dynamic_inventory`. pull inventory from dynamic or cloud sources, as described in :doc:`intro_dynamic_inventory`.
.. contents::
:depth: 2
.. _inventoryformat: .. _inventoryformat:
Hosts and Groups Hosts and Groups
......
docsite/rst/intro_patterns.rst
Patterns Patterns
++++++++ ++++++++
.. contents::
:depth: 2
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.
......
docsite/rst/playbooks.rst
Intro to Playbooks Intro to Playbooks
================== ==================
.. contents::
:depth: 2
.. _about_playbooks: .. _about_playbooks:
About Playbooks About Playbooks
......
docsite/rst/playbooks_acceleration.rst
Accelerated Mode Accelerated Mode
================ ================
.. contents::
:depth: 2
.. versionadded:: 1.3 .. versionadded:: 1.3
While OpenSSH using the ControlPersist feature is quite fast and scalable, there is a certain small amount of overhead involved in While OpenSSH using the ControlPersist feature is quite fast and scalable, there is a certain small amount of overhead involved in
......
docsite/rst/playbooks_async.rst
Asynchronous Actions and Polling Asynchronous Actions and Polling
================================ ================================
.. contents::
:depth: 2
By default tasks in playbooks block, meaning the connections stay open By default tasks in playbooks block, meaning the connections stay open
until the task is done on each node. This may not always be desirable, or you may until the task is done on each node. This may not always be desirable, or you may
be running operations that take longer than the SSH timeout. be running operations that take longer than the SSH timeout.
......
docsite/rst/playbooks_best_practices.rst
...@@ -5,9 +5,6 @@ Here are some tips for making the most of Ansible playbooks. ...@@ -5,9 +5,6 @@ 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::
:depth: 2
.. _content_organization: .. _content_organization:
Content Organization Content Organization
......
docsite/rst/playbooks_checkmode.rst
Check Mode ("Dry Run") Check Mode ("Dry Run")
====================== ======================
.. contents::
:depth: 2
.. versionadded:: 1.1 .. versionadded:: 1.1
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
......
docsite/rst/playbooks_conditionals.rst
Conditionals Conditionals
============ ============
.. contents::
:depth: 2
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
......
docsite/rst/playbooks_delegation.rst
Delegation, Rolling Updates, and Local Actions Delegation, Rolling Updates, and Local Actions
============================================== ==============================================
.. contents::
:depth: 2
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.
......
docsite/rst/playbooks_environment.rst
Setting the Environment (and Working With Proxies) Setting the Environment (and Working With Proxies)
================================================== ==================================================
.. contents::
:depth: 2
.. versionadded:: 1.1 .. versionadded:: 1.1
It is quite possible that you may need to get package updates through a proxy, or even get some package It is quite possible that you may need to get package updates through a proxy, or even get some package
......
docsite/rst/playbooks_error_handling.rst
Error Handling In Playbooks Error Handling In Playbooks
=========================== ===========================
.. contents::
:depth: 2
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.
......
docsite/rst/playbooks_lookups.rst
Using Lookups Using Lookups
============= =============
.. contents::
:depth: 2
Lookup plugins allow access of data in Ansible from outside sources. This can include the filesystem Lookup plugins allow access of data in Ansible from outside sources. This can include the filesystem
but also external datastores. These values are then made available using the standard templating system but also external datastores. These values are then made available using the standard templating system
in Ansible, and are typically used to load variables or templates with information from those systems. in Ansible, and are typically used to load variables or templates with information from those systems.
......
docsite/rst/playbooks_loops.rst
Loops Loops
===== =====
.. contents::
:depth: 2
Often you'll want to do many things in one task, such as create a lot of users, install a lot of packages, or Often you'll want to do many things in one task, such as create a lot of users, install a lot of packages, or
repeat a polling step until a certain result is reached. repeat a polling step until a certain result is reached.
......
docsite/rst/playbooks_prompts.rst
Prompts Prompts
======= =======
.. contents::
:depth: 2
When running a playbook, you may wish to prompt the user for certain input, and can When running a playbook, you may wish to prompt the user for certain input, and can
do so with the 'vars_prompt' section. do so with the 'vars_prompt' section.
......
docsite/rst/playbooks_roles.rst
Playbook Roles and Include Statements Playbook Roles and Include Statements
===================================== =====================================
.. contents::
:depth: 2
Introduction Introduction
```````````` ````````````
......
docsite/rst/playbooks_tags.rst
Tags Tags
==== ====
.. contents::
:depth: 2
If you have a large playbook it may become useful to be able to run a If you have a large playbook it may become useful to be able to run a
specific part of the configuration without running the whole playbook. specific part of the configuration without running the whole playbook.
......
docsite/rst/playbooks_variables.rst
...@@ -21,9 +21,6 @@ and the "when" conditional can also be used with variables, and to help manage d ...@@ -21,9 +21,6 @@ and the "when" conditional can also be used with variables, and to help manage d
It's highly recommended that you consult the ansible-examples github repository to see a lot of examples of variables put to use. It's highly recommended that you consult the ansible-examples github repository to see a lot of examples of variables put to use.
.. contents::
:depth: 2
.. _valid_variable_names: .. _valid_variable_names:
What Makes A Valid Variable Name What Makes A Valid Variable Name
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment