Quickstart
This tutorial takes you from an empty cluster to a restore test that runs on a schedule. It uses
WordPress + MariaDB with two PVCs: html (the docroot) and mysql (the database). It works the
same with Kopiur, VolSync or Velero. Only the backup step differs. It is on the page of your tool.
- Install the operator.
- Deploy the example app and back it up, as your tool’s page shows.
- Run one
Restoreby hand, and prove that the check can fail. - Create a
RestoreTestwith a schedule, and run it on demand. - Read the result.
Time: about 30 minutes, excluding image pulls.
Before you start
Section titled “Before you start”You need:
- A Kubernetes cluster, version 1.29 or newer, with a CSI driver that supports volume snapshots.
kubectlandhelm3.14 or newer.- One backup tool installed, and an S3 bucket for it. Pick one in providers/: Kopiur, VolSync or Velero.
- A checkout of this repository, for the files in examples/.
Step 1: Install the operator
Section titled “Step 1: Install the operator”helm install bret-operator oci://ghcr.io/linogics/charts/bret-operator \ --version 0.1.0 \ --namespace bret-operator-system \ --create-namespace \ --set providers.volsync.enabled=true \ --set providers.velero.enabled=trueKopiur is on by default. Enable only the tools you run. Check the installation:
kubectl -n bret-operator-system get deploykubectl get crd restores.bret.linogics.io restoretests.bret.linogics.io restorechecks.bret.linogics.ioThe deployment should show 1/1 ready. The three CRDs should be listed. More in
Installation.
Step 2: Deploy the app and back it up
Section titled “Step 2: Deploy the app and back it up”Follow steps 1 and 2 on the page of your tool. They deploy the app into the namespace
wordpress, seed a canary, and take one backup of both PVCs:
The example also applies the check, checks/wordpress/restorecheck.yaml. It mounts both restored volumes, starts MariaDB next to WordPress, and checks that the canary post matches the canary file. For your own app, write a check as described in Write a check. Only cluster admins should create checks, because a check runs a pod with your chosen image.
Step 3: Restore by hand
Section titled “Step 3: Restore by hand”Replace <tool> with kopiur, volsync or velero:
kubectl apply -f examples/<tool>/restore.yaml -n wordpresskubectl -n wordpress wait --for=jsonpath='{.status.phase}'=Succeeded restore/wordpress-manual --timeout=15mThe operator restores both PVCs into scratch volumes, runs the check once against both, and sets
the phase. Then prove that the check can fail: the negative Restore restores only html.
kubectl apply -f examples/<tool>/negative/restore.yaml -n wordpresskubectl -n wordpress wait --for=jsonpath='{.status.phase}'=Failed restore/wordpress-negative --timeout=15mA check that always passes is not a check. To run a check without the operator, against PVCs you restored yourself, see Test a check by hand.
Step 4: Create a restore test
Section titled “Step 4: Create a restore test”kubectl apply -f examples/<tool>/restoretest.yaml -n wordpresskubectl -n wordpress get restoretests# NAME PROVIDER LAST NEXT AGE# wordpress kopiur Succeeded 2026-11-17T03:17:00Z 2dThe test runs every night, after each new backup, and on demand. Each run picks the newest backup of every PVC. How each tool’s backups are picked: “How bret picks backups” on the tool page.
With triggers.manual: true, set a new value on the annotation to start a run now:
kubectl -n wordpress annotate restoretest wordpress \ bret.linogics.io/run-now="$(date +%s)" --overwriteStep 5: Read the result
Section titled “Step 5: Read the result”- Status:
kubectl -n wordpress get restoretest wordpress -o yamlshowsstatus.lastRunwithresult,timeandreason. - Events:
kubectl -n wordpress get events --field-selector involvedObject.kind=RestoreTest - Metrics: the operator exposes Prometheus metrics on port 8443 (see Installation). Metric names may change before v1.
If a run failed and keepOnFailure is true, the failed pod, its PVCs and the restore objects
stay. Read the pod logs first. Then delete them.
Clean up
Section titled “Clean up”kubectl delete namespace wordpresshelm uninstall bret-operator -n bret-operator-systemDelete the backups with your tool. Keep the CRDs if you plan to return. See Installation for how to remove them.
Next steps
Section titled “Next steps”- Write a check for your own app: Write a check.
- Set up schedules, retries and keep-on-failure: Schedule restore tests.
- Apps with a database and files: Data and database.
- Something broke: Failure reasons.
