Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

QdrantBackup

qdrantbackups.qdrant.io, short name qb, namespaced. One backup of a cluster: a snapshot per collection per node, in a bucket, with a manifest. The spec is immutable.

Spec

FieldDefaultDescription
clusterRef.namerequiredThe QdrantCluster
clusterRef.namespaceown namespace
storage.s3.bucketrequired
storage.s3.prefix""Key prefix; the backup lives under <prefix>/<name>/
storage.s3.regionus-east-1
storage.s3.endpointAWSCustom endpoint for MinIO and other S3-compatible stores
storage.s3.forcePathStylefalsePath-style URLs, required for MinIO
storage.s3.credentialsSecretRef.namerequiredSecret in the backup's namespace
storage.s3.credentialsSecretRef.accessKeyIdKeyAWS_ACCESS_KEY_ID
storage.s3.credentialsSecretRef.secretAccessKeyKeyAWS_SECRET_ACCESS_KEY
collections[]allCollections to back up
retentionDaysunsetDays after completion until the resource deletes itself

Status

FieldMeaning
phasePending, InProgress, Completed or Failed
startTime, completionTime
expiresAtcompletionTime plus retentionDays
s3Paths3://<bucket>/<prefix>/<name>
totalSizeSum of the completed snapshots, human-readable
collections[]Per collection: name, status, size, snapshots[] with node, snapshotName and key, and error
errorThe first failed collection's error
conditions[Complete]BackupCompleted or BackupFailed, message Backed up n/m collections

Behavior

On create only. Resolves the cluster and the credentials, retrying every thirty seconds while either is missing, sets InProgress, then for each collection and each node in ordinal order creates a snapshot, streams it to <prefix>/<name>/<collection>/node-<i>/<snapshot> and deletes it on the node. Writes manifest.json under <prefix>/<name>/ and sets Completed, or Failed when any collection failed. With retentionDays, a timer every five minutes deletes the resource once expiresAt has passed.

On delete: every object under <prefix>/<name>/ is removed. If the credentials Secret is missing, a warning is logged and the objects stay.

Print columns: CLUSTER, PHASE, SIZE, AGE.