Skip to main content
Version: main 🚧

Auto delete

Limited vCluster Tenancy Configuration Support

This feature is only available for the following:

Running the control plane as a container and the following worker node types:
Enterprise-Only Feature

This feature is an Enterprise feature. See our pricing plans or contact our sales team for more information.

Auto-delete automatically removes virtual clusters after a period of inactivity. This helps reduce costs by cleaning up unused development or test environments.

How it works​

When you configure autoDelete for a virtual cluster connected to the Platform:

  1. The Platform tracks activity (API calls, ingress access) on the virtual cluster
  2. After the configured inactivity period, the Platform deletes the VirtualClusterInstance resource
  3. What happens next depends on how the virtual cluster was added to the Platform
Cleanup behavior depends on management mode
  • Platform-managed (external: false): The Platform deletes both the VirtualClusterInstance and the underlying vCluster resources (Helm release, namespace)
  • Externally managed (external: true): The Platform only removes the VirtualClusterInstance from Platform tracking. The underlying Helm release and namespace remain and must be cleaned up manually using your original deployment tool (Helm, Argo CD, etc.)

For more information about management modes, see Add existing virtual clusters.

Prerequisites​

  • The virtual cluster must be connected to the Platform. See Connect to the Platform for configuration details.
  • Auto-delete requires an active Platform agent to track inactivity and trigger deletion.

Example​

vcluster.yaml
external:
  platform:
    autoDelete:
      # Delete the virtual cluster after 10 minutes of inactivity
      # Value is in seconds
      afterInactivity: 600

For longer inactivity periods:

vcluster.yaml - Delete after 24 hours
external:
  platform:
    autoDelete:
      # 24 hours = 86400 seconds
      afterInactivity: 86400

Config reference​

autoDelete required object ​

AutoDelete holds configuration for automatic delete

afterInactivity required integer ​

AfterInactivity specifies after how many seconds of inactivity the virtual cluster be deleted