Skip to content

Fixes #38335 - Document Ansible Diff Mode template option #3758

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fixes #38335 - Document Ansible Diff Mode template option #3758

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b212e3a
Fixes #38335 - Document Ansible Diff Mode template option
bnerickson Mar 31, 2025
548f5ce
Updated per comments to remove passive voice and conform to a single …
bnerickson Aug 22, 2025
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
12 changes: 12 additions & 0 deletions guides/common/modules/proc_creating-a-job-template.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@
ifdef::satellite[]
For more information on Ansible check mode, see {RHDocsBaseURL}red_hat_ansible_automation_platform/latest/html-single/using_automation_execution/index[Using automation execution] in _Red{nbsp}Hat Ansible Automation Platform documentation_.
endif::[]
.. Select *Enable Ansible Diff Mode* to run jobs based on the template in Ansible diff mode.
This mode reports detailed changes that Ansible tasks make if the underlying Ansible module supports Ansible diff mode.
If a module does not support Ansible diff mode, the task only reports that a change occurred without providing details.
When used with Ansible check mode, Ansible playbook tasks report the changes they would make to the host, but no actual changes occur.
If a task deploys credentials and supports Ansible diff mode, the changes to the credentials may be reported in clear text.

Check failure on line 41 in guides/common/modules/proc_creating-a-job-template.adoc

View workflow job for this annotation

GitHub Actions / linter 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'plain text' rather than 'clear text'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'plain text' rather than 'clear text'.", "location": {"path": "guides/common/modules/proc_creating-a-job-template.adoc", "range": {"start": {"line": 41, "column": 113}}}, "severity": "ERROR"}
To prevent change reports for a task, add `diff: false` or `no_log: true` to the task.
ifndef::satellite[]
For more information on Ansible diff mode, see link:https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_checkmode.html[Validating tasks: check mode and diff mode] in _Ansible Documentation_.
endif::[]
ifdef::satellite[]
For more information on Ansible diff mode, see {RHDocsBaseURL}red_hat_ansible_automation_platform/latest/html-single/using_automation_execution/index[Using automation execution] in _Red{nbsp}Hat Ansible Automation Platform documentation_.
endif::[]
. Click the *Location* tab and add the locations where you want to use the template.
. Click the *Organizations* tab and add the organizations where you want to use the template.
. Click *Submit* to save your changes.
Expand Down
Loading