Skip to main content
Version: main 🚧

Uninstall

This guide provides instructions on how to uninstall the platform from your Kubernetes cluster.

warning

This action is performed against the cluster the kube-context is pointing to, not the platform instance that is logged in. It does not require logging in to the platform.

Prerequisites​

  • Administrator access to a Kubernetes cluster: See Accessing Clusters with kubectl for more information. Your current kube-context must have administrative privileges, which you can verify with kubectl auth can-i create clusterrole -A

    info

    To obtain a kube-context with admin access, ensure you have the necessary credentials and permissions for your Kubernetes cluster. This typically involves using kubectl config commands or authenticating through your cloud provider's CLI tools.

  • helm installed: Helm v3.10.0+ is required for deploying the platform. Refer to the Helm Installation Guide if you need to install it.

  • kubectl installed: Kubernetes command-line tool for interacting with the cluster. See Install and Set Up kubectl for installation instructions.

Uninstall​

There are two ways to uninstall the platform.

info
This feature was introduced in vCluster version v0.24

Delete the platform​

Note that VirtualClusterInstance objects for clusters deployed with the Helm driver are deleted, but the underlying clusters are not uninstalled.

Use vCluster CLI v0.38 or later to destroy Platform v5.0. Earlier CLI versions stop before deleting anything, with an error that some storage.loft.sh resources are unhandled and suggest a newer CLI version.

Destroy deletes all platform data

Before it uninstalls the platform, the command deletes every platform object. That includes cluster instances, templates, projects, connected clusters, node claims, machines, network environments, node providers, tenants and their storage, teams, users, and access keys. Back up anything you need first. See Back up vCluster Platform.

On the Kubernetes cluster where the platform is installed, and all connected clusters, run:

Delete the platform using vCluster CLI
vcluster platform destroy
info

The command does the following:

  • Uninstalls Helm releases related to vCluster Platform.
  • Deletes CustomResourceDefinitions (CRDs) created by the platform.
  • Deletes the namespace where the platform is installed. To keep it, set --delete-namespace=false.
  • Removes cluster roles and cluster role bindings created by the platform.

In order to force delete all the platform resources, you can use the flag --force-remove-finalizers. This will remove the finalizers from the resources, forcing the platform resources to be deleted immediately.

Force delete the platform using vCluster CLI
vcluster platform destroy --force-remove-finalizers
warning

Removing finalizers may cause unintended behaviours like leaving some resources behind, but will ensure the platform is uninstalled.

Troubleshoot​

If a resource is stuck or encounters an error during deletion, refer to the troubleshooting section for assistance.