Skip to main content
Version: main 🚧

Administer the management plane

This section covers running vCluster Platform itself. It's usually work for the system admin who installed the platform. The changes made here affect how the platform runs for everyone, rather than what one tenant or project can do.

The platform is the management plane for your clusters. It runs as the vcluster-platform Helm chart and is the source of truth for every platform decision. Admins and automation reach it through the UI, CLI, and API. Its controllers reconcile what they define into connected control plane clusters. On each of those clusters, an agent keeps an outbound connection to the platform, and cluster control planes run there.

Management plane and connected clustersUsers reach vCluster Platform through the UI, CLI, and API. The management plane runs a web UI, an authenticating gateway, a management API serving Platform resources, controllers that reconcile them, and a backing store of custom resources. Platform reconciles that state into connected clusters, each running a Platform agent alongside cluster workloads.Management plane and connected clustersUsersUI, CLI, APIvCluster PlatformManagement planeWeb UIBrowserGatewayAuthAPIResourcesControllersReconcileBacking storeCustom resourcesConnected clusterAgentOutbound linkClusterNamespaces, RBACConnected clusterAgentOutbound linkClusterNamespaces, RBAC
The management plane and the control plane clusters it connects to

By default, the platform runs as a single replica and stores its state as Kubernetes resources in the control plane cluster it's installed on. Most of this section covers what you change from there, such as who can sign in, which clusters the platform manages, how it survives failures, and how you keep it current. For the components in detail, see Architecture and How Platform works.

Work in this section​

The groups follow the platform's life. You configure it and decide who can sign in, connect the clusters it manages, and make it reliable. Then you watch it, keep it current, and fix what goes wrong.

Two pages sit outside the groups. The Inbox collects product updates and license warnings for admins. Uninstall removes the platform and deletes every platform object.

Where this section stops​

Administer covers the platform as a running service. Other sections cover what you do with it.

If you want toSee
Install the platform for the first timeInstall
Create tenants and projects, and manage users and permissionsDeliver services to tenants
Monitor or collect logs across many clustersOperate the fleet
Connect Argo CD, secret stores, and other toolsIntegrate and automate