Cluster Access
Cluster access allows you to give certain Users and Teams direct permission to a cluster without assigning them to a project. This is usually only useful for admin users or special privileged teams, while in all other cases you should prefer projects.
Cluster access lets you define access to certain clusters for your users or teams along with the cluster roles that would be synced for them in the connected cluster. You can create your own Cluster Access by following the below steps.
Create a cluster access​
Go to Infra Management > Control Plane Clusters.
Click the Cluster Access tab and then click .
In the configuration sheet that opens, give the access a name by replacing the auto-generated placeholder name, or by updating the manifest YAML 'metadata.name' field.
In the Options tab, choose the users or teams to grant access under Users & Teams, then choose the cluster roles under Cluster Roles.
In the Control Plane Clusters tab, choose the control plane clusters to grant access to from the Select Control Plane Clusters selector.
In the Access tab, select the user or team that can manage this cluster access object, then choose their allowed permissions.
Click to create the cluster access.
Cluster access and tenants​
Direct access to a control plane cluster through Platform, such as kubectl
requests that Platform proxies to the cluster, needs a cluster access. It must
list the cluster and name the user, one of their teams, or all users.
A tenant user can only reach a control plane cluster assigned to their tenant.
A platform admin assigns the cluster by setting tenant.vcluster.com/exclusive-to
to the tenant name, with the tenant's controlPlaneClusters capability enabled.
A cluster the tenant only sees, through a capability grant or the
tenant.vcluster.com/all label, can't be reached through any cluster access,
because a cluster access binds cluster-wide and would reach other tenants'
namespaces.
The tenant's boundary must also admit the cluster access. Choose one of these options:
- Assign it to the tenant by setting
tenant.vcluster.com/exclusive-toto the tenant name. Prefer this option. Only that tenant can read the cluster access. - Share it with every tenant by setting
tenant.vcluster.com/allto"true". Every tenant can then read the whole object, including the users and teams it names. Use this only for a cluster access meant for every tenant, one that names all users rather than specific users or teams.
These labels go on the ClusterAccess object's metadata.labels. An unlabeled
platform-owned cluster access doesn't reach tenant users, even when it names them.
See Ownership labels.
Being able to see a cluster isn't enough. A tenant admin can read every cluster granted to the tenant, but can only reach into one that's assigned to the tenant and covered by a cluster access. Tenants can't create cluster accesses, so only a platform admin grants this.
A request that fails these checks is refused with 403 and this message.
no cluster access: access denied
The agent proxy caches allowed access decisions for 15 seconds. It doesn't cache denials, so a new grant doesn't have to wait for a denied decision to expire. After access is revoked, requests with a cached allowance can continue until that allowance expires.
A cluster access shared with every tenant that names all users grants access to every platform user, and to every user in the tenant the cluster is assigned to. Assign the access to one tenant or name specific users or teams to restrict its reach.