Skip to main content
Version: v4.11

Manage sleep and auto-delete

Enterprise
Available in these plansFreeDevProdScale
Auto Sleep for Virtual Clusters

Free, Dev, Prod, and Scale are vCluster Platform license plans. Open source does not need a license or a Platform connection. See Compare open source and free tiers.

vClustervClusterAn open-source software product that creates and manages tenant clusters within Kubernetes infrastructure. vCluster provides tenant isolation capabilities while reducing infrastructure costs.Related: Tenant cluster, Control plane cluster Platform can scale down an idle tenant cluster's workloads and control plane. It can restore them after detected activity or at a scheduled time. The platform can also delete tenant clusters after an inactivity period.

Put a tenant cluster to sleep​

  1. Select the project that contains the tenant clusterTenant clusterA fully isolated Kubernetes environment provisioned for a single tenant. Each tenant cluster has its own API server, controller manager, and resource namespace, backed by a virtualized control plane hosted on a control plane cluster. From the tenant's perspective it behaves exactly like a standard Kubernetes cluster.Related: Control plane cluster, Tenant cluster.
  2. Click Tenant Clusters in the sidebar.
  3. Open the More actions menu for the tenant cluster.
  4. Click Sleep.
  5. Optionally select Prevent automatic wake up and enter a duration in hours. Enter 0 to prevent automatic wakeup indefinitely.
  6. Click Ok.

To perform the same operation with the CLI, run:

vcluster platform sleep vcluster <vcluster-name> --project <project-name>

Add --prevent-wakeup <seconds> to block activity-based wakeup for a period. Use --prevent-wakeup 0 to require a manual wakeup.

Wake a tenant cluster​

Open the sleeping tenant cluster's More actions menu, click Wake Up, then confirm Wake Up. You can also run:

vcluster platform wakeup vcluster <vcluster-name> --project <project-name>

Unless wakeup is currently prevented, a Kubernetes API request routed through the platform can wake the tenant cluster automatically. Supported Ingress, Istio, and Gateway API traffic can also trigger wakeup.

Configure auto sleep​

See Configure auto sleep for the Platform UI and vcluster.yaml procedures, schedules, and activity detection. For a tenant cluster created from a template, configure sleep in the template.

Configure auto-delete​

Auto-delete permanently deletes a tenant cluster after an inactivity period. It is separate from sleep and can run whether the tenant cluster is awake or sleeping.

See Configure automatic deletion for the Platform UI and vcluster.yaml procedures.