mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-27 10:40:22 -07:00
Corrections to documentation formatting
This commit is contained in:
parent
6373f2b045
commit
4f7a0925fd
5 changed files with 36 additions and 11 deletions
24
docsite/rst/developing_core.rst
Normal file
24
docsite/rst/developing_core.rst
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
Developing the Ansible Core Engine
|
||||||
|
==================================
|
||||||
|
|
||||||
|
Although many of the pieces of the Ansible Core Engine are plugins that can be
|
||||||
|
swapped out via playbook directives or configuration, there are still pieces
|
||||||
|
of the Engine that are not modular. The documents here give insight into how
|
||||||
|
those pieces work together.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
developing_program_flow_modules
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
:doc:`developing_api`
|
||||||
|
Learn about the Python API for task execution
|
||||||
|
:doc:`developing_plugins`
|
||||||
|
Learn about developing plugins
|
||||||
|
`Mailing List <http://groups.google.com/group/ansible-devel>`_
|
||||||
|
The development mailing list
|
||||||
|
`irc.freenode.net <http://irc.freenode.net>`_
|
||||||
|
#ansible-devel IRC chat channel
|
||||||
|
|
|
@ -48,8 +48,8 @@ the 'command' module could already be used to do this.
|
||||||
|
|
||||||
Reading the modules that come with Ansible (linked above) is a great way to learn how to write
|
Reading the modules that come with Ansible (linked above) is a great way to learn how to write
|
||||||
modules. Keep in mind, though, that some modules in Ansible's source tree are internalisms,
|
modules. Keep in mind, though, that some modules in Ansible's source tree are internalisms,
|
||||||
so look at :ref:`service` or :ref:`yum`, and don't stare too close into things like :ref:`async_wrapper` or
|
so look at :ref:`service` or :ref:`yum`, and don't stare too close into things like ``async_wrapper`` or
|
||||||
you'll turn to stone. Nobody ever executes :ref:`async_wrapper` directly.
|
you'll turn to stone. Nobody ever executes ``async_wrapper`` directly.
|
||||||
|
|
||||||
Ok, let's get going with an example. We'll use Python. For starters, save this as a file named :file:`timetest.py`::
|
Ok, let's get going with an example. We'll use Python. For starters, save this as a file named :file:`timetest.py`::
|
||||||
|
|
||||||
|
@ -538,11 +538,11 @@ When you look into the debug_dir you'll see a directory structure like this::
|
||||||
that are passed to the module, this is the file to do it in.
|
that are passed to the module, this is the file to do it in.
|
||||||
|
|
||||||
* The :file:`ansible` directory contains code from
|
* The :file:`ansible` directory contains code from
|
||||||
:module:`ansible.module_utils` that is used by the module. Ansible includes
|
:mod:`ansible.module_utils` that is used by the module. Ansible includes
|
||||||
files for any :`module:`ansible.module_utils` imports in the module but not
|
files for any :`module:`ansible.module_utils` imports in the module but not
|
||||||
no files from any other module. So if your module uses
|
no files from any other module. So if your module uses
|
||||||
:module:`ansible.module_utils.url` Ansible will include it for you, but if
|
:mod:`ansible.module_utils.url` Ansible will include it for you, but if
|
||||||
your module includes :module:`requests` then you'll have to make sure that
|
your module includes :mod:`requests` then you'll have to make sure that
|
||||||
the python requests library is installed on the system before running the
|
the python requests library is installed on the system before running the
|
||||||
module. You can modify files in this directory if you suspect that the
|
module. You can modify files in this directory if you suspect that the
|
||||||
module is having a problem in some of this boilerplate code rather than in
|
module is having a problem in some of this boilerplate code rather than in
|
||||||
|
@ -566,7 +566,7 @@ module file and test that the real module works via :command:`ansible` or
|
||||||
The wrapper provides one more subcommand, ``excommunicate``. This
|
The wrapper provides one more subcommand, ``excommunicate``. This
|
||||||
subcommand is very similar to ``execute`` in that it invokes the exploded
|
subcommand is very similar to ``execute`` in that it invokes the exploded
|
||||||
module on the arguments in the :file:`args`. The way it does this is
|
module on the arguments in the :file:`args`. The way it does this is
|
||||||
different, however. ``excommunicate`` imports the :function:`main`
|
different, however. ``excommunicate`` imports the :func:`main`
|
||||||
function from the module and then calls that. This makes excommunicate
|
function from the module and then calls that. This makes excommunicate
|
||||||
execute the module in the wrapper's process. This may be useful for
|
execute the module in the wrapper's process. This may be useful for
|
||||||
running the module under some graphical debuggers but it is very different
|
running the module under some graphical debuggers but it is very different
|
||||||
|
@ -575,7 +575,7 @@ module file and test that the real module works via :command:`ansible` or
|
||||||
with Ansible normally. Those are not bugs in the module; they're
|
with Ansible normally. Those are not bugs in the module; they're
|
||||||
limitations of ``excommunicate``. Use at your own risk.
|
limitations of ``excommunicate``. Use at your own risk.
|
||||||
|
|
||||||
.. _module_paths
|
.. _module_paths:
|
||||||
|
|
||||||
Module Paths
|
Module Paths
|
||||||
````````````
|
````````````
|
||||||
|
|
|
@ -79,7 +79,7 @@ New-style powershell modules use the :ref:`module_replacer` framework for
|
||||||
constructing modules. These modules get a library of powershell code embedded
|
constructing modules. These modules get a library of powershell code embedded
|
||||||
in them before being sent to the managed node.
|
in them before being sent to the managed node.
|
||||||
|
|
||||||
.. _flow_josnargs_modules:
|
.. _flow_jsonargs_modules:
|
||||||
|
|
||||||
JSONARGS
|
JSONARGS
|
||||||
^^^^^^^^
|
^^^^^^^^
|
||||||
|
@ -325,7 +325,7 @@ string and substituted into the combined module file. In :ref:`ziploader`,
|
||||||
the JSON-ified string is passed into the module via stdin. When
|
the JSON-ified string is passed into the module via stdin. When
|
||||||
a :class:`ansible.module_utils.basic.AnsibleModule` is instantiated,
|
a :class:`ansible.module_utils.basic.AnsibleModule` is instantiated,
|
||||||
it parses this string and places the args into
|
it parses this string and places the args into
|
||||||
:attribute:`AnsibleModule.params` where it can be accessed by the module's
|
:attr:`AnsibleModule.params` where it can be accessed by the module's
|
||||||
other code.
|
other code.
|
||||||
|
|
||||||
.. _flow_passing_module_constants:
|
.. _flow_passing_module_constants:
|
||||||
|
@ -357,7 +357,7 @@ For now, :code:`ANSIBLE_VERSION` is also available at its old location inside of
|
||||||
:ref:`ziploader` passes these as part of the JSON-ified argument string via stdin.
|
:ref:`ziploader` passes these as part of the JSON-ified argument string via stdin.
|
||||||
When
|
When
|
||||||
:class:`ansible.module_utils.basic.AnsibleModule` is instantiated, it parses this
|
:class:`ansible.module_utils.basic.AnsibleModule` is instantiated, it parses this
|
||||||
string and places the constants into :attribute:`AnsibleModule.constants`
|
string and places the constants into :attr:`AnsibleModule.constants`
|
||||||
where other code can access it.
|
where other code can access it.
|
||||||
|
|
||||||
Unlike the ``ANSIBLE_VERSION``, where some efforts were made to keep the old
|
Unlike the ``ANSIBLE_VERSION``, where some efforts were made to keep the old
|
||||||
|
|
|
@ -329,7 +329,7 @@ be applied to single tasks only, once a playbook is completed.
|
||||||
.. _interpolate_variables:
|
.. _interpolate_variables:
|
||||||
|
|
||||||
When should I use {{ }}? Also, how to interpolate variables or dynamic variable names
|
When should I use {{ }}? Also, how to interpolate variables or dynamic variable names
|
||||||
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
A steadfast rule is 'always use {{ }} except when `when:`'.
|
A steadfast rule is 'always use {{ }} except when `when:`'.
|
||||||
Conditionals are always run through Jinja2 as to resolve the expression,
|
Conditionals are always run through Jinja2 as to resolve the expression,
|
||||||
|
|
|
@ -332,6 +332,7 @@ A sample azure_rm.ini file is included along with the inventory script in contri
|
||||||
file will contain the following:
|
file will contain the following:
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
|
|
||||||
[azure]
|
[azure]
|
||||||
# Control which resource groups are included. By default all resources groups are included.
|
# Control which resource groups are included. By default all resources groups are included.
|
||||||
# Set resource_groups to a comma separated list of resource groups names.
|
# Set resource_groups to a comma separated list of resource groups names.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue