From 5cb8c6b67af1fefc9b01a78e8160f4b2e73dff4b Mon Sep 17 00:00:00 2001 From: Jochen Mehlich Date: Sat, 24 Oct 2026 09:57:16 +0200 Subject: [PATCH] Optimiere docker-deploy.sh: Validierung, Lock, Symlink-Schutz, --no-cache optional Co-Authored-By: Claude Sonnet 5.5 --- docker-deploy.sh | 163 ++++++++++++++++++++++++++--------------------- 1 file changed, 90 insertions(+), 73 deletions(-) diff --git a/docker-deploy.sh b/docker-deploy.sh index 8a5d226..4846f0d 100644 --- a/docker-deploy.sh +++ b/docker-deploy.sh @@ -1,131 +1,148 @@ -#!/bin/bash -# /usr/local/bin/app-deploy.sh -set -euo pipefail +#!/usr/bin/env bash +# /usr/local/bin/docker-deploy.sh +# +# Docker-Compose-Wrapper für Funktions-User (gedacht für Aufruf per sudo). +set -Eeuo pipefail +IFS=$'\n\t' +export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" -DEPLOY_SUBDIR="its-deploy" -DEPLOY_GROUP="server_APPS_docker_compose" -ALLOWED_ACTIONS=("build" "up" "down" "restart" "logs" "pull" "deploy") +readonly SCRIPT_NAME="$(basename "$0")" +readonly DEPLOY_SUBDIR="its-deploy" +readonly DEPLOY_GROUP="server_APPS_docker_compose" +readonly ALLOWED_ACTIONS=(build up down restart logs pull deploy) # ── Hilfsfunktionen ────────────────────────────────────────────────────────── +log() { printf '[%(%Y-%m-%d %H:%M:%S)T] %s\n' -1 "$*"; } +die() { printf '❌ %s\n' "$*" >&2; exit 1; } + usage() { - echo "Verwendung: sudo $(basename "$0") " - echo "" - echo "Aktionen: ${ALLOWED_ACTIONS[*]}" - echo "" - echo "Beispiel: sudo $(basename "$0") func_123 deploy" + cat >&2 < [--no-cache] + +Aktionen: ${ALLOWED_ACTIONS[*]} +Optionen: --no-cache Build ohne Layer-Cache (nur build/deploy) + +Beispiel: sudo ${SCRIPT_NAME} func_123 deploy +EOF exit 1 } -is_allowed_action() { - local value="$1" - for item in "${ALLOWED_ACTIONS[@]}"; do - [[ "$item" == "$value" ]] && return 0 - done +in_array() { + local needle="$1"; shift + local item + for item in "$@"; do [[ "$item" == "$needle" ]] && return 0; done return 1 } -is_in_group() { - local user="$1" - local group="$2" - id -nG "$user" 2>/dev/null | tr ' ' '\n' | grep -qx "$group" +user_in_group() { + local -a groups + read -ra groups <<<"$(id -nG "$1")" + in_array "$2" "${groups[@]}" } -log() { - echo "[$(date '+%Y-%m-%d %H:%M:%S')] $*" +on_error() { + local rc=$? line=$1 + log "💥 Fehlgeschlagen (Exit $rc, Zeile $line): ${APP_USER:-?} ${ACTION:-?}" >&2 + exit "$rc" } +trap 'on_error $LINENO' ERR -# ── Argument-Validierung ───────────────────────────────────────────────────── -if [[ $# -lt 2 ]]; then - usage -fi +# ── Argumente ──────────────────────────────────────────────────────────────── +[[ $# -ge 2 && $# -le 3 ]] || usage APP_USER="$1" ACTION="$2" - -if ! id "$APP_USER" &>/dev/null; then - echo "❌ User '$APP_USER' existiert nicht auf diesem System" - exit 1 +NO_CACHE=() +if [[ "${3:-}" == "--no-cache" ]]; then + NO_CACHE=(--no-cache) +elif [[ -n "${3:-}" ]]; then + usage fi -if ! is_in_group "$APP_USER" "$DEPLOY_GROUP"; then - echo "❌ User '$APP_USER' ist nicht in Gruppe '$DEPLOY_GROUP'" - exit 1 +# ── Validierung ────────────────────────────────────────────────────────────── +[[ $EUID -eq 0 ]] || die "Muss als root laufen (sudo)" +[[ "$APP_USER" =~ ^[a-z_][a-z0-9_-]{0,31}$ ]] || die "Ungültiger Username: '$APP_USER'" +id "$APP_USER" &>/dev/null || die "User '$APP_USER' existiert nicht auf diesem System" +user_in_group "$APP_USER" "$DEPLOY_GROUP" || die "User '$APP_USER' ist nicht in Gruppe '$DEPLOY_GROUP'" +in_array "$ACTION" "${ALLOWED_ACTIONS[@]}" || die "Unbekannte Aktion: '$ACTION' (erlaubt: ${ALLOWED_ACTIONS[*]})" +if [[ ${#NO_CACHE[@]} -gt 0 && "$ACTION" != "build" && "$ACTION" != "deploy" ]]; then + die "--no-cache ist nur bei build/deploy sinnvoll" fi -if ! is_allowed_action "$ACTION"; then - echo "❌ Unbekannte Aktion: '$ACTION'" - echo " Erlaubt: ${ALLOWED_ACTIONS[*]}" - exit 1 -fi +command -v docker >/dev/null || die "docker nicht gefunden" +docker compose version &>/dev/null || die "Docker-Compose-Plugin nicht verfügbar" -# ── Pfad-Auflösung ─────────────────────────────────────────────────────────── -HOME_DIR=$(getent passwd "$APP_USER" | cut -d: -f6) -if [[ -z "$HOME_DIR" ]]; then - echo "❌ Home-Verzeichnis für '$APP_USER' nicht ermittelbar" - exit 1 -fi +# ── Pfade ──────────────────────────────────────────────────────────────────── +HOME_DIR="$(getent passwd "$APP_USER" | cut -d: -f6)" +[[ -n "$HOME_DIR" ]] || die "Home-Verzeichnis für '$APP_USER' nicht ermittelbar" + +# Symlink-Tricks verhindern: aufgelöster Pfad muss unter dem Home bleiben +APP_DIR="$(realpath -e -- "${HOME_DIR}/${DEPLOY_SUBDIR}" 2>/dev/null)" \ + || die "Verzeichnis nicht gefunden: ${HOME_DIR}/${DEPLOY_SUBDIR}" +HOME_REAL="$(realpath -e -- "$HOME_DIR")" +[[ "$APP_DIR" == "$HOME_REAL"/* ]] || die "Deploy-Verzeichnis liegt außerhalb des Home: $APP_DIR" -APP_DIR="${HOME_DIR}/${DEPLOY_SUBDIR}" COMPOSE_FILE="${APP_DIR}/docker-compose.yml" COMPOSE_OVERRIDE="${APP_DIR}/docker-compose.override.yml" +[[ -f "$COMPOSE_FILE" ]] || die "docker-compose.yml nicht gefunden: $COMPOSE_FILE" -if [[ ! -d "$APP_DIR" ]]; then - echo "❌ Verzeichnis nicht gefunden: $APP_DIR" - exit 1 -fi +# ── Nebenläufigkeit: pro User nur ein Lauf gleichzeitig ────────────────────── +exec 9>"/run/lock/${SCRIPT_NAME}.${APP_USER}.lock" +flock -n 9 || die "Für '$APP_USER' läuft bereits ein Deploy" -if [[ ! -f "$COMPOSE_FILE" ]]; then - echo "❌ docker-compose.yml nicht gefunden: $COMPOSE_FILE" - exit 1 -fi - -# ── Compose-Args aufbauen ──────────────────────────────────────────────────── +# ── Compose-Setup ──────────────────────────────────────────────────────────── +export COMPOSE_PROJECT_NAME="$APP_USER" COMPOSE_ARGS=(-f "$COMPOSE_FILE") if [[ -f "$COMPOSE_OVERRIDE" ]]; then COMPOSE_ARGS+=(-f "$COMPOSE_OVERRIDE") - log "📎 Override wird verwendet: $COMPOSE_OVERRIDE" + log "📎 Override: $COMPOSE_OVERRIDE" fi -# ── Prefix setzen ──────────────────────────────────────────────────────────── -export COMPOSE_PROJECT_NAME="$APP_USER" -log "🏷️ Project-Prefix: $COMPOSE_PROJECT_NAME" +compose() { docker compose "${COMPOSE_ARGS[@]}" "$@"; } -# ── Ausführung ─────────────────────────────────────────────────────────────── -log "🚀 User: $APP_USER | Pfad: $APP_DIR | Aktion: $ACTION" +log "🚀 Aufrufer: ${SUDO_USER:-root} | User: $APP_USER | Projekt: $COMPOSE_PROJECT_NAME | Pfad: $APP_DIR | Aktion: $ACTION" cd "$APP_DIR" +# Fehlerhafte Compose-Dateien früh abfangen (nicht bei down/logs) +case "$ACTION" in + build|up|restart|pull|deploy) + compose config --quiet || die "Compose-Konfiguration ungültig" + ;; +esac + +# ── Ausführung ─────────────────────────────────────────────────────────────── case "$ACTION" in build) - log "📦 Build starten..." - docker compose "${COMPOSE_ARGS[@]}" build --no-cache + log "📦 Build..." + compose build "${NO_CACHE[@]}" ;; up) log "▶️ Container starten..." - docker compose "${COMPOSE_ARGS[@]}" up -d + compose up -d --remove-orphans ;; down) log "⏹️ Container stoppen..." - docker compose "${COMPOSE_ARGS[@]}" down + compose down ;; restart) log "🔄 Container neu starten..." - docker compose "${COMPOSE_ARGS[@]}" restart + compose restart ;; logs) log "📋 Logs (letzte 100 Zeilen)..." - docker compose "${COMPOSE_ARGS[@]}" logs --tail=100 + compose logs --tail=100 ;; pull) log "⬇️ Images aktualisieren..." - docker compose "${COMPOSE_ARGS[@]}" pull + compose pull ;; deploy) - log "🚢 Full Deploy: pull → build → up..." - docker compose "${COMPOSE_ARGS[@]}" pull - docker compose "${COMPOSE_ARGS[@]}" build --no-cache - docker compose "${COMPOSE_ARGS[@]}" up -d + log "🚢 Deploy: pull → build → up..." + compose pull --ignore-buildable + compose build --pull "${NO_CACHE[@]}" + compose up -d --remove-orphans + compose ps ;; esac log "✅ Fertig: $APP_USER $ACTION" -