mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add documentation for squash_actions configuration setting
This commit is contained in:
parent
72e111ecca
commit
7b06ec79e3
3 changed files with 24 additions and 1 deletions
|
@ -628,6 +628,23 @@ Additional paths can be provided separated by colon characters, in the same way
|
||||||
Roles will be first searched for in the playbook directory. Should a role not be found, it will indicate all the possible paths
|
Roles will be first searched for in the playbook directory. Should a role not be found, it will indicate all the possible paths
|
||||||
that were searched.
|
that were searched.
|
||||||
|
|
||||||
|
.. _cfg_squash_actions:
|
||||||
|
|
||||||
|
squash_actions
|
||||||
|
==============
|
||||||
|
|
||||||
|
.. versionadded:: 2.0
|
||||||
|
|
||||||
|
Ansible can optimise actions that call modules that support list parameters when using with\_ looping.
|
||||||
|
Instead of calling the module once for each item, the module is called once with the full list.
|
||||||
|
|
||||||
|
The default value for this setting is only for certain package managers, but it can be used for any module::
|
||||||
|
|
||||||
|
squash_actions = apk,apt,dnf,package,pacman,pkgng,yum,zypper
|
||||||
|
|
||||||
|
Currently, this is only supported for modules that have a name parameter, and only when the item is the
|
||||||
|
only thing being passed to the parameter.
|
||||||
|
|
||||||
.. _cfg_strategy_plugins:
|
.. _cfg_strategy_plugins:
|
||||||
|
|
||||||
strategy_plugins
|
strategy_plugins
|
||||||
|
|
|
@ -199,6 +199,12 @@
|
||||||
#retry_files_enabled = False
|
#retry_files_enabled = False
|
||||||
#retry_files_save_path = ~/.ansible-retry
|
#retry_files_save_path = ~/.ansible-retry
|
||||||
|
|
||||||
|
# squash actions
|
||||||
|
# Ansible can optimise actions that call modules with list parameters
|
||||||
|
# when looping. Instead of calling the module once per with_ item, the
|
||||||
|
# module is called once with all items at once. Currently this only works
|
||||||
|
# under limited circumstances, and only with parameters named 'name'.
|
||||||
|
#squash_actions = apk,apt,dnf,package,pacman,pkgng,yum,zypper
|
||||||
|
|
||||||
# prevents logging of task data, off by default
|
# prevents logging of task data, off by default
|
||||||
#no_log = False
|
#no_log = False
|
||||||
|
|
|
@ -203,7 +203,7 @@ DEFAULT_BECOME_ASK_PASS = get_config(p, 'privilege_escalation', 'become_ask_pa
|
||||||
# the module takes both, bad things could happen.
|
# the module takes both, bad things could happen.
|
||||||
# In the future we should probably generalize this even further
|
# In the future we should probably generalize this even further
|
||||||
# (mapping of param: squash field)
|
# (mapping of param: squash field)
|
||||||
DEFAULT_SQUASH_ACTIONS = get_config(p, DEFAULTS, 'squash_actions', 'ANSIBLE_SQUASH_ACTIONS', "apt, dnf, package, pkgng, yum, zypper", islist=True)
|
DEFAULT_SQUASH_ACTIONS = get_config(p, DEFAULTS, 'squash_actions', 'ANSIBLE_SQUASH_ACTIONS', "apk, apt, dnf, package, pacman, pkgng, yum, zypper", islist=True)
|
||||||
# paths
|
# paths
|
||||||
DEFAULT_ACTION_PLUGIN_PATH = get_config(p, DEFAULTS, 'action_plugins', 'ANSIBLE_ACTION_PLUGINS', '~/.ansible/plugins/action:/usr/share/ansible/plugins/action', ispath=True)
|
DEFAULT_ACTION_PLUGIN_PATH = get_config(p, DEFAULTS, 'action_plugins', 'ANSIBLE_ACTION_PLUGINS', '~/.ansible/plugins/action:/usr/share/ansible/plugins/action', ispath=True)
|
||||||
DEFAULT_CACHE_PLUGIN_PATH = get_config(p, DEFAULTS, 'cache_plugins', 'ANSIBLE_CACHE_PLUGINS', '~/.ansible/plugins/cache:/usr/share/ansible/plugins/cache', ispath=True)
|
DEFAULT_CACHE_PLUGIN_PATH = get_config(p, DEFAULTS, 'cache_plugins', 'ANSIBLE_CACHE_PLUGINS', '~/.ansible/plugins/cache:/usr/share/ansible/plugins/cache', ispath=True)
|
||||||
|
|
Loading…
Reference in a new issue