46b1a999c6
* Build documentation for Ansible-2.10 (formerly known as ACD).
Builds plugin docs from collections whose source is on galaxy
The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.
* Update the python syntax checks
* docs builds can now require python 3.6+.
* Move plugin formatter code out to an external tool, antsibull-docs.
Collection owners want to be able to extract docs for their own
websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs
* Cleanup and bugfix to other build script code:
* The Commands class needed to have its metaclass set for abstractmethod
to work correctly
* Fix lint issues in some command plugins
* Add the docs/docsite/rst/collections to .gitignore as
everything in that directory will be generated so we don't want any of
it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages
* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs
* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined
* Remove references to plugin documentation locations that no longer exist.
* Perhaps the pages in plugins/*.rst should be deprecated
altogether and their content moved?
* If not, perhaps we want to rephrase and link into the collection
documentation?
* Or perhaps we want to link to the plugins which are present in
collections/ansible/builtin?
* Remove PYTHONPATH from the build-ansible calls
One of the design goals of the build-ansible.py script was for it to
automatically set its library path to include the checkout of ansible
and the library of code to implement itself. Because it automatically
includes the checkout of ansible, we don't need to set PYTHONPATH in
the Makefile any longer.
* Create a command to only build ansible-base plugin docs
* When building docs for devel, only build the ansible-base docs for
now. This is because antsibull needs support for building a "devel
tree" of docs. This can be changed once that is implemented
* When building docs for the sanity tests, only build the ansible-base
plugin docs for now. Those are the docs which are in this repo so
that seems appropriate for now.
* Docs: User guide overhaul, part 5 (#70307)
(cherry picked from commit db354c0300)
* Need to return any error code from running antsibull-docs (#70763)
This way we fail early if there's a problem
(cherry picked from commit 1e3989c9f7)
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
79 lines
2.1 KiB
ReStructuredText
79 lines
2.1 KiB
ReStructuredText
.. _strategy_plugins:
|
|
|
|
Strategy Plugins
|
|
================
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Strategy plugins control the flow of play execution by handling task and host scheduling.
|
|
|
|
.. _enable_strategy:
|
|
|
|
Enabling strategy plugins
|
|
-------------------------
|
|
|
|
All 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 :ref:`ansible.cfg <ansible_configuration_settings>`.
|
|
|
|
.. _using_strategy:
|
|
|
|
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 :ref:`linear <linear_strategy>` plugin. You can change this default in Ansible :ref:`configuration <ansible_configuration_settings>` using an environment variable:
|
|
|
|
.. code-block:: shell
|
|
|
|
export ANSIBLE_STRATEGY=free
|
|
|
|
or in the `ansible.cfg` file:
|
|
|
|
.. code-block:: ini
|
|
|
|
[defaults]
|
|
strategy=linear
|
|
|
|
You can also specify the strategy plugin in the play via the :ref:`strategy keyword <playbook_keywords>` in a play::
|
|
|
|
- hosts: all
|
|
strategy: debug
|
|
tasks:
|
|
- copy: src=myhosts dest=/etc/hosts
|
|
notify: restart_tomcat
|
|
|
|
- package: name=tomcat state=present
|
|
|
|
handlers:
|
|
- name: restart_tomcat
|
|
service: name=tomcat state=restarted
|
|
|
|
.. _strategy_plugin_list:
|
|
|
|
Plugin list
|
|
-----------
|
|
|
|
You can use ``ansible-doc -t strategy -l`` to see the list of available plugins.
|
|
Use ``ansible-doc -t strategy <plugin name>`` to see plugin-specific specific documentation and examples.
|
|
|
|
|
|
.. seealso::
|
|
|
|
:ref:`about_playbooks`
|
|
An introduction to playbooks
|
|
:ref:`inventory_plugins`
|
|
Ansible inventory plugins
|
|
:ref:`callback_plugins`
|
|
Ansible callback plugins
|
|
:ref:`playbooks_filters`
|
|
Jinja2 filter plugins
|
|
:ref:`playbooks_tests`
|
|
Jinja2 test plugins
|
|
:ref:`playbooks_lookups`
|
|
Jinja2 lookup plugins
|
|
`User Mailing List <https://groups.google.com/group/ansible-devel>`_
|
|
Have a question? Stop by the google group!
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|