3 Commits
2 changed files with 296 additions and 73 deletions

No files matched your search

+204
View File
@@ -0,0 +1,204 @@
#!/usr/bin/env python3
"""Legt in authentik einen Deploy-User für ein Gitea-Repository an und hinterlegt
die Zugangsdaten als Gitea-Actions-Secrets/-Variablen."""
import argparse
import os
import re
import sys
from getpass import getpass
from urllib.parse import urlparse
import authentik_client
import requests
from authentik_client.rest import ApiException
DEFAULT_AUTHENTIK_URL = "https://auth.systems.cogsys.wiai.uni-bamberg.de/api/v3"
DEFAULT_GITEA_URL = "https://git.share-fix.de"
DEFAULT_DOCKER_GROUP = "server_APPS_docker_compose"
HOME_DIR_BASE = "/home"
USERNAME_RE = re.compile(r"^[a-z_][a-z0-9_-]{0,31}$")
# ── Gitea ────────────────────────────────────────────────────────────────────
class Gitea:
def __init__(self, base_url: str, token: str):
self.base = base_url.rstrip("/") + "/api/v1"
self.session = requests.Session()
self.session.headers["Authorization"] = f"token {token}"
def _request(self, method: str, path: str, **kwargs):
response = self.session.request(method, self.base + path, timeout=30, **kwargs)
response.raise_for_status()
return response
def get_repo(self, repo_path: str) -> dict:
print(f"Retrieving repository {repo_path}")
return self._request("GET", f"/repos/{repo_path}").json()
def set_secret(self, repo_path: str, key: str, value: str):
print(f"Setting secret {key} for {repo_path}")
self._request("PUT", f"/repos/{repo_path}/actions/secrets/{key}", json={"data": value})
def set_variable(self, repo_path: str, key: str, value: str):
print(f"Setting variable {key} for {repo_path}")
url = f"/repos/{repo_path}/actions/variables/{key}"
try:
self._request("PUT", url, json={"value": value})
except requests.HTTPError as e:
if e.response is None or e.response.status_code != 404:
raise
self._request("POST", url, json={"value": value})
def normalize_repo_path(raw: str, gitea_url: str) -> str:
"""Akzeptiert 'owner/repo', Web-URLs und Clone-URLs (mit/ohne .git)."""
raw = raw.strip()
if raw.startswith(("http://", "https://")):
raw = urlparse(raw).path
raw = raw.strip("/").removesuffix(".git")
if raw.count("/") != 1:
raise ValueError(f"Repository muss die Form 'owner/repo' haben, bekam: '{raw}'")
return raw
# ── authentik ────────────────────────────────────────────────────────────────
def authentik_get_group_by_name(client: authentik_client.CoreApi, name: str):
groups = client.core_groups_list(search=name)
for group in groups.results or []:
if group.name == name:
print(f"{name} group found: uuid={group.pk}")
return group
raise RuntimeError(f"Gruppe '{name}' nicht gefunden")
def authentik_create_user(client: authentik_client.CoreApi, username: str, home_directory: str, groups) -> str:
print(f"Creating user: {username}")
users = client.core_users_list(username=username)
if users.results:
print(f"User {username} already exists")
user = users.results[0]
else:
user = client.core_users_create(
user_request=authentik_client.UserRequest(
username=username,
name=username,
type=authentik_client.UserTypeEnum.SERVICE_ACCOUNT,
is_active=True,
path="goauthentik.io/service-accounts",
attributes={
"homeDirectory": home_directory,
"goauthentik.io/user/token-expires": False,
},
)
)
print(f"Adding user {username} to groups: {', '.join(g.name for g in groups)}")
for group in groups:
client.core_groups_add_user_create(
group_uuid=group.pk,
user_account_request=authentik_client.UserAccountRequest(pk=user.pk),
)
token_identifier = f"service-account-{username}-password"
if client.core_tokens_list(identifier=token_identifier).results:
print(f"Token {token_identifier} already exists")
else:
print(f"Creating token for user {username}")
client.core_tokens_create(
authentik_client.TokenRequest(
identifier=token_identifier,
user=user.pk,
intent=authentik_client.IntentEnum.APP_PASSWORD,
expiring=False,
)
)
return client.core_tokens_view_key_retrieve(token_identifier).key
# ── CLI ──────────────────────────────────────────────────────────────────────
def parse_args() -> argparse.Namespace:
p = argparse.ArgumentParser(description="Deploy-User für ein Gitea-Repository in authentik anlegen")
p.add_argument("--server", required=True,
help="Zielserver; bestimmt die Gruppe server_<SERVER>_ssh_access (z. B. APPS -> server_APPS_ssh_access)")
p.add_argument("--project-path", help="Gitea-Repository: 'owner/repo' oder URL")
p.add_argument("--username", help="Username des Deploy-Users (Standard: deploy_<owner>_<repo>)")
p.add_argument("--docker-group", default=DEFAULT_DOCKER_GROUP,
help=f"Zusätzliche Gruppe für Docker-Deploys (Standard: {DEFAULT_DOCKER_GROUP})")
p.add_argument("--no-docker-group", action="store_true", help="Docker-Deploy-Gruppe nicht zuweisen")
p.add_argument("--authentik-url", default=DEFAULT_AUTHENTIK_URL)
p.add_argument("--authentik-token", default=os.environ.get("AUTHENTIK_TOKEN"),
help="Bearer-Token für die authentik-API (oder Env AUTHENTIK_TOKEN)")
p.add_argument("--gitea-url", default=DEFAULT_GITEA_URL)
p.add_argument("--gitea-token", default=os.environ.get("GITEA_TOKEN"),
help="Gitea-Access-Token mit Scope write:repository (oder Env GITEA_TOKEN)")
p.add_argument("--dry-run", action="store_true", help="Nichts anlegen, nur ausgeben")
p.add_argument("-y", "--yes", action="store_true", help="Bestätigungsabfrage überspringen")
return p.parse_args()
def make_username(repo_path: str) -> str:
name = "deploy_" + re.sub(r"[^a-z0-9]+", "_", repo_path.lower()).strip("_")
return name[:32].rstrip("_")
def main() -> int:
args = parse_args()
if not re.fullmatch(r"[A-Za-z0-9_-]+", args.server):
sys.exit(f"Ungültiger Servername: '{args.server}'")
if not args.dry_run and not args.authentik_token:
print(f"Authentik-API-Token erstellen unter {args.authentik_url.split('/api')[0]}/if/user/#/settings;page=page-tokens")
args.authentik_token = getpass("Enter authentik token: ")
if not args.gitea_token:
print(f"Gitea-Token erstellen unter {args.gitea_url}/user/settings/applications (Scope: write:repository)")
args.gitea_token = getpass("Enter gitea token: ")
if not args.project_path:
args.project_path = input("Enter Gitea repository (owner/repo): ")
gitea = Gitea(args.gitea_url, args.gitea_token)
repo_path = normalize_repo_path(args.project_path, args.gitea_url)
repo = gitea.get_repo(repo_path)
repo_path = repo["full_name"] # kanonische Schreibweise
username = args.username or make_username(repo_path)
if not USERNAME_RE.match(username):
sys.exit(f"Ungültiger Username '{username}' (erlaubt: ^[a-z_][a-z0-9_-]{{0,31}}$)")
home_dir = f"{HOME_DIR_BASE}/{username}"
group_names = [f"server_{args.server}_ssh_access"]
if not args.no_docker_group:
group_names.append(args.docker_group)
print(f"\nRepository: {repo_path} (id {repo['id']})")
print(f"Deploy-User: {username}")
print(f"Home-Verz.: {home_dir}")
print(f"Gruppen: {', '.join(group_names)}")
print(f"Gitea-Secrets: deploy_user, deploy_pass")
if args.dry_run:
print("\n[dry-run] Es wurde nichts angelegt.")
return 0
if not args.yes and input("\nBestätigen? Fortfahren? [y/N] ").lower() != "y":
return 0
configuration = authentik_client.Configuration(host=args.authentik_url, access_token=args.authentik_token)
with authentik_client.ApiClient(configuration) as api_client:
core_api = authentik_client.CoreApi(api_client)
try:
groups = [authentik_get_group_by_name(core_api, n) for n in group_names]
key = authentik_create_user(core_api, username, home_dir, groups)
except (ApiException, RuntimeError) as e:
sys.exit(f"Fehler in authentik: {e}")
try:
gitea.set_variable(repo_path, "deploy_user", username)
gitea.set_secret(repo_path, "deploy_pass", key)
except requests.RequestException as e:
sys.exit(f"Fehler in Gitea: {e}")
print(f"\nFertig: {username} für {repo_path}")
return 0
if __name__ == "__main__":
sys.exit(main())
+92 -73
View File
@@ -1,131 +1,150 @@
#!/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") <username> <action>"
echo ""
echo "Aktionen: ${ALLOWED_ACTIONS[*]}"
echo ""
echo "Beispiel: sudo $(basename "$0") func_123 deploy"
cat >&2 <<EOF
Verwendung: sudo ${SCRIPT_NAME} <username> <action> [--cache]
Aktionen: ${ALLOWED_ACTIONS[*]}
Optionen: --cache Build mit Layer-Cache (Standard bei build/deploy: --no-cache)
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=(--no-cache)
USE_CACHE=false
if [[ "${3:-}" == "--cache" ]]; then
NO_CACHE=()
USE_CACHE=true
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 $USE_CACHE && [[ "$ACTION" != "build" && "$ACTION" != "deploy" ]]; then
die "--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"