Skip to main content

Experimental Sleep Mode


Pro Feature

This feature is available in the vCluster Pro tier. Contact us for more details and to start a trial.

warning

Native sleep mode is intended for pre-production use cases only, and comes with some limitations and caveats.

Configuration examples​

Sleep after 3 hours of inactivity, anything that does not have the label dont=sleep
experimental:
  sleepMode:
    enabled: true
    autoSleep:
      afterInactivity: 3h  # Uses Go's Duration with a max unit of hour
      exclude:
        selector:
          labels:
            dont: sleep
Sleep every Friday at 17:30 and wake every Monday at 7:00 in Mountain timezone
experimental:
  sleepMode:
    enabled: true
    timezone: America/Denver
    autoSleep:
      schedule: 30 17 * * 5
      wakeup:
        schedule: 0 7 * * 1

How it works​

Sleeping deletes bare pods and scale down the following resources:

  • Deployments
  • ReplicaSets
  • ReplicationControllers
  • DaemonSets

Waking scales those resources back up, unable to restore bare pods that were killed. To exempt resources from being put to sleep, either add the annotation sleepmode.loft.sh/exclude: true or configure sleep mode with labels to exclude and add that label to all the workloads you'd like to keep running.

Detecting activity​

To wake a sleeping cluster or to update the last active time, native sleep mode captures the following:

  • Access of cluster resources. Think kubectl get <resource>
  • Attempts to contact Ingress endpoints (NGINX only).
note

Ingress activity detection is only available for NGINX ingress controllers, making use of the mirror-target

annotation. If you use this annotation, it will be overwritten for the sleep mode to function.

Ingress considerations​

If you install your ingress controllers in the vCluster you'll need to exempt the controller from sleeping so it remains active for requests that would wake the vCluster. If you install the ingress controller in the host cluster, you'll need to enable syncing ingresses to the host.

enable ingress syncing
sync:
  toHost:
    ingresses:
      enabled: true

Config reference​

sleepMode required object pro​

SleepMode holds the native sleep mode configuration for Pro clusters

enabled required boolean pro​

Enabled toggles the sleep mode functionality, allowing for disabling sleep mode without removing other config

timeZone required string pro​

Timezone represents the timezone a sleep schedule should run against, defaulting to UTC if unset

autoSleep required object pro​

AutoSleep holds autoSleep details

afterInactivity required string pro​

AfterInactivity represents how long a vCluster can be idle before workloads are automaticaly put to sleep

schedule required string pro​

Schedule represents a cron schedule for when to sleep workloads

wakeup required object pro​

Wakeup holds configuration for waking the vCluster on a schedule rather than waiting for some activity.

schedule required string pro​

exclude required object pro​

Exclude holds configuration for labels that, if present, will prevent a workload from going to sleep

selector required object pro​
labels required object pro​

Labels defines what labels should be looked for