Skip to content
This repository was archived by the owner on Jun 30, 2026. It is now read-only.

docs: add multi-tenancy administration guide - #299

Merged
Romuald Lemesle (RomuDeuxfois) merged 5 commits into
mainfrom
docs/multi-tenancy
Jun 3, 2026
Merged

Romuald Lemesle (RomuDeuxfois) merged 5 commits into
mainfrom
docs/multi-tenancy

Conversation

@RomuDeuxfois

Copy link
Copy Markdown
Member

Summary

Adds a user-facing administration guide for the multi-tenancy feature.

This page lives in docs/administration/multi-tenancy.md and is registered in the mkdocs.yml nav under Administration → Multi-tenancy.

What's covered

Section Content
Concepts Tenant definition, platform vs. tenant scope, dual-scope resources
Managing tenants Create / update / delete (soft-delete 30d) / reactivate — step by step
Users & access Assigning users via groups, roles per tenant, platform admins
SSO & tenant mapping openaev.provider.{id}.tenant_id + groups_management parameters with env var equivalents
Integrations Built-in auto-registration, per-tenant RabbitMQ queues + S3 prefix, connector instances
Configuration reference All multi-tenancy parameters with env var names and defaults
FAQ 5 common questions (multi-tenant membership, platform resources, deletion, DB isolation, migration)

Sources

All content is sourced from the codebase:

  • TenantService.java — lifecycle (create / soft-delete 30d / reactivate / purge)
  • TenantInterceptor.java + HibernateFilterTransactionAspect.java — request isolation
  • TenantQueueService.java + MinioService.java — per-tenant infra isolation
  • BuiltinIntegrationFactory.java + BuiltinTenantRegistrable.java — auto-registration
  • application.properties — SSO tenant_id + groups_management params
  • TenantApi.java — EE gate (@AccessControl(isEnterpriseEdition = true))

Checklist

  • Matches the style of existing admin pages (enterprise.md, users-and-rbac.md)
  • Uses MkDocs Material admonitions (tip, warning, danger, info)
  • All parameters documented with their environment variable equivalent
  • EE requirement clearly called out at the top
  • Screenshots to add (Settings → Tenants UI) — left for follow-up

@damgouj damgouj (damgouj) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add the OpenCTI connector part (or I can do it) ? And could you show me how to create an issue for platform to update all the OpenAEV instance conf files ? Thanks :) !

@RomuDeuxfois

Copy link
Copy Markdown
Member Author

damgouj (@damgouj) & soumaya boussaha (@soumboussaha) I made the updates

@RomuDeuxfois
Romuald Lemesle (RomuDeuxfois) merged commit 35ed0a8 into main Jun 3, 2026
1 check passed
@RomuDeuxfois
Romuald Lemesle (RomuDeuxfois) deleted the docs/multi-tenancy branch June 3, 2026 12:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Add multi-tenancy documentation

3 participants