mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-01 12:34:50 +00:00
feat(backup): capture volumes from a filesystem snapshot
Backing up a live volume with rsync copies a moving target: a database
written to mid-copy lands on disk in a state no engine ever committed.
Stopping the container avoids that at the cost of downtime.
A snapshot removes both. `--snapshot {btrfs,zfs}` with `--snapshot-subject`
freezes the docker root once per run, and every volume copy is then read
from that frozen tree while the containers keep serving. A restore of such
a copy is an ordinary crash recovery, which every supported engine performs
on its own at startup.
An unsupported filesystem or an unknown snapshot kind fails loudly rather
than degrading to a live copy, since a silent fallback would return exactly
the torn backup the mode exists to prevent. `--shutdown` is rejected
alongside `--snapshot` instead of being ignored: under a snapshot no
container is ever stopped, so accepting the flag would promise downtime
semantics the run does not deliver.
Copies out of a snapshot skip rsync's --checksum verification. The source
is immutable for the lifetime of the copy, so size-and-mtime cannot race,
and dropping the second full read roughly halves the I/O per volume.
backup/app.py grew past what one module could carry and is split into
layout, policy and dumps along the lines it already had internally.
Tests: unit coverage for the new snapshot, layout, policy, volume and cli
units; e2e cases drive real btrfs, zfs and ext4 filesystems on loop devices
in a privileged container, including a MariaDB that is written to across
the snapshot and must recover from the restored copy without losing a
committed row. CI installs zfs and sets E2E_REQUIRE_FILESYSTEMS so a
missing kernel module fails the build instead of silently skipping a
filesystem.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
86
src/baudolo/backup/snapshot.py
Normal file
86
src/baudolo/backup/snapshot.py
Normal file
@@ -0,0 +1,86 @@
|
||||
"""Capture every volume from one atomic filesystem snapshot.
|
||||
|
||||
Copying a live tree file by file cannot produce a point in time: a database can
|
||||
write between two files and leave a control file and its write-ahead log
|
||||
disagreeing, which no recovery can repair. A snapshot freezes the whole subject
|
||||
at once, so a database reads it as a crash and replays its log - a case it is
|
||||
built for. That also removes the reason to stop containers at all.
|
||||
|
||||
The snapshot kind is stated by the caller rather than probed, because falling
|
||||
back to a live copy when a probe is inconclusive would hand out backups that
|
||||
look consistent and are not.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from collections.abc import Callable, Iterator
|
||||
from contextlib import contextmanager
|
||||
|
||||
from .shell import execute_shell_command
|
||||
|
||||
KINDS = ("btrfs", "zfs")
|
||||
|
||||
|
||||
|
||||
class SnapshotError(RuntimeError):
|
||||
"""A snapshot could not be created, resolved or removed."""
|
||||
|
||||
|
||||
def _resolver(subject: str, root: str) -> Callable[[str], str]:
|
||||
def resolve(path: str) -> str:
|
||||
relative = os.path.relpath(os.path.abspath(path), os.path.abspath(subject))
|
||||
if relative.startswith(".."):
|
||||
raise SnapshotError(f"{path} lies outside the snapshot subject {subject}")
|
||||
return os.path.join(root, relative) if relative != "." else root
|
||||
|
||||
return resolve
|
||||
|
||||
|
||||
def _btrfs(subject: str, name: str, run: Callable[[str], list[str]]) -> tuple[str, str]:
|
||||
target = os.path.join(os.path.dirname(os.path.abspath(subject)), f".{name}")
|
||||
run(f"btrfs subvolume snapshot -r {subject} {target}")
|
||||
return target, f"btrfs subvolume delete {target}"
|
||||
|
||||
|
||||
def _zfs(subject: str, name: str, run: Callable[[str], list[str]]) -> tuple[str, str]:
|
||||
output = run(f"zfs list -H -o name {subject}")
|
||||
dataset = (output[0] if output else "").strip()
|
||||
if not dataset:
|
||||
raise SnapshotError(f"no zfs dataset is mounted at {subject}")
|
||||
run(f"zfs snapshot {dataset}@{name}")
|
||||
root = os.path.join(subject, ".zfs", "snapshot", name)
|
||||
return root, f"zfs destroy {dataset}@{name}"
|
||||
|
||||
|
||||
_CREATE = {"btrfs": _btrfs, "zfs": _zfs}
|
||||
|
||||
|
||||
@contextmanager
|
||||
def volume_snapshot(
|
||||
kind: str,
|
||||
subject: str,
|
||||
tag: str,
|
||||
run: Callable[[str], list[str]] = execute_shell_command,
|
||||
) -> Iterator[Callable[[str], str]]:
|
||||
"""Yield a resolver mapping a path under ``subject`` into a snapshot of it.
|
||||
|
||||
Args:
|
||||
kind: ``btrfs`` or ``zfs``; the caller states it, nothing is probed.
|
||||
subject: the btrfs subvolume or zfs dataset mountpoint holding the
|
||||
volumes, e.g. ``/var/lib/docker``.
|
||||
tag: unique suffix for the snapshot name, e.g. the backup timestamp.
|
||||
run: shell runner, injected so the mechanics are testable.
|
||||
|
||||
Raises:
|
||||
SnapshotError: the kind is unknown, or the snapshot cannot be created.
|
||||
"""
|
||||
create = _CREATE.get(kind)
|
||||
if create is None:
|
||||
raise SnapshotError(f"unknown snapshot kind {kind!r}; expected one of {KINDS}")
|
||||
|
||||
root, remove = create(subject, f"baudolo-{tag}", run)
|
||||
try:
|
||||
yield _resolver(subject, root)
|
||||
finally:
|
||||
run(remove)
|
||||
Reference in New Issue
Block a user