Be much more explicit about variable precedence as it applies to roles #73939
Conversation
ansibot
added
affects_2.11
core_review
mattclay
removed
the
needs_triage
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
ansibot
added
the
docs_only
|
Related PR: #72808 |
ansibot
added
the
stale_ci
ansibot
added
needs_ci
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
ansibot
added
core_review
| #. play ``vars`` | ||
| #. play ``vars_prompt`` | ||
| #. play ``vars_files`` | ||
| #. role vars from all roles (defined in ``roles/*/vars/main.yml`` or ``vars:``) |
There was a problem hiding this comment.
Should vars have a colon here, but not for similar cases in lines above (play vars, play vars_prompt, play vars_files)?
There was a problem hiding this comment.
I think the colon is useful to visually cue the reader that it should be defined in an ansible/playbook/task/whatever file rather than in a standalone vars file.
However, as a reader of the docs, I would not know where this vars: would be defined. Where would you put vars: inside a role? On a task? Does vars: on a task count as a roles var here? Does this mean if I have a list of roles defined in a playbook, and set a variable for one role, the other roles get that variable too?
| #. inventory file relative ``group_vars/all`` [3]_ | ||
| #. playbook file relative ``group_vars/all`` [3]_ | ||
| #. inventory file relative ``group_vars/*`` [3]_ | ||
| #. playbook file relative ``group_vars/*`` [3]_ |
There was a problem hiding this comment.
Might read better reversed like:
#. ``group_vars/all`` relative to inventory file [3]_
#. ``group_vars/all`` relative to playbook file [3]_
#. ``group_vars/*`` relative to inventory file [3]_
#. ``group_vars/*`` relative to playbook file [3]_| #. inventory file relative ``host_vars/*`` [3]_ | ||
| #. playbook file relative ``host_vars/*`` [3]_ |
There was a problem hiding this comment.
Might read better reversed like:
#. ``host_vars/*`` relative to inventory file [3]_
#. ``host_vars/*`` relative to playbook file [3]_| #. play ``vars`` | ||
| #. play ``vars_prompt`` | ||
| #. play ``vars_files`` | ||
| #. role vars from all roles (defined in ``roles/*/vars/main.yml`` or ``vars:``) |
There was a problem hiding this comment.
I think the colon is useful to visually cue the reader that it should be defined in an ansible/playbook/task/whatever file rather than in a standalone vars file.
However, as a reader of the docs, I would not know where this vars: would be defined. Where would you put vars: inside a role? On a task? Does vars: on a task count as a roles var here? Does this mean if I have a list of roles defined in a playbook, and set a variable for one role, the other roles get that variable too?
| #. role vars from all roles (defined in ``roles/*/vars/main.yml`` or ``vars:``) | ||
| #. role dependency vars for tasks from a role (defined in ``roles/{dependent_roles}/vars/main.yml``) | ||
| #. role vars for tasks from a role (defined in ``role/vars/main.yml``) [5]_ [8]_ [9]_ | ||
| #. block ``vars`` (only for tasks in block) |
There was a problem hiding this comment.
missing a between "in" and "block".
ansibot
added
the
stale_ci
ansibot
added
WIP
|
Thanks for your Ansible docs contribution! We talk about Ansible documentation on maxtrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda. |
ansibot
added
the
needs_rebase
ansibot
added
needs_ci
ansibot
added
needs_rebase
ansibot
added
the
stale_pr
sivel
added
the
unimportant_ci
SUMMARY
Be much more explicit about variable precedence as it applies to roles
Also fixes #43543
ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION