Install
This section covers installing vCluster Platform, which a system admin does once per platform. Configuring and running the platform after that belongs to Administer the management plane.
Installing the platform deploys the vcluster-platform Helm chart onto a
Kubernetes cluster you already run. That cluster becomes the control plane
cluster. The platform also runs its agent there and
manages that cluster through it.
It manages any control plane cluster you connect later the same way. When the
install finishes, the platform UI is running and ready for its first sign-in.
You need a cluster where your current kube-context has admin access, and
kubectl and Helm on the machine you install from. The platform pods need
egress to the license server, unless you license the platform offline for an
air-gapped install. The platform and the clusters it connects to need
open network ports
between them. Each method page lists the full prerequisites.
Choose an install method​
All three methods install the same chart. They differ in how you manage the install afterward.
| If you want to | Use | What it does |
|---|---|---|
| Get running quickly or try the platform | vCluster CLI | Installs the chart with one command, opens the UI, and prompts you to create the admin user. It's the preferred method. You can export the configuration later if you move to GitOps. |
| Keep the chart values in version control | Helm | Installs the chart directly, so you set the values yourself and manage the platform as a Helm release. |
| Manage the platform from Git with Argo CD | Argo CD | Deploys the chart as an Argo CD Application. Argo CD must already run on the control plane cluster. The same approach works with other GitOps tools. |
Install in a specific environment​
Most installs use one of the methods above on a cluster you already have. Two situations have their own guides.
| Your situation | Start with |
|---|---|
| You don't have a cluster yet, and you run on AWS, Azure, or Google Cloud | EKS, AKS, or GKE. Each guide creates the cluster with the cloud provider's CLI, then installs the platform with the vCluster CLI. |
| The cluster has no internet access | With offline license key, which mirrors images and charts into a private registry and licenses the platform offline. Use With offline license server when you need usage tracking and export from an in-cluster license service. |
An offline license key stores usage snapshots in a local database. See Platform database.
After you install​
A fresh install isn't yet a platform your tenants can use. After you install is the checklist that gets it there. It covers the domain, sign-in, connected clusters, machines, access, templates, and a first cluster.
Covered in other sections​
- To change installation options or platform config, see Configure the platform.
- To keep the platform available through failures, see High availability.
- To move to a new version, see Upgrade vCluster Platform or Upgrade in an air-gapped environment.
- To run vCluster on its own without the platform, see Deploy in the vCluster docs.