Doku/Backup Docker

Aus XccesS Wiki
Zur Navigation springen Zur Suche springen

Docker-Backups im Homelab

Diese Seite beschreibt die komplette Einrichtung und Funktionsweise des Scripts backup_docker_rsync.sh, mit dem alle Docker-Volumes, Compose-Dateien und die Docker-Daemon-Konfiguration täglich auf das QNAP-NAS gesichert werden.

Repository

/usr/local/sbin/backup_docker_rsync.sh (lokal)

Zielpfad NAS

/mnt/Backup/Docker/YYYY-MM-DD-HHMM ⇒ Symlink latest

1 Voraussetzungen

  • **Ubuntu 22.04 LTS** (Root-Zugriff)
  • NAS-Share unter /mnt/Backup gemountet
    • Empfohlen**: NFS (+ no_root_squash).

SMB/CIFS funktioniert mit den rsync-Optionen --no-owner --no-group.

  • Pakete:
apt install rsync jq

2 Backupscript

#!/usr/bin/env bash
# ==========================================================================
#  backup_docker_rsync.sh  –  Docker-Volumes & Compose sichern (rsync)
#  › paust nur "running" Container   › unpaust garantiert wieder
# ==========================================================================

set -euo pipefail
shopt -s nullglob

# ─── Konfiguration ────────────────────────────────────────────────────────
SNAPROOT="/mnt/Backup/Docker"
RETENTION_DAYS=7
COMPOSE_BASE="/data/compose"
INITIALLY_PAUSED=$(docker ps -q --filter status=paused)

# rsync-Grundoptionen (SMB/NFS ohne chown-Erlaubnis → kein owner/group)
RSYNC_BASE="-a --no-owner --no-group --numeric-ids --delete --link-dest"
# -------------------------------------------------------------------------

timestamp() { date +'%F-%H%M'; }
log()       { printf '\e[36m[%s] %s\e[0m\n' "$(date +'%F %T')" "$*"; }

SNAPDIR="$SNAPROOT/$(timestamp)"
LINKDEST="$SNAPROOT/latest"

# ─── Cleanup-Funktion (immer ausführen) ───────────────────────────────────
TMP=""
PAUSED=""
cleanup() {
  [[ -n "$PAUSED" ]] && docker unpause $PAUSED 2>/dev/null || true
  [[ -n "$TMP"    ]] && rm -rf "$TMP"
}
trap cleanup EXIT

# ─── 1) Metadaten-Dump ────────────────────────────────────────────────────
TMP=$(mktemp -d /tmp/docker_dump.XXXX)
log "Erzeuge Metadaten-Dump in $TMP"

docker info             > "$TMP/docker-info.txt"
docker images --digests > "$TMP/images.txt"
docker ps -a            > "$TMP/containers.txt"
docker inspect $(docker ps -aq) > "$TMP/containers.json" 2>/dev/null || true

mkdir -p "$TMP/compose"
if [[ -d "$COMPOSE_BASE" ]]; then
  find "$COMPOSE_BASE" -type f -iname 'docker-compose*.yml' \
       -exec cp --parents {} "$TMP/compose" \;
fi
# plus dynamisch laufende Stacks
while read -r DIR; do
  [[ -d $DIR ]] || continue
  find "$DIR" -type f -iname 'docker-compose*.yml' \
       -exec cp --parents {} "$TMP/compose" \;
done < <(docker ps --format '{{.Label "com.docker.compose.project.working_dir"}}' | sort -u)

# ─── 2) Nur RUNNING-Container pausieren ──────────────────────────────────
RUNNING=$(docker ps --filter status=running -q)
if [[ -n "$RUNNING" ]]; then
  log "Pausiere $(echo "$RUNNING" | wc -w) laufende Container"
  # shellcheck disable=SC2086
  docker pause $RUNNING || true      # Fehler ignorieren
  PAUSED="$RUNNING"
fi
# ─── 3) rsync-Snapshot ────────────────────────────────────────────────────
log "Starte rsync in $SNAPDIR"
mkdir -p "$SNAPDIR"

# Link-Dest nur setzen, wenn latest existiert
[[ -e "$LINKDEST" ]] && LD=(--link-dest="$LINKDEST") || LD=()

rsync -a --no-owner --no-group --numeric-ids --delete "${LD[@]}" \
      /var/lib/docker/volumes/          "$SNAPDIR/volumes"

rsync -a --no-owner --no-group --numeric-ids --delete "${LD[@]}" \
      /etc/docker/                      "$SNAPDIR/etc-docker"

