mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
New Sphinx theme has sidebar navigation so don't need TOC on each page.
This commit is contained in:
parent
be78b50ea0
commit
041cea134f
33 changed files with 0 additions and 99 deletions
|
@ -1,9 +1,6 @@
|
|||
YAML Syntax
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
This page provides a basic overview of correct YAML syntax, which is how Ansible
|
||||
playbooks (our configuration management language) are expressed.
|
||||
|
||||
|
|
|
@ -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.
|
||||
This chapter discusses the Python API.
|
||||
|
||||
.. contents:: `Table of contents`
|
||||
:depth: 2
|
||||
|
||||
.. _python_api:
|
||||
|
||||
Python API
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
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.
|
||||
|
||||
How do we write a new one?
|
||||
|
|
|
@ -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
|
||||
included in the core project.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _module_dev_tutorial:
|
||||
|
||||
Tutorial
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
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
|
||||
in ansible and were most convenient to be made pluggable.
|
||||
|
||||
|
|
|
@ -3,9 +3,6 @@ Frequently Asked Questions
|
|||
|
||||
Here are some commonly-asked questions and their answers.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _users_and_ports:
|
||||
|
||||
How do I handle different machines needing different user accounts or ports to log in with?
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Glossary
|
||||
========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
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
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Amazon Web Services Guide
|
||||
=========================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _aws_intro:
|
||||
|
||||
Introduction
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Rackspace Cloud Guide
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 3
|
||||
|
||||
.. _introduction:
|
||||
|
||||
Introduction
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Continuous Delivery and Rolling Upgrades
|
||||
========================================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _lamp_introduction:
|
||||
|
||||
Introduction
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Using Vagrant and Ansible
|
||||
=========================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _vagrant_intro:
|
||||
|
||||
Introduction
|
||||
|
|
|
@ -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
|
||||
and then we'll get going.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _parallelism_and_shell_commands:
|
||||
|
||||
Parallelism and Shell Commands
|
||||
|
|
|
@ -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
|
||||
are not merged together.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _getting_the_latest_configuration:
|
||||
|
||||
Getting the latest configuration
|
||||
|
|
|
@ -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`.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
|
||||
.. _cobbler_example:
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Getting Started
|
||||
===============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _gs_about:
|
||||
|
||||
About
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _getting_ansible:
|
||||
|
||||
Getting Ansible
|
||||
|
|
|
@ -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
|
||||
pull inventory from dynamic or cloud sources, as described in :doc:`intro_dynamic_inventory`.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _inventoryformat:
|
||||
|
||||
Hosts and Groups
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
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
|
||||
of :doc:`playbooks` it actually means what hosts to apply a particular configuration or IT process to.
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Intro to Playbooks
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _about_playbooks:
|
||||
|
||||
About Playbooks
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Accelerated Mode
|
||||
================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. versionadded:: 1.3
|
||||
|
||||
While OpenSSH using the ControlPersist feature is quite fast and scalable, there is a certain small amount of overhead involved in
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Asynchronous Actions and Polling
|
||||
================================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
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
|
||||
be running operations that take longer than the SSH timeout.
|
||||
|
|
|
@ -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!).
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _content_organization:
|
||||
|
||||
Content Organization
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Check Mode ("Dry Run")
|
||||
======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. versionadded:: 1.1
|
||||
|
||||
When ansible-playbook is executed with --check it will not make any changes on remote systems. Instead, any module
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
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),
|
||||
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
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
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.
|
||||
|
||||
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.
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Setting the Environment (and Working With Proxies)
|
||||
==================================================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. versionadded:: 1.1
|
||||
|
||||
It is quite possible that you may need to get package updates through a proxy, or even get some package
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Error Handling In Playbooks
|
||||
===========================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Using Lookups
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
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
|
||||
in Ansible, and are typically used to load variables or templates with information from those systems.
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
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
|
||||
repeat a polling step until a certain result is reached.
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Prompts
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
When running a playbook, you may wish to prompt the user for certain input, and can
|
||||
do so with the 'vars_prompt' section.
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Playbook Roles and Include Statements
|
||||
=====================================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
Introduction
|
||||
````````````
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
Tags
|
||||
====
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
|
||||
.. _valid_variable_names:
|
||||
|
||||
What Makes A Valid Variable Name
|
||||
|
|
Loading…
Reference in a new issue