From b212e3aa6e31201056ab7c7d833ba776f9792d1f Mon Sep 17 00:00:00 2001 From: Ben Erickson Date: Mon, 31 Mar 2025 13:48:55 -0700 Subject: [PATCH 1/2] Fixes #38335 - Document Ansible Diff Mode template option --- guides/common/modules/proc_creating-a-job-template.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/guides/common/modules/proc_creating-a-job-template.adoc b/guides/common/modules/proc_creating-a-job-template.adoc index 176b928a85d..6384a1bd88f 100644 --- a/guides/common/modules/proc_creating-a-job-template.adoc +++ b/guides/common/modules/proc_creating-a-job-template.adoc @@ -34,6 +34,13 @@ endif::[] 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, which reports detailed changes Ansible tasks make _if_ the underlying Ansible modules supports Ansible diff mode. If a module does not support Ansible diff mode, then the task will only report that a change occurred and nothing else. When used in conjunction with Ansible check mode, the Ansible playbook tasks report changes they _would_ have made to the host, and no changes are made to the host. Please note that if a task is used to deploy credentials and the task supports Ansible diff mode, then changes to the credentials _may_ be reported in clear text. This can be mitigated by adding `diff: false` or `no_log: true` to the task in question which will prevent change reports for that 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. From 548f5ce3febd6c043c49c5ba588e3ccfc866252b Mon Sep 17 00:00:00 2001 From: Ben Erickson Date: Thu, 21 Aug 2025 21:16:27 -0700 Subject: [PATCH 2/2] Updated per comments to remove passive voice and conform to a single line per-sentence --- guides/common/modules/proc_creating-a-job-template.adoc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/guides/common/modules/proc_creating-a-job-template.adoc b/guides/common/modules/proc_creating-a-job-template.adoc index 6384a1bd88f..95a66d797a4 100644 --- a/guides/common/modules/proc_creating-a-job-template.adoc +++ b/guides/common/modules/proc_creating-a-job-template.adoc @@ -34,7 +34,12 @@ endif::[] 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, which reports detailed changes Ansible tasks make _if_ the underlying Ansible modules supports Ansible diff mode. If a module does not support Ansible diff mode, then the task will only report that a change occurred and nothing else. When used in conjunction with Ansible check mode, the Ansible playbook tasks report changes they _would_ have made to the host, and no changes are made to the host. Please note that if a task is used to deploy credentials and the task supports Ansible diff mode, then changes to the credentials _may_ be reported in clear text. This can be mitigated by adding `diff: false` or `no_log: true` to the task in question which will prevent change reports for that task. +.. 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. +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::[]