Skip to main content

autoSleep


Pro Feature

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

The virtual cluster can be scheduled to sleep and wake up in the vcluster.yaml, but in order to use this ability, the vCluster also will need to be connected to the platform.

Example​

external:
  platform:
    autoSleep:
      schedule: * 17 * * * # Sleep at 5 PM
      autoWakeup:
        schedule: * 9 * * * # Wakeup at 9 AM

Config reference​

autoSleep required object pro​

AutoSleep holds configuration for automatic sleep and wakeup

afterInactivity required integer pro​

AfterInactivity specifies after how many seconds of inactivity the virtual cluster should sleep

schedule required string pro​

Schedule specifies scheduled virtual cluster sleep in Cron format, see https://en.wikipedia.org/wiki/Cron. Note: timezone defined in the schedule string will be ignored. Use ".Timezone" field instead.

timezone required string pro​

Timezone specifies time zone used for scheduled virtual cluster operations. Defaults to UTC. Accepts the same format as time.LoadLocation() in Go (https://pkg.go.dev/time#LoadLocation). The value should be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".

autoWakeup required object pro​

AutoSleep holds configuration for automatic wakeup

schedule required string pro​

Schedule specifies scheduled wakeup from sleep in Cron format, see https://en.wikipedia.org/wiki/Cron. Note: timezone defined in the schedule string will be ignored. The timezone for the autoSleep schedule will be used