mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-10-20 01:43:25 +00:00
fix(backup): mount the zfs snapshot itself so a container can read it
The zfs snapshot was read through <subject>/.zfs/snapshot/<name>. The kernel automounts that directory through a usermode helper that runs in the host's mount namespace, so a containerised baudolo never sees the mount and finds no snapshot. The snapshot is now mounted explicitly at <subject>/.baudolo-<tag>, beside where btrfs carves its own, and removed in order: umount, rmdir, zfs destroy. A failed mount destroys the snapshot at once instead of leaking one per run. The e2e suite could not reach this code at all: zpool create on the /img file failed with "no such pool or dataset", because the kernel opens vdevs from a taskq thread that resolves paths in the host's root, where the container's /img does not exist. The pool now sits on a loop device, whose /dev/loopN node the kernel creates on the host as well, and it is destroyed on exit once this script created it, since a pool is kernel-wide. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -58,27 +58,50 @@ def _resolver(subject: str, root: str) -> Callable[[str], str]:
|
|||||||
return resolve
|
return resolve
|
||||||
|
|
||||||
|
|
||||||
|
def _remove(
|
||||||
|
root: str, commands: list[list[str]], run: Callable[[list[str]], list[str]]
|
||||||
|
) -> None:
|
||||||
|
try:
|
||||||
|
for command in commands:
|
||||||
|
run(command)
|
||||||
|
except BackupError as error:
|
||||||
|
# Raising here would also mask whatever the body raised.
|
||||||
|
print(f"WARNING: {root} could not be removed: {error}", flush=True)
|
||||||
|
|
||||||
|
|
||||||
def _btrfs(
|
def _btrfs(
|
||||||
subject: str, name: str, run: Callable[[list[str]], list[str]]
|
subject: str, name: str, run: Callable[[list[str]], list[str]]
|
||||||
) -> tuple[str, list[str]]:
|
) -> tuple[str, list[list[str]]]:
|
||||||
# The snapshot goes inside the subject, never beside it: the kernel rejects
|
# The snapshot goes inside the subject, never beside it: the kernel rejects
|
||||||
# a snapshot whose destination is on another filesystem, which is exactly
|
# a snapshot whose destination is on another filesystem, which is exactly
|
||||||
# what the parent directory is when the subject is a mountpoint of its own.
|
# what the parent directory is when the subject is a mountpoint of its own.
|
||||||
target = str(Path(os.path.abspath(subject)) / f".{name}") # noqa: PTH100 - see _resolver
|
target = str(Path(os.path.abspath(subject)) / f".{name}") # noqa: PTH100 - see _resolver
|
||||||
run(["btrfs", "subvolume", "snapshot", "-r", subject, target])
|
run(["btrfs", "subvolume", "snapshot", "-r", subject, target])
|
||||||
return target, ["btrfs", "subvolume", "delete", target]
|
return target, [["btrfs", "subvolume", "delete", target]]
|
||||||
|
|
||||||
|
|
||||||
def _zfs(
|
def _zfs(
|
||||||
subject: str, name: str, run: Callable[[list[str]], list[str]]
|
subject: str, name: str, run: Callable[[list[str]], list[str]]
|
||||||
) -> tuple[str, list[str]]:
|
) -> tuple[str, list[list[str]]]:
|
||||||
output = run(["zfs", "list", "-H", "-o", "name", subject])
|
output = run(["zfs", "list", "-H", "-o", "name", subject])
|
||||||
dataset = (output[0] if output else "").strip()
|
dataset = (output[0] if output else "").strip()
|
||||||
if not dataset:
|
if not dataset:
|
||||||
raise SnapshotError(f"no zfs dataset is mounted at {subject}")
|
raise SnapshotError(f"no zfs dataset is mounted at {subject}")
|
||||||
run(["zfs", "snapshot", f"{dataset}@{name}"])
|
snapshot = f"{dataset}@{name}"
|
||||||
root = str(Path(subject) / ".zfs" / "snapshot" / name)
|
# Exception: mounted here rather than read through .zfs/snapshot, which the
|
||||||
return root, ["zfs", "destroy", f"{dataset}@{name}"]
|
# kernel automounts via a usermode helper in the host's mount namespace,
|
||||||
|
# so a containerised run never sees it.
|
||||||
|
root = str(Path(os.path.abspath(subject)) / f".{name}") # noqa: PTH100 - see _resolver
|
||||||
|
run(["zfs", "snapshot", snapshot])
|
||||||
|
remove = [["zfs", "destroy", snapshot]]
|
||||||
|
try:
|
||||||
|
run(["mkdir", root])
|
||||||
|
remove.insert(0, ["rmdir", root])
|
||||||
|
run(["mount", "-t", "zfs", snapshot, root])
|
||||||
|
except BaseException:
|
||||||
|
_remove(root, remove, run)
|
||||||
|
raise
|
||||||
|
return root, [["umount", root], *remove]
|
||||||
|
|
||||||
|
|
||||||
_CREATE = {"btrfs": _btrfs, "zfs": _zfs}
|
_CREATE = {"btrfs": _btrfs, "zfs": _zfs}
|
||||||
@@ -169,8 +192,4 @@ def volume_snapshot(
|
|||||||
try:
|
try:
|
||||||
yield _resolver(subject, root)
|
yield _resolver(subject, root)
|
||||||
finally:
|
finally:
|
||||||
try:
|
_remove(root, remove, run)
|
||||||
run(remove)
|
|
||||||
except BackupError as error:
|
|
||||||
# Raising here would also mask whatever the body raised.
|
|
||||||
print(f"WARNING: {root} could not be removed: {error}", flush=True)
|
|
||||||
|
|||||||
@@ -36,9 +36,14 @@ ZFS_READY = "{ [ -c /dev/zfs ] || modprobe zfs 2>/dev/null; }; [ -c /dev/zfs ]"
|
|||||||
def mount_script(fstype: str) -> str:
|
def mount_script(fstype: str) -> str:
|
||||||
"""Build a filesystem on a loop device and carve out the snapshot subject."""
|
"""Build a filesystem on a loop device and carve out the snapshot subject."""
|
||||||
if fstype == "zfs":
|
if fstype == "zfs":
|
||||||
|
# Exception: a loop device, not the /img file, because the kernel opens
|
||||||
|
# vdevs from a taskq thread that resolves paths in the host's root.
|
||||||
|
# The pool is kernel-wide, so it is destroyed on exit, but only once
|
||||||
|
# this script created it.
|
||||||
return (
|
return (
|
||||||
f"{PACKAGES} && {ZFS_READY} && truncate -s 400M /img "
|
f"{PACKAGES} && {ZFS_READY} && truncate -s 400M /img && {ATTACH} "
|
||||||
"&& zpool create -m none baudolo /img "
|
'&& zpool create -m none baudolo "$LOOP" '
|
||||||
|
"&& trap 'zpool destroy -f baudolo; losetup -d \"$LOOP\"' EXIT "
|
||||||
"&& zfs create -o mountpoint=/subject/docker baudolo/docker"
|
"&& zfs create -o mountpoint=/subject/docker baudolo/docker"
|
||||||
)
|
)
|
||||||
return (
|
return (
|
||||||
|
|||||||
@@ -21,6 +21,14 @@ class Runner:
|
|||||||
return []
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
class Unmountable(Runner):
|
||||||
|
def __call__(self, command: list[str]) -> list[str]:
|
||||||
|
result = super().__call__(command)
|
||||||
|
if command[0] == "mount":
|
||||||
|
raise BackupError("permission denied")
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
class TestBtrfs(unittest.TestCase):
|
class TestBtrfs(unittest.TestCase):
|
||||||
def test_it_creates_a_read_only_snapshot_inside_the_subject(self) -> None:
|
def test_it_creates_a_read_only_snapshot_inside_the_subject(self) -> None:
|
||||||
run = Runner()
|
run = Runner()
|
||||||
@@ -95,12 +103,55 @@ class TestZfs(unittest.TestCase):
|
|||||||
run.calls[-1], ["zfs", "destroy", "tank/docker@baudolo-20260731"]
|
run.calls[-1], ["zfs", "destroy", "tank/docker@baudolo-20260731"]
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_it_maps_a_volume_path_through_the_dot_zfs_directory(self) -> None:
|
def test_it_mounts_the_snapshot_inside_the_subject(self) -> None:
|
||||||
|
run = self._run()
|
||||||
|
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run):
|
||||||
|
pass
|
||||||
|
self.assertIn(
|
||||||
|
[
|
||||||
|
"mount",
|
||||||
|
"-t",
|
||||||
|
"zfs",
|
||||||
|
"tank/docker@baudolo-20260731",
|
||||||
|
"/var/lib/docker/.baudolo-20260731",
|
||||||
|
],
|
||||||
|
run.calls,
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_it_maps_a_volume_path_into_the_mounted_snapshot(self) -> None:
|
||||||
run = self._run()
|
run = self._run()
|
||||||
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run) as resolve:
|
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run) as resolve:
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
resolve("/var/lib/docker/volumes/postgres_data/_data"),
|
resolve("/var/lib/docker/volumes/postgres_data/_data"),
|
||||||
"/var/lib/docker/.zfs/snapshot/baudolo-20260731/volumes/postgres_data/_data",
|
"/var/lib/docker/.baudolo-20260731/volumes/postgres_data/_data",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_it_unmounts_before_it_destroys(self) -> None:
|
||||||
|
run = self._run()
|
||||||
|
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run):
|
||||||
|
pass
|
||||||
|
self.assertEqual(
|
||||||
|
run.calls[-3:],
|
||||||
|
[
|
||||||
|
["umount", "/var/lib/docker/.baudolo-20260731"],
|
||||||
|
["rmdir", "/var/lib/docker/.baudolo-20260731"],
|
||||||
|
["zfs", "destroy", "tank/docker@baudolo-20260731"],
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_a_failed_mount_leaves_no_snapshot_behind(self) -> None:
|
||||||
|
run = Unmountable({"zfs list": ["tank/docker"]})
|
||||||
|
with (
|
||||||
|
self.assertRaises(BackupError),
|
||||||
|
volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run),
|
||||||
|
):
|
||||||
|
pass
|
||||||
|
self.assertEqual(
|
||||||
|
run.calls[-2:],
|
||||||
|
[
|
||||||
|
["rmdir", "/var/lib/docker/.baudolo-20260731"],
|
||||||
|
["zfs", "destroy", "tank/docker@baudolo-20260731"],
|
||||||
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_an_unmounted_dataset_is_an_error(self) -> None:
|
def test_an_unmounted_dataset_is_an_error(self) -> None:
|
||||||
|
|||||||
Reference in New Issue
Block a user