Merge branch '296-user-manual-add-documentation-on-the-new-automatic-groups-task' into 'dev'

Resolve "[User-Manual] - Add documentation on the new automatic-groups task"

See merge request fusiondirectory/user-manual!520

source/fusiondirectory-orchestrator/endpoints/automatic-groups.rst

+Automatic Groups Task Execution
+===============================
+
+.. _automatic-groups-task-execution-label:
+
+Once the automatic groups task is configured in FusionDirectory, execute it using the **fusiondirectory-orchestrator-client** tool:
+
+.. code-block:: bash
+
+   fusiondirectory-orchestrator-client --automatic-groups
+
+.. note::
+   **Recommendation**: Automate this process within a CRON job to ensure group memberships are regularly updated.
+
+.. note::
+   Add the ``--verbose`` flag to the command for detailed output during execution.
+
+How It Works
+------------
+
+When the automatic groups task executes:
+
+1. The system identifies all users specified in the task configuration (either directly or through group membership)
+2. For each user, it checks their Supann resource state against the criteria defined in the task
+3. Users who match the criteria are added to the target group
+4. Users who no longer match the criteria are removed from the target group
+
+This ensures that group memberships remain synchronized with the current state of users in your directory.
+
+Examples
+--------
+
+Basic Execution
+^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+   fusiondirectory-orchestrator-client --automatic-groups
+
+With Verbose Output
+^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+   fusiondirectory-orchestrator-client --automatic-groups --verbose
\ No newline at end of file

source/fusiondirectory-orchestrator/endpoints/index.rst

@@ -11,4 +11,5 @@ Endpoints
    audit.rst
    mails.rst
    archive.rst
-   extractor.rst
\ No newline at end of file
+   extractor.rst
+   automatic-groups.rst
\ No newline at end of file

source/fusiondirectory/plugins/automatic-groups/automaticGroups.rst

+Automatic Groups task
+=====================
+
+The **Automatic Groups** task dynamically manages group memberships based on specific criteria.
+It monitors users' Supann resource states and automatically adds or removes them from designated groups.
+
+.. note::
+   It must be used with FusionDirectory Orchestrator.
+
+Task Setup
+----------
+
+Creating the Task
+-----------------
+
+   - Open the **Tasks** section of FusionDirectory
+   - Define the task's schedule and repetition interval.
+
+   .. image:: images/automaticGroups-p1.png
+      :alt: Automatic Groups - Task creation step 1
+      :width: 600px
+
+Configuring Automatic Groups Task
+---------------------------------
+
+- **Navigate** to the **Tasks Automatic Groups** tab.
+- **Select** the target group where users will be added or removed.
+- **Choose** the resource, state, and (optionally) sub-state that users must have to be included in the group.
+- **Assign** the relevant members or groups whose membership will be managed.
+
+.. note::
+   You can select either individual users or groups for processing. When groups are selected, all members will be processed individually.
+
+
+.. image:: images/automaticGroups-p2.png
+  :alt: Automatic Groups - Task creation step 2
+  :width: 600px
+
+Task Execution
+--------------
+
+For your configured task to be executed, you need to configure your fusiondirectory-orchestrator-client
+
+Add the `--automatic-groups` parameter to your orchestrator client execution:
+
+.. code-block:: bash
+
+   fusiondirectory-orchestrator-client --automatic-groups
+
+This can be scheduled via cron for regular execution.
+
+Summary
+-------
+
+The **Automatic Groups Task**, when configured as described, will:
+
+- **Process** each user from the selected members list.
+- **Check** if they meet the specified Supann resource state criteria.
+- **Add** users to the target group if they match the criteria.
+- **Remove** users from the target group if they no longer match the criteria.
+
+.. note::
+   This ensures group memberships are always in sync with users' current states, automating what would otherwise be a manual administrative task.
+
+

source/fusiondirectory/plugins/automatic-groups/configuration.rst

+Configuration
+=============
+
+No configuration needed for this plugin.

source/fusiondirectory/plugins/automatic-groups/description.rst

+Description
+===========
+
+The Automatic Groups plugin provides functionality to dynamically manage group memberships based on specific criteria.
+
+This plugin allows administrators to create tasks that automatically add or remove users from groups based on their SupAnn resource states.
+When a user's state changes, the plugin ensures their group memberships are updated accordingly.
+
+Key features include:
+ 
+* Automatic assignment of users to groups based on SupAnn resource states
+* Automatic removal from groups when users no longer meet criteria
+* Batch processing of multiple users through task workflows
+* Integration with the FusionDirectory orchestrator for scheduled execution
\ No newline at end of file

source/fusiondirectory/plugins/automatic-groups/index.rst

+Life Cycle
+==========
+
+
+.. toctree::
+   :maxdepth: 2
+
+   description
+   installation
+   configuration
+   automaticGroups

source/fusiondirectory/plugins/automatic-groups/installation.rst

+Installation
+============
+
+Install packages
+----------------
+
+Debian
+^^^^^^
+
+.. code-block:: bash
+
+   apt-get install fusiondirectory-plugin-automatic-groups
+   apt-get install fusiondirectory-plugin-automatic-groups-schema
+
+Install schemas
+---------------
+
+Debian
+^^^^^^
+
+.. code-block:: bash
+
+   fusiondirectory-schema-manager --insert-schema /etc/ldap/schema/fusiondirectory/automatic-groups-fd.schema
+
+Register the plugin
+-------------------
+
+.. code-block:: bash
+ 
+   fusiondirectory-plugins-manager --register-plugin /etc/fusiondirectory/yaml/automatic-groups/description.yaml

source/fusiondirectory/plugins/index.rst

@@ -13,6 +13,7 @@ FusionDirectory Plugins
    audit/index
    autofs5/index
    autofs/index
+   automatic-groups/index
    certificates/index
    community/index
    cyrus/index