Verified Commit 3c49ce01 authored by dockx thibault's avatar dockx thibault
Browse files

:rocket: feat(automatic-groups) add documentation and images for Automatic Groups plugin

parent 868f26ec
No related merge requests found
Showing with 124 additions and 0 deletions
+124 -0
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.
Configuration
=============
No configuration needed for this plugin.
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/images/automaticGroups-p1.png

48.9 KB

source/fusiondirectory/plugins/automatic-groups/images/automaticGroups-p2.png

73.7 KB

Life Cycle
==========
.. toctree::
:maxdepth: 2
description
installation
configuration
automaticGroups
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
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment