Reference

BackupRepo

API versionkobblestone.io/v1alpha1
KindBackupRepo
ScopeNamespaced
kubectlkubectl get backuprepos

A BackupRepo defines where Backups store their snapshots.

Types:

  • PersistentVolumeClaim: Snapshots are stored in a volume in the same namespace.
  • S3: Snapshots are uploaded to an S3-compatible bucket.

Note: A volume that does not support ReadWriteMany can only be used by one backup, restore or snapshot cleanup at a time. Others wait until it is free.

spec

Configures the volume. Required for type PersistentVolumeClaim.

4 fields
namestringrequired

Name of the PersistentVolumeClaim. It is created if it does not exist.

sizestring

Size of the PersistentVolumeClaim, e.g. 50Gi.

Required if the claim does not exist yet. Only applied to claims created by the operator.

Storage class used if the operator creates the claim.

Default is the default storage class of the cluster.

subPathstring

Path inside the volume under which snapshots are stored.

Default is the root of the volume.

s3object

Configures the bucket. Required for type S3.

3 fields
bucketstringrequired

Name of the bucket.

credentialsSecretRefobjectrequired

Reference to a Secret containing the credentials in the keys access-key and secret-key.

1 field
namestring
endpointstringrequired

URL of the S3 endpoint.

typestringrequired

Type of the repository.

Values:

  • PersistentVolumeClaim: Configured via persistentVolumeClaim.
  • S3: Configured via s3.
  • One of: PersistentVolumeClaim, S3

status

conditions[]object

Conditions of the BackupRepo.

6 fields
  • Format: date-time
messagestring
reasonstring
statusstring
typestring