Skip to main content

Quickstart Guide

1. Download vcluster CLI#

Use one of the following commands to download the vcluster CLI binary from GitHub:

curl -L -o vcluster "" && sudo install -c -m 0755 vcluster /usr/local/bin && rm -f vcluster

Alternatively, you can download the binary for your platform from the GitHub Releases page and add this binary to your PATH.

To confirm that vcluster CLI is successfully installed, test via:

vcluster --version

2. Create a vcluster#

# Create a new vcluster in namespace vcluster-my-vcluster
vcluster create my-vcluster
# OR: Use --expose to create a vcluster in a remote cluster with an externally accessible LoadBalancer
vcluster create my-vcluster --expose
# OR: Use -f to use an additional helm values.yaml with extra chart options to deploy vcluster
vcluster create my-vcluster -f values.yaml
# OR: Use --distro to specify either k0s or vanilla k8s as backing virtual cluster
vcluster create my-vcluster --distro k8s
# OR: Use --isolate to create an isolated environment for the vcluster workloads
vcluster create my-vcluster --isolate

3. Use the vcluster#

# Run any kubectl, helm, etc. command in your vcluster
kubectl get namespace
kubectl get pods -n kube-system
kubectl create namespace demo-nginx
kubectl create deployment nginx-deployment -n demo-nginx --image=nginx
kubectl get pods -n demo-nginx

4. Cleanup#

# switch the kube context back
vcluster disconnect
# OR: switch context back and delete vcluster
vcluster delete my-vcluster