summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Martz <matt@sivel.net>2021-09-24 12:35:44 -0500
committerGitHub <noreply@github.com>2021-09-24 10:35:44 -0700
commit5183a2e58523c95768071c70e15b8d5fb1a29818 (patch)
tree29a1326a3427ac7543bce5f3e013dd6da6d68ea1
parent65b5472ad1470bc52d7f75c806aa58ccd37baa06 (diff)
downloadansible-5183a2e58523c95768071c70e15b8d5fb1a29818.tar.gz
Add note about `loop_control.extended` memory impact (#75759)
* Add note about `loop_control.extended` memory impact * moar correct
-rw-r--r--docs/docsite/rst/user_guide/playbooks_loops.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/docsite/rst/user_guide/playbooks_loops.rst b/docs/docsite/rst/user_guide/playbooks_loops.rst
index 1c0f2a18f0..175b9cd3d4 100644
--- a/docs/docsite/rst/user_guide/playbooks_loops.rst
+++ b/docs/docsite/rst/user_guide/playbooks_loops.rst
@@ -410,6 +410,8 @@ Variable Description
loop_control:
extended: yes
+.. note:: When using ``loop_control.extended`` more memory will be utilized on the control node. This is a result of ``ansible_loop.allitems`` containing a reference to the full loop data for every loop. When serializing the results for display in callback plugins within the main ansible process, these references may be dereferenced causing memory usage to increase.
+
Accessing the name of your loop_var
-----------------------------------
.. versionadded:: 2.8