What are tenants
A tenant is a customer organization inside vCluster Platform. This page explains how its boundary works: what a platform admin grants, what a new tenant starts with, and how the boundary combines with roles and projects. For where tenants sit in the hierarchy and when to use them, see Deliver services to tenants.
The tenant boundary​
Every tenant starts with no grants to platform inventory. A platform admin has to say what the tenant may reach. This matters for upgrades too. A capability added in a later release can't silently widen what an existing tenant is allowed to reach.
The boundary is built from capabilities. Each one covers a class of platform resource and answers two questions. Is this capability available at all? Which instances of it may the tenant use? The boundary reference answers the same pair per resource, as whether the tenant can author its own and what happens to the platform's.
| Capability | What it governs |
|---|---|
| Control plane clusters | Which of the platform's control plane clusters the tenant's clusters can run on. Tenants can't register their own |
| Node types | Which node types the tenant can provision from, and how many instances of each it can hold |
| OS images | Which images the tenant can boot machines from |
| SSH keys | Whether the tenant can register authorization keys for machine access |
| Templates | Which templates the tenant can instantiate |
| Connectors | Which of the platform's connectors the tenant can use. The tenant never sees a connector's credentials |
A disabled capability withholds the whole resource, including anything the tenant created before it was switched off.
Read the full boundary reference →
Alongside capabilities, a platform admin can assign individual resources to one tenant exclusively, or share one resource with every tenant. A physical machine or a network environment is typically handed to a single tenant this way, rather than being selected from a shared pool. Projects, clusters, node pools, and the other resources that live in a project can't be assigned, and neither can users, teams, access keys, or config maps.
What a Tenant comes with​
Creating a tenant also creates three things, so the customer has somewhere to start.
- An admin identity, named
<tenant>--admin. This is the tenant admin. - An admin team, named
<tenant>--admins. It holds full administrative rights inside the tenant boundary, and the admin identity belongs to it. - A default project, named
<tenant>--default.
Effective access​
A user's real permissions are the intersection of three things.
- Their role. Ordinary Kubernetes RBAC.
- The tenant boundary. What the platform admin granted the tenant.
- The project boundary. What the tenant admin allowed in that project.
Narrowing any one of them narrows the result. A tenant admin holds broad rights, but those rights stop at the edge of their tenant. They can't widen their own boundary, because only a platform admin writes it.
The tenant boundary applies only to identities that belong to a tenant. A platform admin belongs to none, so a platform admin session, and any automation that uses its credentials, isn't narrowed by any tenant. Writes into a tenant's projects are the exception. They're still held to that tenant's rules, such as the template requirement and the name prefix. To keep automation inside one customer's boundary, have it act as a user in that customer's tenant.
Tenant isolation across the stack​
Tenant isolation depends on controls at more than one layer.
The tenant boundary described on this page separates inventory, identities, and configuration in the management plane.
Running workloads need their own isolation mechanisms. Private nodes, vNode, and network policy operate in and around the clusters a project user creates.
These controls are independent. A narrow tenant boundary doesn't isolate workloads at runtime. Private nodes don't stop a platform admin from over-granting inventory to a tenant.
Per-tenant configuration​
A tenant carries configuration of its own, separate from the platform's.
- Hostnames claim DNS names for the tenant. Platform uses the first one in the invite and password-reset links that a platform admin creates. Hostnames don't change the sign-in page or branding. Only a platform admin sets these.
- UI customization brands the tenant's view of Platform after its users sign in. Only a platform admin sets this. See Brand a tenant.