feat(audit) enhance audit task documentation with execution options...

 feat(audit) enhance audit task documentation with execution options and syslog transformation details

source/fusiondirectory-orchestrator/endpoints/audit.rst

-Audit task execution
+Audit Task Execution
 ====================
 
 .. _audit-task-execution-label:
 
 Once the task is configured, execute it using the **orchestrator-client** tool. You have two execution options:
 
-.. code-block:: bash
+1. **Standard Audit Deletion**:
+   - Removes audit logs older than the configured retention period.
+   - Example:
 
-   fusiondirectory-orchestrator-client --audit
+     .. code-block:: bash
+
+        fusiondirectory-orchestrator-client --audit
+
+2. **Syslog Transformation**:
+   - Transforms audit logs into syslog format and appends them to a daily syslog file.
+   - Example:
+
+     .. code-block:: bash
+
+        fusiondirectory-orchestrator-client --audit syslog
 
 .. note::
    **Recommendation** automate this process within a CRON job.
 
 .. note::
-  Add the ``--verbose`` flag to the command for detailed output during execution.
-
+   Add the ``--verbose`` flag to the command for detailed output during execution.
 
 .. note::
-    The logs are stored by default at the following location:
+   The syslogs are stored at the following location:
 
-    ``/var/log/orchestrator/orchestrator.log``
+   ``/var/log/fusiondirectory/``
 

source/fusiondirectory-tools/fusiondirectory-orchestrator-client.rst

@@ -68,9 +68,23 @@ Remove All Completed Sub-Tasks
 Execute a Task of Type "Audit"
 """"""""""""""""""""""""""""""
 
-.. code-block:: shell
+The `--audit` option allows you to execute tasks of type "Audit". This includes two modes of operation:
+
+1. **Standard Audit Deletion**:
+
+   - Removes audit logs older than the configured retention period.
+
+     .. code-block:: shell
+
+        fusiondirectory-orchestrator-client --audit
+
+2. **Syslog Transformation**:
+
+   - Transforms audit logs into syslog format and appends them to a daily syslog file.
+
+     .. code-block:: shell
 
-   fusiondirectory-orchestrator-client --audit
+        fusiondirectory-orchestrator-client --audit syslog
 
 Execute a Task of Type "Archive"
 """"""""""""""""""""""""""""""""

source/fusiondirectory/plugins/audit/auditTask.rst

@@ -2,9 +2,11 @@ Audit Task
 ==========
 
 The **Audit** task helps in managing the backlog of audit logs, freeing up disk space and improving performance by removing logs older than the configured retention period.
+It can also, instead of removing, transform all audits into syslog format to be grabbed by a syslog server.
+This task is particularly useful for systems with a large number of audit logs, as it automates the process of log management and ensures that only relevant logs are retained.
 
 .. NOTE::
-  It must be used with FusionDirectory Orchestrator
+  It must be used with FusionDirectory Orchestrator.
 
 Task Setup
 ----------
@@ -12,7 +14,7 @@ Task Setup
 Creating the Task
 -----------------
 
-   - Open the **Tasks** section in FusionDirectory
+   - Open the **Tasks** section in FusionDirectory.
    - Define the task’s schedule and repetition interval.
 
    .. image:: images/audit_t1.png
@@ -23,25 +25,37 @@ Configuring Audit Task
 ----------------------
 
 - Go to the Tasks Audit tab.
-- Configure the desired time retention settings in days, and then click **Save**.
+- Configure the desired time retention settings in days.
 
    .. image:: images/audit_t2.png
       :alt: Audit - Task creation step 2
       :width: 600px
 
+- OR enable **Syslog Transformation** by checking the corresponding box, and then click **Save**.
+
+   .. image:: images/audit_t3.png
+      :alt: Audit - Syslog Transformation option
+      :width: 600px
 
 Task Execution
 --------------
 
+For your configured task to execute, you need to configure your `fusiondirectory-orchestrator-client`.
 
-For your configured task to executed, you need to configure your fusiondirectory-orchestrator-client
-
-See :ref:`Audit Task Execution <audit-task-execution-label>`. for more information.
+See :ref:`Audit Task Execution <audit-task-execution-label>` for more information.
 
 Summary
 -------
 
 The **Audit Task**, when configured as described, will:
 
- - Automatically remove all audits that have exceeded the yearly retention period.
- - Ensure compliance and efficient data management on an annual basis.
\ No newline at end of file
+ - Automatically remove all audits that have exceeded the configured retention period (if Syslog Transformation is disabled).
+ - Transform audit logs into syslog format (if Syslog Transformation is enabled).
+ - Ensure compliance and efficient data management.
+
+Important Notes
+---------------
+
+- **Syslog Transformation** and **Audit Deletion** cannot be enabled simultaneously.
+- The syslog transformation feature appends audit logs to a daily syslog file located in `/var/log/fusiondirectory/`.
+- The retention period is ignored when Syslog Transformation is enabled.
\ No newline at end of file