Documentation Index Fetch the complete documentation index at: https://mintlify.com/loft-sh/vcluster/llms.txt
Use this file to discover all available pages before exploring further.
Synopsis Connects to an existing virtual cluster by updating your kubeconfig.
vcluster connect VCLUSTER_NAME [flags] [-- COMMAND]
Description The connect command updates your kubectl context to point to the specified virtual cluster. It can also execute commands directly within the vCluster context.
Examples Basic Connection # Connect to a vCluster vcluster connect my-vcluster --namespace team-x # Connect with custom kubeconfig location vcluster connect my-vcluster -n team-x --kube-config ./my-kubeconfig
Execute Commands # Open a bash shell with vCluster context vcluster connect my-vcluster -n team-x -- bash # Run kubectl commands directly vcluster connect my-vcluster -n team-x -- kubectl get pods # Run multiple commands vcluster connect my-vcluster -n team-x -- sh -c "kubectl get ns && kubectl get pods -A"
Background Connection # Start port-forwarding in background vcluster connect my-vcluster -n team-x --background # Connect later without starting new port-forward vcluster connect my-vcluster -n team-x --use-existing-port-forward
Flags The Kubernetes namespace where the vCluster is running.
The driver to use. Options: helm, platform, docker.
Path to kubeconfig file to update. Defaults to $KUBECONFIG or ~/.kube/config.
The server to connect to. If not specified, uses port-forwarding.
Service account name to use for authentication.
Skip TLS certificate verification.
Start port-forwarding as a background process.
--use-existing-port-forward
Use an existing port-forward instead of starting a new one.
The local port to use for port-forwarding.
Print the kubeconfig to stdout instead of updating the file.
--kube-config-context-name
Custom name for the kubeconfig context.
[PLATFORM] The vCluster Platform project name.
Connection Methods vCluster supports multiple connection methods:
1. Port-Forwarding (Default) The default and most compatible method. Creates a local port-forward to the vCluster:
vcluster connect my-vcluster -n team-x
Pros:
Works from anywhere with kubectl access
No additional infrastructure needed
Secure (uses existing k8s authentication)
Cons:
Requires active connection
Additional latency
2. Direct Connection Connect directly using a LoadBalancer or Ingress:
# Get the external address kubectl get svc -n team-x my-vcluster -o jsonpath='{.status.loadBalancer.ingress[0].ip}' # Connect using external address vcluster connect my-vcluster -n team-x --server https://external-ip:443
Pros:
Lower latency
No local port-forwarding needed
Better for CI/CD
Cons:
Requires LoadBalancer or Ingress
Must manage certificates
3. Service Account Token Use a service account for non-interactive authentication:
vcluster connect my-vcluster -n team-x --service-account my-sa
Complete Examples CI/CD Pipeline #!/bin/bash # Connect to vCluster in CI/CD vcluster connect test-cluster -n ci \ --server https://vcluster.example.com \ --service-account ci-bot \ --kube-config /tmp/kubeconfig export KUBECONFIG = / tmp / kubeconfig # Run tests kubectl apply -f test-deployment.yaml kubectl wait --for=condition=ready pod -l app=test --timeout=60s kubectl run test-runner --image=test:latest --rm -it --restart=Never
Development Workflow # Connect in background vcluster connect dev-cluster -n development --background # Your context is now set to the vCluster kubectl get ns kubectl create deployment nginx --image=nginx # When done, disconnect vcluster disconnect
Print Kubeconfig Only # Get kubeconfig without updating local file vcluster connect my-vcluster -n team-x --print > vcluster-kubeconfig.yaml # Use it explicitly kubectl --kubeconfig vcluster-kubeconfig.yaml get pods
Output Successful connection output:
info Starting port-forwarding at 12345 info Successfully updated kube config info Switched active kube context to vcluster_my-vcluster_team-x_kind-kind
Verify connection:
# Check current context kubectl config current-context # Output: vcluster_my-vcluster_team-x_kind-kind # Test connectivity kubectl get ns
Troubleshooting
If the local port is already in use: # Use a different port vcluster connect my-vcluster -n team-x --local-port 10443
Check if the vCluster is running: kubectl get pods -n team-x kubectl logs -n team-x my-vcluster-0
For certificate issues with direct connections: # Skip certificate verification (not recommended for production) vcluster connect my-vcluster -n team-x --server https://... --insecure
Manually switch context: kubectl config use-context vcluster_my-vcluster_team-x_kind-kind
Disconnecting To disconnect from a vCluster and return to your previous context:
# Switch back to previous context kubectl config use-context < previous-contex t > # Or use vcluster list to see all contexts vcluster list
See Also 