Emphasise variable_start_string/variable_end_string affects templated vars
#80997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Setting e.g. the 'variable_start_string' and 'variable_end_string' parameters of the 'ansible.builtin.template' module will affect evaluation of any templated variables defined in the same step. Add an example demonstrating this along with notes for each of '*_start_string' and '*_end_string' parameters. Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Closes: ansible#80996
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
ansibot
added
affects_2.16
docs
bcoca
reviewed
Jun 8, 2023
| @@ -48,35 +48,43 @@ class ModuleDocFragment(object): | |||
| block_start_string: | |||
| description: | |||
| - The string marking the beginning of a block. | |||
| - This will affect evaluation of templated variables in the same step. | |||
There was a problem hiding this comment.
i would just add this once, to the notes: section
bcoca
reviewed
Jun 8, 2023
| variable_start_string: "<<" | ||
| variable_end_string: ">>" | ||
| vars: | ||
| vip_address: "<< hostvars['controller-00']['ansible_host'] >>" |
There was a problem hiding this comment.
this is NOT limited to vars defined in task, but to ANY vars used in the template, no matter where they are defined.
jborean93
removed
the
needs_triage
|
I think we may be starting to question this behavior. I might recommend holding off on merging this PR until we can decide whether we want to change the behavior to align with the |
|
I'm going to close this as resolved by #81005 That PR changes the behavior so that this arguments only affect the template itself and not dependent variables. |
|
Awesome. Thank you! 🙏 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Fixes #80996
ISSUE TYPE
COMPONENT NAME
lib/ansible/modules/template.pyADDITIONAL INFORMATION
None.