Skip to main content
Version: v0.38 Stable

snapshots

The snapshots key configures automatic snapshots. For how to configure it, see Auto snapshots.

snapshots object ​

Snapshots holds configuration for automatic vCluster snapshots.

auto object ​

Auto holds automatic snapshot configuration

schedule string ​

Schedule specifies a scheduled time in Cron format, see https://en.wikipedia.org/wiki/Cron for a tenant cluster snapshot to be taken

timezone string ​

Timezone specifies time zone used for scheduled snapshot 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".

retention object ​

Retention specifies how long snapshots will be kept

period integer ​

Period defines the number of days a snapshot will be kept

maxSnapshots integer ​

MaxSnapshots defines the number of snapshots that can be taken

storage object ​

Storage specifies where the snapshot will be stored

type string ​

Type specifies supported type of storage services for a snapshot S3/OCI/Container, see https://www.vcluster.com/docs/vcluster/manage/backup-restore#store-snapshots-in-s3-buckets

s3 object ​

S3 holds configuration for storing snapshots in S3-compatible bucket

url string ​

Url specifies url to the storage service

credential object ​

Credential secret with the S3 Credentials, it should contain AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN

secretName string ​

SecretName is the secret name with credential

secretNamespace string ​

SecretNamespace is the secret namespace with credential

oci object ​

OCI holds configuration for storing snapshots in OCI image registries

repository string ​

Repository OCI repository to store the snapshot

credential object ​

Credential secret with the OCI Credentials

secretName string ​

SecretName is the secret name with credential

secretNamespace string ​

SecretNamespace is the secret namespace with credential

username string ​

Username to authenticate with the OCI registry

password string ​

Password to authenticate with the OCI registry

container object ​

Container holds configuration for storing snapshots as local files inside a vCluster container

path string ​

Path specifies directory to store the snapshot

volume object ​

Volume specifies which volume needs to be mounted into the container to store the snapshot

name string ​

Name to be used to mount the volume

path string ​

Path to the volume mount

azure object ​

Azure holds configuration for storing snapshots in Azure Blob Storage

blobUrl string ​

BlobURL specifies the Azure Blob Storage URL in the format https://{account}.blob.core.windows.net/{container}/{path}

credential object ​

Credential secret with the Azure credentials. The secret should contain either: AZURE_STORAGE_KEY (storage account access key), or AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP (service principal)

secretName string ​

SecretName is the secret name with credential

secretNamespace string ​

SecretNamespace is the secret namespace with credential