Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note for --start-at-task #1706

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Add a note for --start-at-task #1706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/docsite/rst/playbook_guide/playbooks_startnstep.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ To start executing your playbook at a particular task (usually the task that fai

In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`.
In this example, Ansible starts executing your playbook at a task named "install packages".


.. note::

Moreover, ``--start-at-task``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Moreover, ``--start-at-task``
The ``--start-at-task`` feature does not work with reused tasks in all cases. This depends on if the reuse is dynamic or static.
- If dynamically reused with an ``include_*`` statement, ``--start-at-task`` can target the task itself but not tasks inside the included role or task.
- If statically reused with an ``import_*`` statement, ``--start-at-task`` can target tasks inside the imported role or task but not the task itself.
For more information about are inside roles or tasks (), see :ref:`dynamic_vs_static`.

- can target tasks **within** static includes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

within imports (which are static) .. dont say 'static includes' as that would be a contradiction in our terminology, in which all includes are dynamic

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same with below, just establish import == static/preprocessed, include ==dynamic/executed at runtime

- cannot target tasks **within** dynamic includes
- can target the dynamic include task itself
- cannot target the static include task itself

.. _step:

Step mode
Expand Down