Roles and scopes
Running a platform for tenants involves people at three scopes. The platform scope covers everything vCluster Platform manages. A tenant scope covers one customer organization. A project scope covers one team's work inside a tenant.
Each role hands off to the next.
- A system admin installs vCluster Platform on a Kubernetes cluster, which becomes the control plane cluster.
- A platform admin creates tenants and grants each one the inventory it may use.
- A tenant admin manages the tenant's assigned infrastructure and divides its grant across projects.
- A project admin manages a project's members and resources.
- A project user creates clusters and other services inside a project.
| Role | Scope | Built-in role | What they do |
|---|---|---|---|
| Platform admin | The whole platform | Management Admin, through the Global Admins team | Creates tenants, grants inventory, assigns machines, and sets quotas |
| Tenant admin | One tenant | Management Admin, confined to the tenant | Creates users and projects, and divides the tenant's grant across projects |
| Project admin | One project | Project Admin | Manages the project's members and everything in it, including Stacks |
| Project user | One project | Project User | Creates clusters, namespaces, project secrets, and apps |
| Project viewer | One project | Project Viewer | Views the project's resources |
Platform scope
The platform admin works across every tenant. The admin user created at install time is a platform admin, through the built-in Global Admins team, which holds the Management Admin role. Add other platform admins to that team.
A platform admin belongs to no tenant, and no tenant narrows what a platform admin session can see or do. Only a platform admin can create tenants, change what a tenant may use, or see more than one tenant.
vCluster Platform also ships narrower global roles, such as admin, creator, and viewer roles for templates, users, teams, and clusters. Use them to delegate part of the platform admin's work without granting Management Admin. See Users and permissions.
Tenant scope
A tenant is a customer organization, the boundary above projects. When a platform admin creates a tenant, vCluster Platform bootstraps three objects for it.
- An Admins team,
<tenant>--admins, which holds the Management Admin role inside the tenant - An Admin user,
<tenant>--admin, which is a member of that team - A default project,
<tenant>--default
See What are tenants for the tenant boundary and Create and configure tenants for the setup procedure.
What a platform admin grants a Tenant
A tenant can use nothing until a platform admin grants it. These grants are called capabilities, and each one is off until enabled. An enabled capability selects the items the tenant may use by label, and node types can also be selected by name. The SSH keys capability has no selector. It lets the tenant register keys of its own.
- Control plane clusters
- SSH keys and OS images
- Node types, each with an optional quota on how many instances the tenant can hold
- Templates, including cluster templates, Apps, and Stack templates
- Connectors
Machines and network environments aren't capabilities. A platform admin reserves them for a tenant by assigning them to it, for example with Assign to tenant in the machine inventory. See Capacity models.
What a tenant admin can do
A tenant admin holds the same Management Admin role as a platform admin, but the tenant boundary confines it.
- Inside the tenant, a tenant admin can create users and projects, assign roles, and divide the tenant's grant across projects. Each project lists the node types, node profiles, network environments, and templates its members may use. See Allowed node types.
- Outside the tenant, a tenant admin can't create tenants, see other tenants, or view or change their own tenant's capabilities and quotas. Those stay with the platform admin.
Users, teams, projects, and other cluster-scoped objects a tenant owns must have names that start with the tenant's name and --, for example <tenant>--ml-research.
Tenant membership
A user belongs to at most one tenant. Membership is set when the user is created and can't change afterward, even by a platform admin. Users that a tenant admin creates join that tenant automatically.
Project scope
Project roles apply to one project. Grant them by adding users or teams as project members with a role.
- Project Admin manages everything in the project, including members, clusters, namespaces, instances, Apps, and Stacks.
- Project User creates and uses clusters, namespaces, and project secrets, and installs Apps. It can't install Stacks.
- Project Viewer can view the project's resources but not change them.
To let project users install Stacks without making them project admins, add a custom project role. See Stack permissions.
Check your license
Tenants are the Multi-Tenancy feature in your vCluster Platform license. Your license also sets how many tenants you can create.
Related
- Choose your starting point explains where the system admin starts.
- Capacity models explains the machines and quotas a platform admin grants.
- Users and permissions covers role assignment in detail.