Documentation
Everything you need to run inspectable virtual Kubernetes tenants with tenantplane.
tenantplane is an open source virtual Kubernetes tenant platform for teams that need multi-tenancy that is secure by design, transparent, and easy to operate. These docs take you from a first tenant on a kind cluster through the concepts and reference material behind them.
New here? Start with the Introduction, then run the Quickstart.
Introduction
What tenantplane is, who it's for, and the principles behind it.
Quickstart
Install the CRDs and controller on a kind cluster and bring up your first tenant.
Architecture
How the controller, control planes, isolation, and sync engine fit together.
Why tenantplane
What tenantplane is, how it thinks about multi-tenancy, and where it draws the line.
Concepts
The three resources and the sync engine that make up tenantplane's model.
Install
Install the CRDs and controller onto a Kubernetes cluster.
Your first tenant
Create a shared-mode tenant, connect to it, and see resources sync to the host.
Applying isolation
Choose an isolation level and verify the boundary it creates.
Predicting sync with explain-sync
Ask where a tenant resource will land on the host — before applying anything.
Deploy on AWS EKS
Run tenantplane on Amazon Elastic Kubernetes Service.
Deploy on Azure AKS
Run tenantplane on Azure Kubernetes Service.
Deploy on Google GKE
Run tenantplane on Google Kubernetes Engine.
CLI reference
The tenantplane command-line interface.
CRD reference
Field-level reference for the tenantplane custom resources.
Roadmap
What's built, what's next, and where tenantplane is headed.