mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
More work fixing doc links.
This commit is contained in:
parent
df8b8fc4d6
commit
5d6deb68ae
8 changed files with 19 additions and 16 deletions
|
@ -31,6 +31,7 @@ An Introduction
|
||||||
intro_dynamic_inventory
|
intro_dynamic_inventory
|
||||||
intro_patterns
|
intro_patterns
|
||||||
intro_adhoc
|
intro_adhoc
|
||||||
|
intro_configuration
|
||||||
modules
|
modules
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
|
@ -71,16 +72,20 @@ Advanced Topics In Playbooks
|
||||||
|
|
||||||
Here are some playbook features that not everyone may need to learn, but can be quite useful for particular applications.
|
Here are some playbook features that not everyone may need to learn, but can be quite useful for particular applications.
|
||||||
Browsing these topics is recommended as you may find some useful tips here, but feel free to learn Ansible first and adopt
|
Browsing these topics is recommended as you may find some useful tips here, but feel free to learn Ansible first and adopt
|
||||||
these only if they seem relevant or useful to your environment::
|
these only if they seem relevant or useful to your environment.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
playbooks_acceleration
|
playbooks_acceleration
|
||||||
playbooks_check_mode
|
playbooks_async
|
||||||
|
playbooks_checkmode
|
||||||
playbooks_delegation
|
playbooks_delegation
|
||||||
playbooks_environment
|
playbooks_environment
|
||||||
playbooks_error_handling
|
playbooks_error_handling
|
||||||
playbooks_lookups
|
playbooks_lookups
|
||||||
playbooks_prompts
|
playbooks_prompts
|
||||||
playbooks_strategies
|
playbooks_tags
|
||||||
|
|
||||||
Detailed Guides
|
Detailed Guides
|
||||||
```````````````
|
```````````````
|
||||||
|
@ -129,6 +134,5 @@ Miscellaneous
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
faq
|
faq
|
||||||
contrib
|
|
||||||
glossary
|
glossary
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.. _patterns:
|
.. _dynamic_inventory:
|
||||||
|
|
||||||
Dynamic Inventory
|
Dynamic Inventory
|
||||||
=================
|
=================
|
||||||
|
|
|
@ -111,7 +111,7 @@ Also note that host key checking in paramiko mode is reasonably slow, therefore
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
:doc:`intro_ad_hoc`
|
:doc:`intro_adhoc`
|
||||||
Examples of basic commands
|
Examples of basic commands
|
||||||
:doc:`playbooks`
|
:doc:`playbooks`
|
||||||
Learning ansible's configuration management language
|
Learning ansible's configuration management language
|
||||||
|
|
|
@ -110,7 +110,7 @@ Ansible also uses the the following Python modules that need to be installed::
|
||||||
$ sudo pip install paramiko PyYAML jinja2
|
$ sudo pip install paramiko PyYAML jinja2
|
||||||
|
|
||||||
Once running the env-setup script you'll be running from checkout and the default inventory file
|
Once running the env-setup script you'll be running from checkout and the default inventory file
|
||||||
will be /etc/ansible/hosts. You can optionally specify an inventory file (see :doc:`intro_inventroy`)
|
will be /etc/ansible/hosts. You can optionally specify an inventory file (see :doc:`intro_inventory`)
|
||||||
other than /etc/ansible/hosts:
|
other than /etc/ansible/hosts:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
@ -274,7 +274,7 @@ Now run a live command on all of your nodes:
|
||||||
$ ansible all -a "/bin/echo hello"
|
$ ansible all -a "/bin/echo hello"
|
||||||
|
|
||||||
Congratulations. You've just contacted your nodes with Ansible. It's
|
Congratulations. You've just contacted your nodes with Ansible. It's
|
||||||
soon going to be time to read some of the more real-world :doc:`examples`, and explore
|
soon going to be time to read some of the more real-world :doc:`intro_adhoc`, and explore
|
||||||
what you can do with different modules, as well as the Ansible
|
what you can do with different modules, as well as the Ansible
|
||||||
:doc:`playbooks` language. Ansible is not just about running commands, it
|
:doc:`playbooks` language. Ansible is not just about running commands, it
|
||||||
also has powerful configuration management and deployment features. There's more to
|
also has powerful configuration management and deployment features. There's more to
|
||||||
|
@ -325,7 +325,7 @@ feature.
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
:doc:`examples`
|
:doc:`intro_adhoc`
|
||||||
Examples of basic commands
|
Examples of basic commands
|
||||||
:doc:`playbooks`
|
:doc:`playbooks`
|
||||||
Learning ansible's configuration management language
|
Learning ansible's configuration management language
|
||||||
|
|
|
@ -262,7 +262,7 @@ parameter in your playbooks to make it clear, especially as some modules support
|
||||||
Group By Roles
|
Group By Roles
|
||||||
++++++++++++++
|
++++++++++++++
|
||||||
|
|
||||||
A system can be in multiple groups. See :doc:`patterns`. Having groups named after things like
|
A system can be in multiple groups. See :doc:`intro_inventory` and :doc:`intro_patterns`. Having groups named after things like
|
||||||
*webservers* and *dbservers* is repeated in the examples because it's a very powerful concept.
|
*webservers* and *dbservers* is repeated in the examples because it's a very powerful concept.
|
||||||
|
|
||||||
This allows playbooks to target machines based on role, as well as to assign role specific variables
|
This allows playbooks to target machines based on role, as well as to assign role specific variables
|
||||||
|
@ -348,9 +348,9 @@ changed the rules that are automating your infrastructure.
|
||||||
Review the basic playbook features
|
Review the basic playbook features
|
||||||
:doc:`modules`
|
:doc:`modules`
|
||||||
Learn about available modules
|
Learn about available modules
|
||||||
:doc:`moduledev`
|
:doc:`developing_modules`
|
||||||
Learn how to extend Ansible by writing your own modules
|
Learn how to extend Ansible by writing your own modules
|
||||||
:doc:`patterns`
|
:doc:`intro_patterns`
|
||||||
Learn about how to select hosts
|
Learn about how to select hosts
|
||||||
`Github examples directory <https://github.com/ansible/ansible/tree/devel/examples/playbooks>`_
|
`Github examples directory <https://github.com/ansible/ansible/tree/devel/examples/playbooks>`_
|
||||||
Complete playbook files from the github project source
|
Complete playbook files from the github project source
|
||||||
|
|
|
@ -85,7 +85,7 @@ If a required variable has not been set, you can skip or fail using Jinja2's
|
||||||
This is especially useful in combination with the conditional import of vars
|
This is especially useful in combination with the conditional import of vars
|
||||||
files (see below).
|
files (see below).
|
||||||
|
|
||||||
Note that when combining `when` with `with_items` (see :doc:`playbook_loops`), be aware that the `when` statement is processed separately for each item. This is by design::
|
Note that when combining `when` with `with_items` (see :doc:`playbooks_loops`), be aware that the `when` statement is processed separately for each item. This is by design::
|
||||||
|
|
||||||
tasks:
|
tasks:
|
||||||
- command: echo {{ item }}
|
- command: echo {{ item }}
|
||||||
|
|
|
@ -63,7 +63,7 @@ contain all of my wordpress tasks in a single wordpress.yml file, and use it lik
|
||||||
- include: wordpress.yml user=alice
|
- include: wordpress.yml user=alice
|
||||||
- include: wordpress.yml user=bob
|
- include: wordpress.yml user=bob
|
||||||
|
|
||||||
Variables passed in can then be used in the included files. We've already covered them a bit in :doc:`intro_variables`.
|
Variables passed in can then be used in the included files. We've already covered them a bit in :doc:`playbooks_variables`.
|
||||||
You can reference them like this::
|
You can reference them like this::
|
||||||
|
|
||||||
{{ user }}
|
{{ user }}
|
||||||
|
|
|
@ -73,8 +73,7 @@ To see what information is available, try the following::
|
||||||
|
|
||||||
ansible hostname -m setup
|
ansible hostname -m setup
|
||||||
|
|
||||||
The results of this can be used to create dynamic groups of hosts that match particular critera, see the :doc:`group_by` for details,
|
The results of this can be used to create dynamic groups of hosts that match particular critera, see the :doc:`modules` documentation on 'group_by' for details, as well as in generalized conditional statements as discussed in the `playbook_conditionals` chapter.
|
||||||
as well as in generalized conditional statements as discussed in the `playbook_conditionals` chapter.
|
|
||||||
|
|
||||||
Turning Off Facts
|
Turning Off Facts
|
||||||
`````````````````
|
`````````````````
|
||||||
|
|
Loading…
Reference in a new issue