notebookvb

MongoDBBackup/mongodbbackup_with_gzip.sh

@@ -1,43 +1,86 @@
 #!/bin/bash
-set -x
+# ==============================================================================
+# MongoDBBackupWithGzip — záloha MongoDB databází na Tower
+# ==============================================================================
+#
+# CO DĚLÁ:
+#   Zálohuje vybrané MongoDB databáze pomocí mongodump --archive --gzip.
+#   Každá databáze dostane vlastní adresář s timestampem, výstup jde přímo
+#   ze stdout Docker kontejneru na disk hostitele (žádný volume mount).
+#
+# TECHNICKÉ DETAILY:
+#   - mongodump --archive: binární formát archivu (jeden soubor na DB)
+#   - --gzip: komprese přímo v mongodump, není třeba pipe přes gzip
+#   - --numParallelCollections=4: paralelní dump kolekcí = rychlejší záloha
+#   - Záloha zachovává: indexy, metadata, validátory, všechny kolekce
+#   - MongoDB na Tower nemá autentizaci — žádné heslo není potřeba
+#
+# SCHEDULE:
+#   Unraid User Script "MongoDBBackupWithGzip" — daily (4:40 ráno)
+#
+# STRUKTURA ZÁLOHY:
+#   /mnt/user/Backup/Critical/MongoDBBackup/tower/
+#     admin/
+#       YYYY-MM-DD_HHMM/
+#         admin.archive.gz    ← binární archiv databáze
+#         admin.err           ← dočasný soubor chyb (smazán při úspěchu)
+#     edc/
+#       YYYY-MM-DD_HHMM/
+#         edc.archive.gz
+#
+# ROTACE:
+#   Dvoustupňová — nejprve maž dle stáří (KEEP_DAYS), pak ořízni na KEEP_COUNT.
+#   To zaručí min. KEEP_COUNT záloh i pokud skript chvíli neběžel.
+#
+# RESTORE:
+#   Viz mongodbrestore_from_backup.sh — stream ze souboru přes docker exec -i
+# ==============================================================================
+set -x  # debug výstup — každý příkaz se vypíše před spuštěním (viditelné v logu Unraid)
 
-# ==========================================================
-# CONFIGURATION
-# ==========================================================
-CONTAINER_NAME="MongoDB"
-MONGO_HOST="localhost"
-MONGO_PORT="27017"
+# ==============================================================================
+# KONFIGURACE
+# ==============================================================================
+CONTAINER_NAME="MongoDB"    # název Docker kontejneru na Tower
+MONGO_HOST="localhost"       # MongoDB naslouchá uvnitř kontejneru na localhost
+MONGO_PORT="27017"           # výchozí MongoDB port
 
-UNRAID_NAME="tower"
-BASE_PATH="/mnt/user/Backup/Critical/MongoDBBackup"
+UNRAID_NAME="tower"          # název serveru — součást cesty zálohy (pro případ rozšíření na více serverů)
+BASE_PATH="/mnt/user/Backup/Critical/MongoDBBackup"  # kořenový adresář všech MongoDB záloh
 
-KEEP_DAYS=3
-KEEP_COUNT=3   # počet posledních záloh k udržení (mimo time-based)
+KEEP_DAYS=3    # zálohy starší než 3 dny se smažou v prvním průchodu rotace
+KEEP_COUNT=3   # z toho co zbyde, ponech vždy alespoň poslední 3 zálohy
 
-# Databases to back up (+ admin DB pro credentials a roles)
+# Databáze k zálohování:
+#   admin — systémová DB, obsahuje uživatele, role a credentials (i přes to, že auth je vypnutá)
+#   edc   — hlavní aplikační databáze
 WHAT_TO_BACKUP=("admin" "edc")
 
-# ==========================================================
+# ==============================================================================
 # START
-# ==========================================================
+# ==============================================================================
 echo "Starting scheduled backup for: ${WHAT_TO_BACKUP[*]}"
 START_TS=$(date '+%Y-%m-%d %H:%M:%S')
 
+# Iterujeme přes každou databázi zvlášť — každá dostane vlastní adresář a archiv.
+# Důvod: při obnovení lze vybrat konkrétní DB bez nutnosti rozpakovat celý dump.
 for DB_NAME in "${WHAT_TO_BACKUP[@]}"; do
     echo "------------------------------------------"
     echo "Processing database: $DB_NAME"
 
