Link fixes (#39038)
* fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages
This commit is contained in:
Alicia Cozine
scottb
parent
7963279fc2
commit
408e29cbd2
17 changed files with 62 additions and 55 deletions
|
|
@ -1,3 +1,5 @@
|
|||
.. _communication:
|
||||
|
||||
*************
|
||||
Communicating
|
||||
*************
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
.. _maintainers:
|
||||
|
||||
****************************
|
||||
Module Maintainer Guidelines
|
||||
****************************
|
||||
|
|
@ -8,8 +10,8 @@ Thank you for being a maintainer of part of Ansible's codebase. This guide provi
|
|||
|
||||
In addition to the information below, module maintainers should be familiar with:
|
||||
|
||||
* :ref:`General Ansible community development practices <../community>`
|
||||
* Documentation on :ref:`module development <../dev_guide/developing_modules>`
|
||||
* :ref:`General Ansible community development practices <ansible_community_guide>`
|
||||
* Documentation on :ref:`module development <developing_modules>`
|
||||
|
||||
|
||||
Maintainer Responsibilities
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
.. _reporting_bugs_and_features:
|
||||
|
||||
**************************************
|
||||
Reporting Bugs And Requesting Features
|
||||
**************************************
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Action Plugins
|
|||
:local:
|
||||
:depth: 2
|
||||
|
||||
Action plugins act in conjunction with :doc:`modules <../modules>` to execute the actions required by playbook tasks.
|
||||
Action plugins act in conjunction with :ref:`modules <working_with_modules>` to execute the actions required by playbook tasks.
|
||||
They usually execute automatically in the background doing prerequisite work before modules execute.
|
||||
|
||||
The 'normal' action plugin is used for modules that do not already have an action plugin.
|
||||
|
|
@ -15,7 +15,7 @@ The 'normal' action plugin is used for modules that do not already have an actio
|
|||
Enabling Action Plugins
|
||||
-----------------------
|
||||
|
||||
You can enable a custom action plugin by either dropping it into the ``action_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the action plugin directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
You can enable a custom action plugin by either dropping it into the ``action_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the action plugin directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
.. _using_action:
|
||||
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@ or in the ``ansible.cfg`` file:
|
|||
fact_caching=redis
|
||||
|
||||
You will also need to configure other settings specific to each plugin. Consult the individual plugin documentation
|
||||
or the Ansible :doc:`configuration <../config>` for more details.
|
||||
or the Ansible :ref:`configuration <ansible_configuration_settings>` for more details.
|
||||
|
||||
A custom cache plugin is enabled by dropping it into a ``cache_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
A custom cache plugin is enabled by dropping it into a ``cache_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
|
||||
.. _using_cache:
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ but can also be used to add additional output, integrate with other tools and ma
|
|||
Example Callback Plugins
|
||||
++++++++++++++++++++++++
|
||||
|
||||
The :doc:`log_plays <callback/log_plays>` callback is an example of how to record playbook events to a log file,
|
||||
The :doc:`_plays <callback/log_plays>` callback is an example of how to record playbook events to a log file,
|
||||
and the :doc:`mail <callback/mail>` callback sends email on playbook failures.
|
||||
|
||||
The :doc:`osx_say <callback/oxs_say>` callback responds with computer synthesized speech on OS X in relation to playbook events.
|
||||
|
|
@ -24,11 +24,11 @@ The :doc:`osx_say <callback/oxs_say>` callback responds with computer synthesize
|
|||
Enabling Callback Plugins
|
||||
++++++++++++++++++++++++++
|
||||
|
||||
You can activate a custom callback by either dropping it into a ``callback_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the callback directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
You can activate a custom callback by either dropping it into a ``callback_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the callback directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
Plugins are loaded in alphanumeric order. For example, a plugin implemented in a file named `1_first.py` would run before a plugin file named `2_second.py`.
|
||||
|
||||
Most callbacks shipped with Ansible are disabled by default and need to be whitelisted in your :doc:`ansible.cfg <../config>` file in order to function. For example:
|
||||
Most callbacks shipped with Ansible are disabled by default and need to be whitelisted in your :ref:`ansible.cfg <ansible_configuration_settings>` file in order to function. For example:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ Most callbacks shipped with Ansible are disabled by default and need to be white
|
|||
Managing stdout
|
||||
```````````````
|
||||
|
||||
You can only have one plugin be the main manager of your console output. If you want to replace the default, you should define CALLBACK_TYPE = stdout in the subclass and then configure the stdout plugin in :doc:`ansible.cfg <../config>`. For example:
|
||||
You can only have one plugin be the main manager of your console output. If you want to replace the default, you should define CALLBACK_TYPE = stdout in the subclass and then configure the stdout plugin in :ref:`ansible.cfg <ansible_configuration_settings>`. For example:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
|
|
|
|||
|
|
@ -8,8 +8,7 @@ Connection plugins allow Ansible to connect to the target hosts so it can execut
|
|||
|
||||
By default, Ansible ships with several plugins. The most commonly used are the 'paramiko' SSH, native ssh (just called 'ssh'), and 'local' connection types. All of these can be used in playbooks and with /usr/bin/ansible to decide how you want to talk to remote machines.
|
||||
|
||||
The basics of these connection types are covered in the :doc:`../intro_getting_started` section.
|
||||
|
||||
The basics of these connection types are covered in the :ref:`getting started<intro_getting_started>` section.
|
||||
|
||||
|
||||
.. _ssh_plugins:
|
||||
|
|
@ -17,7 +16,7 @@ The basics of these connection types are covered in the :doc:`../intro_getting_s
|
|||
ssh Plugins
|
||||
+++++++++++
|
||||
|
||||
Because ssh is the default protocol used in system administration and the protocol most used in Ansible, ssh options are included in the command line tools. See :doc:`../ansible-playbook` for more details.
|
||||
Because ssh is the default protocol used in system administration and the protocol most used in Ansible, ssh options are included in the command line tools. See :ref:`ansible-playbook` for more details.
|
||||
|
||||
.. _enabling_connection:
|
||||
|
||||
|
|
@ -33,22 +32,22 @@ into the ``connection_plugins`` directory.
|
|||
Using Connection Plugins
|
||||
++++++++++++++++++++++++
|
||||
|
||||
The transport can be changed via :doc:`configuration <../config>`, in the command line (``-c``, ``--connection``), as a keyword (:ref:`connection`)
|
||||
in your play, or by setting the a connection variable (:ref:`ansible_connection`), most often in your inventory.
|
||||
For example, for Windows machines you might want to use the :doc:`winrm <connection/winrm>` plugin.
|
||||
The transport can be changed via :ref:`configuration<ansible_configuration_settings>`, in the command line (``-c``, ``--connection``), as a :ref:`keyword<playbooks_keywords>`)
|
||||
in your play, or by setting a :ref:`variable<behavioral_parameters>`, most often in your inventory.
|
||||
For example, for Windows machines you might want to use the :doc:`winrm<connection/winrm>` plugin.
|
||||
|
||||
Most connection plugins can operate with a minimum configuration. By default they use the :ref:`inventory_hostname` and defaults to find the target host.
|
||||
Most connection plugins can operate with a minimum configuration. By default they use the :ref:`inventory hostname<inventory_hostname>` and defaults to find the target host.
|
||||
|
||||
Plugins are self-documenting. Each plugin should document its configuration options. The following are connection variables common to most connection plugins:
|
||||
|
||||
:ref:`ansible_host`
|
||||
The name of the host to connect to, if different from the :ref:`inventory_hostname`.
|
||||
:ref:`ansible_port`
|
||||
:ref:`ansible_host<ansible_host>`
|
||||
The name of the host to connect to, if different from the :ref:`inventory hostname<inventory_hostname>`.
|
||||
:ref:`ansible_port<ansible_port>`
|
||||
The ssh port number, for :doc:`ssh <connection/ssh>` and :doc:`paramiko <connection/paramiko>` it defaults to 22.
|
||||
:ref:`ansible_user`
|
||||
:ref:`ansible_user<ansible_user>`
|
||||
The default user name to use for log in. Most plugins default to the 'current user running Ansible'.
|
||||
|
||||
Each plugin might also have a specific version of a variable that overrides the general version. For example, :ref:`ansible_ssh_host` for the :doc:`ssh <connection/ssh>` plugin.
|
||||
Each plugin might also have a specific version of a variable that overrides the general version. For example, :ref:`ansible_ssh_host<ansible_ssh_host>` for the :doc:`ssh <connection/ssh>` plugin.
|
||||
|
||||
.. _connection_plugin_list:
|
||||
|
||||
|
|
@ -67,15 +66,15 @@ Use ``ansible-doc -t connection <plugin name>`` to see detailed documentation an
|
|||
|
||||
.. seealso::
|
||||
|
||||
:doc:`../playbooks`
|
||||
:ref:`Working with Playbooks<working_with_playbooks>`
|
||||
An introduction to playbooks
|
||||
:doc:`callback`
|
||||
Ansible callback plugins
|
||||
:doc:`../playbooks_filters`
|
||||
:ref:`Filters<playbooks_filters>`
|
||||
Jinja2 filter plugins
|
||||
:doc:`../playbooks_tests`
|
||||
:ref:`Tests<playbooks_tests>`
|
||||
Jinja2 test plugins
|
||||
:doc:`../playbooks_lookups`
|
||||
:ref:`Lookups<playbooks_lookups>`
|
||||
Jinja2 lookup plugins
|
||||
:doc:`vars`
|
||||
Ansible vars plugins
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Enabling Inventory Plugins
|
|||
++++++++++++++++++++++++++
|
||||
|
||||
Most inventory plugins shipped with Ansible are disabled by default and need to be whitelisted in your
|
||||
:doc:`ansible.cfg <../config>` file in order to function. This is how the default whitelist looks in the
|
||||
:ref:`ansible.cfg <ansible_configuration_settings>` file in order to function. This is how the default whitelist looks in the
|
||||
config file that ships with Ansible:
|
||||
|
||||
.. code-block:: ini
|
||||
|
|
@ -54,17 +54,17 @@ Use ``ansible-doc -t inventory <plugin name>`` to see plugin-specific documentat
|
|||
|
||||
.. seealso::
|
||||
|
||||
:doc:`../playbooks`
|
||||
:ref:`about_playbooks`
|
||||
An introduction to playbooks
|
||||
:doc:`callback`
|
||||
Ansible callback plugins
|
||||
:doc:`connection`
|
||||
Ansible connection plugins
|
||||
:doc:`../playbooks_filters`
|
||||
:ref:`playbooks_filters`
|
||||
Jinja2 filter plugins
|
||||
:doc:`../playbooks_tests`
|
||||
:ref:`playbooks_tests`
|
||||
Jinja2 test plugins
|
||||
:doc:`../playbooks_lookups`
|
||||
:ref:`playbooks_lookups`
|
||||
Jinja2 lookup plugins
|
||||
:doc:`vars`
|
||||
Ansible vars plugins
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Lookups are an Ansible-specific extension to the Jinja2 templating language.
|
|||
Enabling Lookup Plugins
|
||||
+++++++++++++++++++++++
|
||||
|
||||
You can activate a custom lookup by either dropping it into a ``lookup_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the lookup directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
You can activate a custom lookup by either dropping it into a ``lookup_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the lookup directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
|
||||
.. _using_lookup:
|
||||
|
|
@ -36,7 +36,7 @@ You can activate a custom lookup by either dropping it into a ``lookup_plugins``
|
|||
Using Lookup Plugins
|
||||
++++++++++++++++++++
|
||||
|
||||
Lookup plugins can be used anywhere you can use templating in Ansible: in a play, in variables file, or in a Jinja2 template for the :doc:`template <../template_module>` module.
|
||||
Lookup plugins can be used anywhere you can use templating in Ansible: in a play, in variables file, or in a Jinja2 template for the :ref:`template <template_module>` module.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ This is also the reason most lookups output lists and take lists as input; for e
|
|||
debug: msg={{item}}
|
||||
with_items: [1, 2, 3]
|
||||
|
||||
You can combine lookups with :doc:`../playbooks_filters`, :doc:`../playbooks_tests` and even each other to do some complex data generation and maniplulation. For example:
|
||||
You can combine lookups with :ref:`playbooks_filters`, :ref:`playbooks_tests` and even each other to do some complex data generation and manipulation. For example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -81,17 +81,17 @@ You can use ``ansible-doc -t lookup -l`` to see the list of available plugins. U
|
|||
|
||||
.. seealso::
|
||||
|
||||
:doc:`../playbooks`
|
||||
:ref:`about_playbooks`
|
||||
An introduction to playbooks
|
||||
:doc:`inventory`
|
||||
Ansible inventory plugins
|
||||
:doc:`callback`
|
||||
Ansible callback plugins
|
||||
:doc:`../playbooks_filters`
|
||||
:ref:`playbooks_filters`
|
||||
Jinja2 filter plugins
|
||||
:doc:`../playbooks_tests`
|
||||
:ref:`playbooks_tests`
|
||||
Jinja2 test plugins
|
||||
:doc:`../playbooks_lookups`
|
||||
:ref:`playbooks_lookups`
|
||||
Jinja2 lookup plugins
|
||||
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
||||
Have a question? Stop by the google group!
|
||||
|
|
|
|||
|
|
@ -28,11 +28,11 @@ This section covers the various types of plugins that are included with Ansible:
|
|||
|
||||
.. seealso::
|
||||
|
||||
:doc:`playbooks`
|
||||
:ref:`about_playbooks`
|
||||
An introduction to playbooks
|
||||
:doc:`config`
|
||||
:ref:`ansible_configuration_settings`
|
||||
Ansible configuration documentation and settings
|
||||
:doc:`command_line_tools`
|
||||
:doc:`../user_guide/command_line_tools`
|
||||
Ansible tools, description and options
|
||||
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
||||
Have a question? Stop by the google group!
|
||||
|
|
|
|||
|
|
@ -12,22 +12,22 @@ Enabling Shell Plugins
|
|||
++++++++++++++++++++++
|
||||
|
||||
You can add a custom shell plugin by dropping it into a ``shell_plugins`` directory adjacent to your play, inside a role,
|
||||
or by putting it in one of the shell plugin directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
or by putting it in one of the shell plugin directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
.. warning:: You should not alter which plugin is used unless you have a setup in which the default ``/bin/sh``
|
||||
is not a POSIX compatible shell or is not availble for execution.
|
||||
is not a POSIX compatible shell or is not available for execution.
|
||||
|
||||
.. _using_shell:
|
||||
|
||||
Using Shell Plugins
|
||||
+++++++++++++++++++
|
||||
|
||||
In addition to the default configuration settings in :doc:`../config`, you can use
|
||||
In addition to the default configuration settings in :ref:`ansible_configuration_settings`, you can use
|
||||
a 'connection variable' :ref:`ansible_shell_type` to select the plugin to use.
|
||||
In this case, you will also want to update the :ref:`ansible_executable` to match.
|
||||
|
||||
You can further control the settings for each plugin via other configuration options
|
||||
detailed in the plugin themsleves (linked below).
|
||||
detailed in the plugin themselves (linked below).
|
||||
|
||||
.. toctree:: :maxdepth: 1
|
||||
:glob:
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Enabling Strategy Plugins
|
|||
+++++++++++++++++++++++++
|
||||
|
||||
Strategy plugins shipped with Ansible are enabled by default. You can enable a custom strategy plugin by
|
||||
putting it in one of the lookup directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
putting it in one of the lookup directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
|
||||
.. _using_strategy:
|
||||
|
|
@ -21,7 +21,7 @@ Using Strategy Plugins
|
|||
++++++++++++++++++++++
|
||||
|
||||
Only one strategy plugin can be used in a play, but you can use different ones for each play in a playbook or ansible run.
|
||||
The default is the :doc:`linear <strategy/linear>` plugin. You can change this default in Ansible :doc:`configuration <../config>` using an environment variable:
|
||||
The default is the :doc:`linear <strategy/linear>` plugin. You can change this default in Ansible :ref:`configuration <ansible_configuration_settings>` using an environment variable:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
|
|
@ -64,17 +64,17 @@ Use ``ansible-doc -t strategy <plugin name>`` to see plugin-specific specific do
|
|||
|
||||
.. seealso::
|
||||
|
||||
:doc:`../playbooks`
|
||||
:ref:`about_playbooks`
|
||||
An introduction to playbooks
|
||||
:doc:`inventory`
|
||||
Ansible inventory plugins
|
||||
:doc:`callback`
|
||||
Ansible callback plugins
|
||||
:doc:`../playbooks_filters`
|
||||
:ref:`playbooks_filters`
|
||||
Jinja2 filter plugins
|
||||
:doc:`../playbooks_tests`
|
||||
:ref:`playbooks_tests`
|
||||
Jinja2 test plugins
|
||||
:doc:`../playbooks_lookups`
|
||||
:ref:`playbooks_lookups`
|
||||
Jinja2 lookup plugins
|
||||
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
||||
Have a question? Stop by the google group!
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ The :doc:`host_group_vars <vars/host_group_vars>` plugin shipped with Ansible en
|
|||
Enabling Vars Plugins
|
||||
+++++++++++++++++++++
|
||||
|
||||
You can activate a custom vars plugins by either dropping it into a ``vars_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :doc:`ansible.cfg <../config>`.
|
||||
You can activate a custom vars plugins by either dropping it into a ``vars_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
||||
|
||||
|
||||
.. _using_vars:
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Getting Started
|
|||
Foreword
|
||||
````````
|
||||
|
||||
Now that you've read :ref:`intro_installation` and installed Ansible, it's time to get
|
||||
Now that you've read the :ref:`installation guide<installation_guide>` and installed Ansible, it's time to get
|
||||
started with some ad-hoc commands.
|
||||
|
||||
What we are showing first are not the powerful configuration/deployment/orchestration features of Ansible.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
.. _playbooks_lookups:
|
||||
|
||||
Lookups
|
||||
-------
|
||||
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@ Please refer to :doc:`playbooks_reuse_roles` for details on including and import
|
|||
Loops in playbooks
|
||||
:ref:`all_modules`
|
||||
Learn about available modules
|
||||
:red:`developing_modules`
|
||||
:ref:`developing_modules`
|
||||
Learn how to extend Ansible by writing your own modules
|
||||
`GitHub Ansible examples <https://github.com/ansible/ansible-examples>`_
|
||||
Complete playbook files from the GitHub project source
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.. _playbook_tests:
|
||||
.. _playbooks_tests:
|
||||
|
||||
Tests
|
||||
-----
|
||||
|
|
|
|||
Loading…
Reference in a new issue