From 949487b671426e8bb16bfeb3668a6038bc002e4f Mon Sep 17 00:00:00 2001 From: Mark Bolwell Date: Mon, 20 Nov 2023 13:57:19 +0000 Subject: [PATCH 1/3] Audit Only in remediate added Signed-off-by: Mark Bolwell --- docs/source/audit/getting-started-audit.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/source/audit/getting-started-audit.rst b/docs/source/audit/getting-started-audit.rst index 52fb7bf..bfb72a8 100644 --- a/docs/source/audit/getting-started-audit.rst +++ b/docs/source/audit/getting-started-audit.rst @@ -77,6 +77,26 @@ The following requirements are needed (OS dependant) The binary only needs to be accessible to the host with ability to use. The relevant script needs to be adjust to point to the path of the binary. +Running the Audit Only as part of remediate playbook +---------------------------------------------------- + +It is possible to just run the audit on some playbooks (being rolled out across them all). This is a variable set + +``` +audit_only: true +``` + +This will run the audit based on the same release as the playbook and will then stop. +Extra variables also enable the ability to copy back the audit output to the control node and create a directory structure. + +``` +# As part of audit_only +# This will enable files to be copied back to control node +fetch_audit_files: false +# Path to copy the files to will create dir structure +audit_capture_files_dir: /some/location to copy to on control node +``` + Defining the audit ------------------ From 3ff035f02101fe1715342ac3adfc63d4d77bffec Mon Sep 17 00:00:00 2001 From: Mark Bolwell Date: Mon, 20 Nov 2023 14:02:37 +0000 Subject: [PATCH 2/3] updated layout Signed-off-by: Mark Bolwell --- docs/source/audit/getting-started-audit.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/source/audit/getting-started-audit.rst b/docs/source/audit/getting-started-audit.rst index bfb72a8..a5071f4 100644 --- a/docs/source/audit/getting-started-audit.rst +++ b/docs/source/audit/getting-started-audit.rst @@ -82,20 +82,22 @@ Running the Audit Only as part of remediate playbook It is possible to just run the audit on some playbooks (being rolled out across them all). This is a variable set -``` +.. code-block:: yaml + audit_only: true -``` + This will run the audit based on the same release as the playbook and will then stop. Extra variables also enable the ability to copy back the audit output to the control node and create a directory structure. -``` +.. code-block:: yaml + # As part of audit_only # This will enable files to be copied back to control node fetch_audit_files: false # Path to copy the files to will create dir structure audit_capture_files_dir: /some/location to copy to on control node -``` + Defining the audit ------------------ From 39acc340126d3b49c567c29c93f1cbab3b5cbc11 Mon Sep 17 00:00:00 2001 From: Mark Bolwell Date: Mon, 20 Nov 2023 14:10:32 +0000 Subject: [PATCH 3/3] updated layout Signed-off-by: Mark Bolwell --- docs/source/audit/getting-started-audit.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/audit/getting-started-audit.rst b/docs/source/audit/getting-started-audit.rst index a5071f4..da4a7d5 100644 --- a/docs/source/audit/getting-started-audit.rst +++ b/docs/source/audit/getting-started-audit.rst @@ -84,7 +84,7 @@ It is possible to just run the audit on some playbooks (being rolled out across .. code-block:: yaml -audit_only: true + audit_only: true This will run the audit based on the same release as the playbook and will then stop. @@ -92,11 +92,11 @@ Extra variables also enable the ability to copy back the audit output to the con .. code-block:: yaml -# As part of audit_only -# This will enable files to be copied back to control node -fetch_audit_files: false -# Path to copy the files to will create dir structure -audit_capture_files_dir: /some/location to copy to on control node + # As part of audit_only + # This will enable files to be copied back to control node + fetch_audit_files: false + # Path to copy the files to will create dir structure + audit_capture_files_dir: /some/location to copy to on control node Defining the audit