Platform
This feature is available in the vCluster Pro tier. Contact us for more details and to start a trial.
You can connect to vCluster Platform through the vcluster.yaml
and configure different
vCluster Platform settings that work with the virtual cluster.
Example​
With this example, you can set the vCluster to automatically sleep after 10 minutes.
external:
platform:
autoSleep:
schedule: * 17 * * * # Sleep at 5 PM
autoWakeup:
schedule: * 9 * * * # Wakeup at 9 AM
Config reference​
platform
required object pro​
Platform holds configuration for vCluster platform
platform
required object pro​apiKey
required object pro​
APIKey defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:
- platform.api.accessKey
- environment variable called LICENSE
- secret specified under external.platform.apiKey.secretName
- secret called "vcluster-platform-api-key" in the vCluster namespace
apiKey
required object pro​secretName
required string pro​
SecretName is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.
secretName
required string pro​namespace
required string pro​
Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace
where the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.
namespace
required string pro​createRBAC
required boolean pro​
CreateRBAC will automatically create the necessary RBAC roles and role bindings to allow vCluster to read the secret specified
in the above namespace, if specified.
This defaults to true.
createRBAC
required boolean pro​autoSleep
required object pro​
AutoSleep holds configuration for automatic sleep and wakeup
autoSleep
required object pro​afterInactivity
required integer pro​
AfterInactivity specifies after how many seconds of inactivity the virtual cluster should sleep
afterInactivity
required integer pro​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.
schedule
required string pro​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".
timezone
required string pro​autoWakeup
required object pro​
AutoSleep holds configuration for automatic wakeup
autoWakeup
required object pro​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
schedule
required string pro​