Skip to main content

Choose your starting point

A complete platform stacks four layers. Machines run a Kubernetes cluster. That cluster runs vCluster Platform and becomes the control plane cluster. Platform then delivers clusters and other services to your tenants.

You don't have to build every layer. Start at the first layer you don't already have, and reuse what you run today.

Building for your own engineering teams rather than for customers? The same layers apply, and your tenants are your internal teams. See Team and CI clusters as a service for that path.

What you already runLayers of your platformClusters and servicesClusters, instances, and apps for your tenantsvCluster PlatformTenants, projects, templates, and the service catalogKubernetes clustersClusters created with vClusterControl plane clusterThe Kubernetes cluster that vCluster Platform runs onA provisioner or machine inventoryMachinesBare metal and VMs, provisioned by vMetalBare metal only
Each starting point begins at the first layer you don't already run.
What you already runStart hereWhat you can skip
Bare metal and nothing elseBare metal onlyNothing
A machine provisioner or inventoryA provisioner or machine inventoryBuilding your own provisioning
One or more Kubernetes clustersKubernetes clustersThe machine layer and the first Kubernetes cluster
Clusters created with vClusterClusters created with vClusterRe-creating those clusters

Bare metal only​

Use one bare metal server to bootstrap the control plane cluster, then bring the rest of your bare metal in through vMetal.

  1. Install vCluster Standalone on one bare metal Linux server. Standalone is a complete Kubernetes distribution that runs as a single binary, with no existing cluster required. See the Standalone quick start.
  2. Install vCluster Platform on that cluster with Helm, as a separate step. See Install with Helm.
  3. Connect the rest of your bare metal servers through a vMetal provisioning driver, such as Metal3 for bare metal you provision directly. See Get started with vMetal.

A provisioner or machine inventory​

If you already manage bare metal or VMs with another system, vMetal can provision through it instead of replacing it.

  1. Install vCluster Platform on any Kubernetes cluster. That cluster becomes the control plane cluster. See the Platform quick start.
  2. Create a node provider for the system you run. vMetal supports these provisioning drivers:
  3. Choose what the machines become. A machine can be a cluster node, host a cluster control plane, or stay an instance with no cluster that a tenant reaches over SSH.

Kubernetes clusters​

If you already run Kubernetes, install Platform on one of your clusters and connect the others.

  1. Install vCluster Platform on one cluster, with the CLI or with Helm. That cluster becomes the first control plane cluster. See the Platform quick start.
  2. Connect your other clusters as additional control plane clusters with vcluster platform add cluster. See Connect a cluster.
  3. Give tenant workloads private nodes. Join machines to each cluster as private nodes yourself, or let Auto Nodes provision them on demand. See Capacity models.

Clusters created with vCluster​

If you already run clusters with the vCluster CLI or Helm chart, bring them under Platform management instead of re-creating them.

  1. Install vCluster Platform if you haven't yet. See the Platform quick start.
  2. Import each cluster with vcluster platform add vcluster. Add --all to import the clusters in every namespace of the control plane cluster. For a Standalone cluster, use vcluster platform add standalone instead. See Add existing clusters.
  3. Decide how much Platform manages. By default, an imported cluster stays externally managed instead of being managed by the platform agent. To have the agent manage it, connect its control plane cluster first, then import with --external=false. See Platform-managed and externally deployed clusters.

Next steps​