Files
cozystack/examples/backups/redis
Aleksei Sviridkin ead7048b35 refactor(backups): define the walkthrough wait helpers once
Every backup walkthrough carried its own wait_for_field, and most their
own wait_hr_ready and wait_deleted: twelve, eight and two copies, which
had already drifted into five, three and two bodies. A fix made in one
copy did not reach the others, and a diagnostics change carried by hand
between two of them once went into the wrong function and was caught
only by reading the diff.

The helpers now live in examples/backups/_lib/wait-helpers.sh, sourced
by each walkthrough's 00-helpers.sh. Where copies differed, the shared
body keeps the diagnostics any of them had: wait_for_field leaves
kubectl's stderr attached, and wait_hr_ready prints the conditions and
history dump on Stalled or timeout. Call sites and budgets are unchanged.

A new unit test fails when any walkthrough defines one of these helpers
again, which replaces the byte-identity pin between copies.

Assisted-by: LLM
Signed-off-by: Aleksei Sviridkin <f@lex.la>
2026-10-01 02:21:01 +03:00
..

Redis backup / restore demo

Proves an honest data round-trip for a Cozystack-managed Redis (spotahome RedisFailover) through the platform system bucket: a sentinel marker key is written, backed up, and asserted to return byte-for-byte after both restore flows.

The spotahome operator ships no backup CRD, so the strategy.backups.cozystack.io/Redis driver runs a one-shot Job that dumps an RDB snapshot to S3 and replays it on restore (RDB → RESP via redis-cli --pipe). This is the cozy-default-redis strategy the cozy-default BackupClass binds Redis to.

Prerequisites

  • A Cozystack cluster with the backupstrategy-controller running and its system bucket provisioned, so cozy-default (and the cozy-default-redis strategy) are present and the controller can project cozy-backups-creds into the app namespace.
  • kubectl pointed at the cluster; the tenant namespace defaults to tenant-test (override with NAMESPACE).

Run

./run-all.sh            # steps 01-04: provision, back up, restore in-place, restore to-copy
SKIP_RESTORE=1 ./run-all.sh   # stop after a successful backup
./cleanup.sh            # remove everything the demo created

Or step through them:

Step Script What it does
01 01-create-redis.sh Provision Redis, seed the marker on the master
02 02-create-backupjob.sh BackupJob (backupClassName: cozy-default) → RDB dump to S3
03 03-restore-in-place.sh Corrupt the marker, RestoreJob back into the source, assert it returns
04 04-restore-to-copy.sh RestoreJob with targetApplicationRef into a fresh copy, assert the marker landed

Notes

  • Master discovery goes through the operator's sentinel Service rfs-redis-<name> (master name mymaster), so writes and the dump/replay always target the current master even after a failover.
  • Faithful restore. The restore loads the RDB into a throwaway local redis and replays what a real engine emits, so all logical databases (SELECT per db), stream last-ids and consumer groups survive — a merge onto db0 does not happen.
  • Endpoint TLS. The projected endpoint in cozy-backups-creds is always scheme-stripped, so the strategy prepends https:// and the transport is always TLS (there is no http:// path). It verifies against the image's system CA store by default — the platform bucket's ACME cert needs nothing more — honours a private CA from backupStorage.endpointCASecretName when set, and skips verification only when backupStorage.insecureSkipTLSVerify: true is set explicitly.
  • No PITR. RDB is a discrete snapshot; the engine ships no continuous log to replay to an arbitrary time, so spec.options.recoveryTime is not supported (the etcd-like case).