-    DATE=$(date +%Y-%m-%d_%H%M)
-    FINAL_PATH="$BASE_PATH/$UNRAID_NAME/$DB_NAME/$DATE"
+    DATE=$(date +%Y-%m-%d_%H%M)                          # timestamp v minutách — pro přehlednost v názvech adresářů
+    FINAL_PATH="$BASE_PATH/$UNRAID_NAME/$DB_NAME/$DATE"   # cílový adresář pro tuto zálohu
     mkdir -p "$FINAL_PATH"
 
-    DUMP_FILE="$FINAL_PATH/$DB_NAME.archive.gz"
-    ERR_FILE="$FINAL_PATH/$DB_NAME.err"
+    DUMP_FILE="$FINAL_PATH/$DB_NAME.archive.gz"  # výsledný archiv
+    ERR_FILE="$FINAL_PATH/$DB_NAME.err"          # sem jde stderr mongodump
 
-    # ======================================================
-    # DUMP + GZIP (streamuje přes stdout, nepotřebuje volume mount)
-    # Zachovává: indexy, metadata, validators, all collections
-    # ======================================================
+    # --------------------------------------------------------------------------
+    # DUMP + GZIP
+    # docker exec spustí mongodump uvnitř kontejneru.
+    # stdout (archiv) přesměrujeme do souboru na hostiteli — žádný volume mount.
+    # stderr (logy mongodump) jde do .err souboru pro pozdější analýzu.
+    # --archive bez cílového souboru = stream na stdout
+    # --------------------------------------------------------------------------
     docker exec "$CONTAINER_NAME" mongodump \
         --host="$MONGO_HOST" \
         --port="$MONGO_PORT" \
@@ -49,9 +92,14 @@ for DB_NAME in "${WHAT_TO_BACKUP[@]}"; do
 
     EXIT_CODE=$?
 
-    # ======================================================
-    # VALIDATION
-    # ======================================================
+    # --------------------------------------------------------------------------
+    # VALIDACE VÝSLEDKU
+    # Tři podmínky pro úspěch:
+    #   1. EXIT_CODE=0 — mongodump skončil bez chyby
+    #   2. -s "$DUMP_FILE" — archiv existuje a není prázdný
+    #   3. ! -s "$ERR_FILE" — .err soubor je prázdný (žádné chybové hlášky)
+    # Pokud všechny platí, .err smažeme. Jinak ho ponecháme pro diagnostiku.
+    # --------------------------------------------------------------------------
     if [ $EXIT_CODE -eq 0 ] && [ -s "$DUMP_FILE" ] && [ ! -s "$ERR_FILE" ]; then
         echo "SUCCESS: $DB_NAME backed up successfully"
         echo "Dump size: $(du -h "$DUMP_FILE" | cut -f1)"
@@ -65,17 +113,24 @@ for DB_NAME in "${WHAT_TO_BACKUP[@]}"; do
         [ -s "$ERR_FILE" ] && cat "$ERR_FILE" || echo "  (no stderr output)"
     fi
 
-    # ======================================================
-    # CLEANUP OLD BACKUPS
-    # 1. Smaž zálohy starší než KEEP_DAYS dnů
-    # 2. Z toho co zbyde, ponech jen posledních KEEP_COUNT
-    # ======================================================
+    # --------------------------------------------------------------------------
+    # ROTACE STARÝCH ZÁLOH — dvoustupňová
+    #
+    # Krok 1: Smaž adresáře starší než KEEP_DAYS dní.
+    #   -mindepth 1 -maxdepth 1: jen přímé podadresáře (ne rekurzivně)
+    #   -type d: pouze adresáře
+    #   -mtime +N: starší než N dní
+    #
+    # Krok 2: Z toho co zbyde, ponech jen posledních KEEP_COUNT.
+    #   ls -td: seřadit adresáře dle času (nejnovější první)
+    #   tail -n +N: přeskoč prvních N-1 (to jsou ty které chceme ponechat)
+    #   xargs -r rm -rf: smaž zbytek (jen pokud existuje vstup — -r zabrání prázdnému xargs)
+    # --------------------------------------------------------------------------
     echo "Cleaning up old backups for $DB_NAME..."
     find "$BASE_PATH/$UNRAID_NAME/$DB_NAME" \
         -mindepth 1 -maxdepth 1 -type d -mtime +$KEEP_DAYS \
         -exec rm -rf {} \;
 
-    # Nech jen posledních KEEP_COUNT záloh
     ls -td "$BASE_PATH/$UNRAID_NAME/$DB_NAME"/*/ 2>/dev/null \
         | tail -n +$((KEEP_COUNT + 1)) \
         | xargs -r rm -rf