Skip to content

docs: add multi-tenancy administration guide#299

Draft
RomuDeuxfois wants to merge 4 commits into
mainfrom
docs/multi-tenancy
Draft

docs: add multi-tenancy administration guide#299
RomuDeuxfois wants to merge 4 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

@RomuDeuxfois RomuDeuxfois marked this pull request as ready for review May 27, 2026 13:08
@RomuDeuxfois RomuDeuxfois requested a review from soumboussaha May 27, 2026 13:08
@RomuDeuxfois RomuDeuxfois marked this pull request as draft May 27, 2026 13:08
@RomuDeuxfois RomuDeuxfois linked an issue May 27, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Add multi-tenancy documentation

1 participant