# systemd-Drop-Ins nur sichern, falls Verzeichnis existiert
if [[ -d /etc/systemd/system/docker.service.d ]]; then
  rsync -a --no-owner --no-group --numeric-ids --delete "${LD[@]}" \
        /etc/systemd/system/docker.service.d/ "$SNAPDIR/docker-systemd"
fi

rsync -a --no-owner --no-group "$TMP/" "$SNAPDIR/metadata"

# ─── 4) „latest“-Symlink & Retention ─────────────────────────────────────
ln -snf "$SNAPDIR" "$SNAPROOT/latest"

log "Lösche Snapshots älter als $RETENTION_DAYS Tage"
find "$SNAPROOT" -maxdepth 1 -type d -name '20*' -mtime +"$RETENTION_DAYS" \
     -exec rm -rf {} +
# … rsync und Retention bereits gelaufen …

# 6) latest-Symlink aktualisieren
ln -snf "$SNAPDIR" "$SNAPROOT/latest"

# 7) Leserechte für SMB-User
log "Setze lesbare Rechte für SMB-Nutzer"
find "$SNAPDIR" -type d -exec chmod 755 {} +
find "$SNAPDIR" -type f -exec chmod 644 {} +
# unpause alles, was jetzt pausiert ist
docker unpause $(docker ps -q --filter status=paused) || true
# und PAUSE-Status von vorher wiederherstellen
for c in $INITIALLY_PAUSED; do
    docker pause "$c" || true
done

log "Backup abgeschlossen"

2.1 Wichtige Variablen im Kopfbereich

Variable Standardwert Bedeutung
SNAPROOT /mnt/Backup/Docker Ablageort der Snapshots
RETENTION_DAYS 7 Aufbewahrung (ältere Snapshots werden gelöscht)
COMPOSE_BASE /data/compose Oberordner der Compose-Stacks

3 Cron Job (täglich 02:30 Uhr)

# crontab -e   (als root)
30 2 * * * /usr/local/sbin/backup_docker_rsync.sh \
           >> /var/log/backup_docker.log 2>&1
  • Logging: Alle Ausgaben in /var/log/backup_docker.log.
  • Bei Fehlercodes ≠0 wird der Cron-MTA eine Mail an root schicken (sofern konfiguriert).

4 Funktionsweise

  1. **Metadaten-Dump** (Docker info, Container-/Image-Listen, Compose-YAMLs).
  2. **Nur noch laufende Container** werden kurz mit docker pause eingefroren.
  3. **rsync Snapshot**
  * Hard-Links via --link-dest → jede Sicherung „Vollkopie“, aber nur Deltas belegen Platz.  
  * Ohne -o -g ⇒ kompatibel mit SMB/NFS-Shares.
  1. **Unpause** der zuvor laufenden Container (Cleanup-Trap gewährleistet dies selbst bei Abbruch).
  2. **latest-Symlink** wird aktualisiert, alte Snapshots nach RETENTION_DAYS gelöscht.
  3. **Rechte 755/644** auf neuem Snapshot → Windows-Benutzer können per SMB browsen.

5 Snapshot-Struktur

/mnt/Backup/Docker/
└── 2025-06-06-0230/
    ├── volumes/                # kompletter Inhalt von /var/lib/docker/volumes
    ├── etc-docker/             # /etc/docker
    ├── docker-systemd/         # systemd-Drop-Ins (falls vorhanden)
    └── metadata/
        ├── docker-info.txt
        ├── images.txt
        ├── containers.txt
        └── compose/…           # alle docker-compose*.yml
latest -> 2025-06-06-0230

6 Manueller Testlauf

/usr/local/sbin/backup_docker_rsync.sh
echo $?
# → 0  = Erfolg

7 Wiederherstellung

Kurzfassung für „latest“: 

restore_docker_rsync.sh  -s latest

8 Troubleshooting

Meldung Ursache / Lösung
--link-dest arg does not exist Erster Lauf → ignorieren.
Operation not permitted (chown) SMB-Share ohne Chown-Rechte → OK; Daten wurden trotzdem kopiert.
Container bleiben paused Script vor v1.1; aktualisieren ODER manuell 
 docker unpause $(docker ps -q --filter status=paused)
Windows kann nicht lesen Fs-Rechte → Script ≥v1.2 setzt 755/644 
 oder Share mit noperm mounten.

9 Versionshistorie

Datum Version Änderung
2025-06-06 1.2 Rechtefix (755/644), robustes Unpause, Link-Dest-Check
2025-06-05 1.1 Pausiere nur laufende Container, Cleanup-Trap
2025-06-04 1.0 Erste produktive Version

Seite zuletzt aktualisiert: 06 Juni 2025

Abgerufen von „https://wiki.fam-puls.de/index.php?title=Doku/Backup_Docker&oldid=367“