Ana içeriğe geç

Tenarium documentation

Tenarium is an open-source tenant control plane for multi-tenant SaaS applications. It owns the tenant lifecycle (create, provision, suspend, delete), plans and entitlements, users, members and usage quotas, records every change in a durable event log, and lets plugins take part in all of it. The README has the quick start.

┌───────────── Tenarium ─────────────────────────────────────────┐
REST API ─▶│ authn ─▶ authz ─▶ hooks ─▶ [ tx: state + event (outbox) ] │
Admin UI │ │ │
│ dispatcher (cursor, retry, DLQ, leases) │
└──────────┬───────────────┬───────────────┬─────────────────────┘
▼ ▼ ▼
provisioning Kafka / your plugins
(schema, realm, …) webhooks (Go · HTTP · WASM)

Using Tenarium​

PageCovers
Configurationevery configuration key and its default
REST APIresources, errors, concurrency, idempotency, pagination
Tenant lifecycletemplates, cloning, scheduled actions, maintenance windows, soft deletion, custom domains, branding, API keys, health scores, usage periods, SCIM, audit
Plans and placemententitlements, plan revisions, add-ons, feature rollouts, regions
Usersdirectories, sign-in, sign-in links, email change, sessions, roles, two-factor authentication, passkeys, impersonation
Authentication and authorizationauthenticators, actions, tenant roles and groups, OIDC and SAML SSO, social login, signing keys
OpenID providerTenarium as the sign-in service of your applications
Tenant webhooksself-service webhooks with Standard Webhooks signatures
Event schema registryJSON Schemas of every event type and their versioning
Data protectionexports, user erasure, purging deleted tenants

Integrating your application​

PageCovers
Go client and tenariumctlthe API client and the CLI
Tenant middlewareresolving and checking tenants in Go, TypeScript and Python services
Gateway integrationtenant resolution at the API gateway
PostgreSQL row-level securityisolating tenants in a shared database

Plugins​

Plugins lists every built-in plugin and the extension points. Writing Go plugins, external plugins and WebAssembly plugins show how to write your own.

Running Tenarium​

PageCovers
Operationsdeployment, PostgreSQL, scaling, health, metrics, tracing, security checklist
TLS and managed certificatesHTTPS with a static certificate or ACME
Secrets at restKMS envelope encryption of stored secrets
Multi-region deploymentswhat works today and a recommended cell architecture
Architecturedomain model, events, delivery, hooks, package map
Testingunit, integration, fuzz, load and chaos tests
Roadmapwhat is done and what may come