How bret works
This page explains what bret does and the rules it follows. The schema is in API reference.
The problem
Section titled “The problem”A backup that you never restored is not proven. bret restores your backups on a schedule, checks the restored data, and tells you when the check fails.
The three objects
Section titled “The three objects”| Kind | Short name | Purpose | Who writes it |
|---|---|---|---|
RestoreCheck |
rcheck |
The check: a pod template that runs against restored data. Exit code 0 means pass. | You, once per app. |
RestoreTest |
rtest |
The schedule and policy: which backups, which check, when, how many retries. | You. |
Restore |
restore |
One restore attempt run: the native restore object plus the check pod. You create it by hand, or a RestoreTest creates it. |
You, or the operator. |
A typical setup has one RestoreCheck per application. It also has one RestoreTest for that
app, with one source per PVC.
The diagram shows how the objects refer to each other. Solid arrows create an object, dashed
arrows only name it. Objects in the namespace of the Restore get it as their owner, so deleting
the Restore deletes them. Objects in other namespaces (the Velero scratch namespace) are found by
name and label and removed by the bret.linogics.io/cleanup finalizer.
What the operator does, and what it does not do
Section titled “What the operator does, and what it does not do”It does:
- create the native restore object of the chosen tool (Velero
Restore, VolSyncReplicationDestination, or KopiurRestore), pointed at a scratch volume, - wait for that restore to finish,
- create the check pod from the check, with the restored volume mounted,
- take the check pod’s exit code as the verdict,
- write the result to
status, to Events, and to Prometheus metrics, - clean up pods and volumes, or keep them for debugging when you ask it to.
It does not:
- copy, deduplicate or store backup data,
- install Velero, VolSync or Kopiur, or configure their storage,
- read the check’s logs or parse its output. Only the exit code counts.
Providers
Section titled “Providers”| Provider | Backup the operator reads | Native object created | Restore done when |
|---|---|---|---|
kopiur (alpha) |
Snapshot, phase Succeeded; one PVC each |
kopiur.home-operations.com/v1alpha1 Restore |
status.phase is Completed and condition Ready is True |
volsync |
ReplicationSource, its status.lastSyncTime; one PVC each |
volsync.backube/v1alpha1 ReplicationDestination with a manual trigger, pinned with restoreAsOf |
status.latestImage.kind is PersistentVolumeClaim |
velero |
Backup in the Velero namespace, phase Completed; every PVC of the namespace |
velero.io/v1 Restore into a scratch namespace |
status.phase is Completed, PartiallyFailed, Failed or FailedValidation |
Every source names its sourcePVC, for all three. Setup, the namespaces each tool uses, and how
the backups are picked are on the tool pages: Kopiur,
VolSync, Velero.
Enable providers in the Helm chart with providers.<name>.enabled. Kopiur is on by
default. Velero and VolSync are off by default. A Restore or RestoreTest for a disabled
provider stops with reason ProviderUnsupported.
Namespaces:
- The operator watches all namespaces by default.
watchNamespacesin the chart values is a list. Empty means cluster-wide. The table shows what it limits.
| Mode | Controller cache | Pod and PVC rights | Velero rights |
|---|---|---|---|
Cluster-wide (watchNamespaces empty) |
All namespaces. | ClusterRole. |
ClusterRole, when Velero is on. |
watchNamespaces set |
Only those namespaces. | One Role and RoleBinding per listed namespace. |
None. Velero is off. |
watchNamespaces set, Velero on |
Restore, RestoreTest and RestoreCheck: only those namespaces. Pods and PVCs: all namespaces. |
ClusterRole, because the scratch namespaces are not watched. |
Role in providers.velero.namespace, even if it is not listed. |
- A
RestoreTestin a namespace that is not watched is ignored. The operator writes nothing to it. - Pods and volumes live in the namespace of the
RestoreorRestoreTest. For Velero, they live in the scratch namespace. - With Velero on, the operator can read and create Secrets and ConfigMaps in every namespace. It copies the ones a check names into the scratch namespace, which is not watched.
- Velero backups live in the Velero namespace (
veleroby default). The operator reads backup objects there. In namespaced mode, this is the one cross-namespace read it needs.
