ansible: allow running playbook in check mode #2682
Merged
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
In some places we use the Ansible `raw` task to execute a command on the remote machine. Typically this is done to check for the presence of a file. Ansible itself has no way of knowing if the command we are executing makes modifications to the system so does not run `raw` tasks when `ansible-playbook` is run with `--check`. Some of our subsequent tasks rely on the `raw` task having previous run (to create a variable) so the playbook currently errors with messages such as: `'dict object' has no attribute ...` when run in `--check` mode. Mark `raw` tasks that do not make modifications with `check_mode: no` (which means "don't check if `--check` was set and just execute the command"). This allows us to run the playbook with `--check` first to see what Ansible thinks would change without actually making the changes.
AshCripps
approved these changes
Jun 22, 2021
rvagg
approved these changes
Jun 23, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In some places we use the Ansible
rawtask to execute a command onthe remote machine. Typically this is done to check for the presence
of a file. Ansible itself has no way of knowing if the command we are
executing makes modifications to the system so does not run
rawtaskswhen
ansible-playbookis run with--check. Some of our subsequenttasks rely on the
rawtask having previous run (to create a variable)so the playbook currently errors with messages such as:
'dict object' has no attribute ...when run in
--checkmode.Mark
rawtasks that do not make modifications withcheck_mode: no(which means "don't check if
--checkwas set and just execute thecommand"). This allows us to run the playbook with
--checkfirst tosee what Ansible thinks would change without actually making the
changes.