snapshots
The snapshots key configures automatic snapshots. For how to configure it, see Auto snapshots.
snapshots object ​
Snapshots holds configuration for automatic vCluster snapshots.
snapshots object ​auto object ​
Auto holds automatic snapshot configuration
auto object ​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
schedule string ​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".
timezone string ​retention object ​
Retention specifies how long snapshots will be kept
retention object ​period integer ​
Period defines the number of days a snapshot will be kept
period integer ​maxSnapshots integer ​
MaxSnapshots defines the number of snapshots that can be taken
maxSnapshots integer ​storage object ​
Storage specifies where the snapshot will be stored
storage object ​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
type string ​s3 object ​
S3 holds configuration for storing snapshots in S3-compatible bucket
s3 object ​url string ​
Url specifies url to the storage service
url string ​oci object ​
OCI holds configuration for storing snapshots in OCI image registries
oci object ​repository string ​
Repository OCI repository to store the snapshot
repository string ​credential object ​
Credential secret with the OCI Credentials
credential object ​secretName string ​
SecretName is the secret name with credential
secretName string ​secretNamespace string ​
SecretNamespace is the secret namespace with credential
secretNamespace string ​username string ​
Username to authenticate with the OCI registry
username string ​password string ​
Password to authenticate with the OCI registry
password string ​container object ​
Container holds configuration for storing snapshots as local files inside a vCluster container
container object ​path string ​
Path specifies directory to store the snapshot
path string ​azure object ​
Azure holds configuration for storing snapshots in Azure Blob Storage
azure object ​blobUrl string ​
BlobURL specifies the Azure Blob Storage URL in the format https://{account}.blob.core.windows.net/{container}/{path}
blobUrl string ​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)
credential object ​secretName string ​
SecretName is the secret name with credential
secretName string ​secretNamespace string ​
SecretNamespace is the secret namespace with credential
secretNamespace string ​