DevOps Wissensdatenbank
DevOps Wissensdatenbank

Sichern und Wiederherstellen Ihrer Jenkins-Instanz

Schützen Sie Ihre CI/CD-Pipeline, indem Sie die Jenkins-Sicherung und -Wiederherstellung meistern. Dieser Leitfaden bietet ein Tutorial auf Expertenniveau mit Schritt-für-Schritt-Anleitung zur zuverlässigsten Backup-Strategie: der Dateisystemmethode. Erfahren Sie, wie Sie kritische Daten im Verzeichnis `%s` identifizieren und archivieren, wobei der Schwerpunkt auf Konfigurationen, Jobs und Sicherheitsschlüsseln liegt, während große Build-Artefakte ausgeschlossen werden. Wir behandeln auch die wesentlichen Schritte zur Wiederherstellung einer Instanz, einschließlich wichtiger Korrekturen von Dateiberechtigungen, um eine schnelle und nahtlose Notfallwiederherstellung für Ihre Jenkins-Umgebung zu gewährleisten.

37 Aufrufe

Jenkins-Instanz sichern und wiederherstellen

Jenkins dient als zentrale Automatisierungsdrehscheibe für Continuous Integration und Continuous Delivery (CI/CD). Die Konfigurationsdaten – einschließlich Job-Definitionen, Benutzerzugangsdaten, Plugin-Einstellungen und Build-Verlauf – stellen eine erhebliche Investition des Unternehmens dar. Der Verlust dieser Daten aufgrund von Hardwarefehlern, Konfigurationsfehlern oder Migrationen kann Entwicklungspipelines vollständig zum Erliegen bringen.

Dieser umfassende Leitfaden beschreibt die wesentlichen Komponenten einer robusten Jenkins-Sicherungsstrategie, wobei der Schwerpunkt auf der äußerst zuverlässigen Filesystem-Snapshot-Methode liegt. Wir werden Schritt-für-Schritt-Anleitungen zur sicheren Sicherung Ihrer Instanz und das entsprechende Verfahren zur nahtlosen Wiederherstellung bereitstellen, um Geschäftskontinuität und Seelenfrieden zu gewährleisten.

Das Herzstück verstehen: Das $JENKINS_HOME-Verzeichnis

Jede Jenkins-Instanz basiert auf einem einzigen Stammverzeichnis, das als $JENKINS_HOME bezeichnet wird. Dieses Verzeichnis enthält alle Konfigurationsdateien, Plugins, Protokolle und Job-Daten. Jenkins zu sichern bedeutet im Wesentlichen, den Inhalt dieses Verzeichnisses zu sichern.

Je nach Installationsmethode (z. B. Linux-Paket, Docker-Container) variiert der Speicherort von $JENKINS_HOME typischerweise:

  • Linux (Paketinstallation): /var/lib/jenkins
  • Docker: Oft auf ein Volume gemountet, z. B. /var/jenkins_home
  • Standalone JAR: Das Verzeichnis, in dem der Jenkins-Prozess gestartet wurde, sofern nicht über Umgebungsvariablen angegeben.

Identifizierung kritischer Datenkomponenten

Das Sichern des gesamten $JENKINS_HOME-Verzeichnisses ist der einfachste Ansatz, kann aber zu extrem großen Archiven führen, wenn der Build-Verlauf und Workspace-Daten enthalten sind. Für eine schnelle und effiziente Notfallwiederherstellungssicherung müssen Sie sicherstellen, dass die folgenden Verzeichnisse und Dateien erfasst werden:

Komponente Pfad innerhalb von $JENKINS_HOME Zweck
Globale Konfiguration config.xml Primäre Konfigurationsdatei für die Jenkins-Root-Instanz.
Job-Definitionen jobs/ Enthält Unterverzeichnisse für jeden konfigurierten Job, jedes mit seiner eigenen config.xml.
Benutzer und Zugangsdaten users/ und credentials.xml Benutzerkonten, Sicherheitseinstellungen und gespeicherte Geheimnisse.
Sicherheitsschlüssel secrets/ Verschlüsselungsschlüssel, die für die Entschlüsselung sensibler Daten wie gespeicherter Zugangsdaten unerlässlich sind.
Plugin-Liste plugins/ Enthält die .hpi-Dateien für alle installierten Plugins.
Node-Definitionen nodes/ Konfigurationen für alle verbundenen Build-Agenten (falls definiert).

Methode 1: Das Dateisystem-Backup (Empfohlen)

Die zuverlässigste Methode zum Sichern von Jenkins besteht darin, ein konsistentes, komprimiertes Archiv der notwendigen Dateien zu erstellen, während der Dienst kurzzeitig gestoppt ist.

Schritt 1: Jenkins-Dienst stoppen

Um die Datenkonsistenz zu gewährleisten und teilweise Dateischreibvorgänge während des Sicherungsprozesses zu verhindern, muss der Jenkins-Prozess angehalten werden. Wenn der Dienst nicht gestoppt wird, besteht das Risiko einer unvollständigen oder beschädigten Sicherung.

# Für Systeme mit systemd (die meisten modernen Linux-Distributionen)
sudo systemctl stop jenkins

# Oder, für Systeme mit dem service-Befehl
sudo service jenkins stop

Schritt 2: Das Backup-Archiv erstellen

Navigieren Sie zum übergeordneten Verzeichnis von $JENKINS_HOME und verwenden Sie tar, um ein komprimiertes Archiv zu erstellen. Es wird dringend empfohlen, die großen Build-Artefakte auszuschließen, um Speicherplatz und Zeit zu sparen.

Angenommen, $JENKINS_HOME ist /var/lib/jenkins:

JENKINS_HOME="/var/lib/jenkins"
BACKUP_TARGET="/mnt/backups/jenkins"
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
ARCHIVE_NAME="jenkins_backup_${TIMESTAMP}.tar.gz"

# Erstellen Sie das Zielverzeichnis, falls es nicht existiert
mkdir -p $BACKUP_TARGET

# Erstellen Sie das Archiv, unter Ausschluss des Build-Verlaufs und der Workspaces
sudo tar -czvf $BACKUP_TARGET/$ARCHIVE_NAME \n    --exclude="${JENKINS_HOME}/workspace" \n    --exclude="${JENKINS_HOME}/caches" \n    --exclude="${JENKINS_HOME}/jobs/*/builds" \n    $JENKINS_HOME

Tipp: Build-Verlauf einschließen

Wenn das Beibehalten des Build-Verlaufs (jobs/*/builds) entscheidend ist, können Sie das entsprechende --exclude-Flag entfernen. Seien Sie jedoch auf Archivgrößen vorbereitet, die potenziell Hunderte von Gigabytes erreichen können.

Schritt 3: Verifizieren und extern speichern

Sobald das Archiv erstellt wurde, testen Sie dessen Integrität und übertragen Sie es sofort an einen externen, geografisch getrennten Speicherort (z. B. S3-Bucket, Netzlaufwerk), um sich vor einem standortweiten Ausfall zu schützen.

Schritt 4: Jenkins neu starten

sudo systemctl start jenkins

Methode 2: Verwendung des Jenkins Backup Plugins (Teillösung)

Obwohl Plugins wie ThinBackup oder Backup Plugin existieren, erfassen sie oft nur Konfigurationsdateien (config.xml) und können große Dateien oder alle notwendigen Sicherheitselemente möglicherweise nicht robust handhaben. Diese eignen sich im Allgemeinen nur zur Sicherung von Job-Konfigurationen und sollten nicht für eine vollständige, sichere Disaster-Recovery-Strategie herangezogen werden.

Wiederherstellung Ihrer Jenkins-Instanz

Die Wiederherstellung beinhaltet das Kopieren der gesicherten Daten in das $JENKINS_HOME-Verzeichnis des Zielcomputers und die Sicherstellung korrekter Dateiberechtigungen vor dem Starten des Dienstes.

Schritt 1: Zielumgebung vorbereiten

Stellen Sie sicher, dass auf dem Zielsystem (oder dem reparierten System) Jenkins installiert ist, halten Sie den Dienst jedoch gestoppt.

sudo systemctl stop jenkins

Schritt 2: Vorhandene Jenkins-Daten löschen (Optional, aber empfohlen)

Wenn Sie auf einem Computer wiederherstellen, der zuvor Jenkins gehostet hat, löschen Sie den vorhandenen $JENKINS_HOME-Inhalt, um sicherzustellen, dass die Umgebung sauber ist.

# Vorsicht bei der Verwendung des Befehls 'rm -rf'!
sudo rm -rf /var/lib/jenkins/*

Schritt 3: Das Backup-Archiv extrahieren

Kopieren Sie das komprimierte Archiv (jenkins_backup_latest.tar.gz) auf den Zielcomputer und entpacken Sie es in das $JENKINS_HOME-Verzeichnis. Das Flag -C gibt das Zielverzeichnis für die Extraktion an.

# Angenommen, das Archiv befindet sich in /tmp und JENKINS_HOME ist /var/lib/jenkins
sudo tar -xzvf /tmp/jenkins_backup_latest.tar.gz -C /var/lib/

# Hinweis: Wenn der tar-Befehl das übergeordnete Verzeichnis im Archiv enthielt, passen Sie den Pfad an.
# Das Ergebnis sollte sein, dass der Inhalt des Archivs den Inhalt von /var/lib/jenkins ersetzt.

Schritt 4: Berechtigungen überprüfen und korrigieren

Dies ist der kritischste Schritt nach der Wiederherstellung. Wenn die Dateiberechtigung falsch ist, kann Jenkins nicht gestartet werden oder nicht sicher betrieben werden. Sie müssen den Besitz rekursiv auf den Benutzer und die Gruppe setzen, unter der der Jenkins-Dienst ausgeführt wird (oft jenkins:jenkins).

JENKINS_HOME="/var/lib/jenkins"
JENKINS_USER="jenkins"
JENKINS_GROUP="jenkins"

sudo chown -R $JENKINS_USER:$JENKINS_GROUP $JENKINS_HOME
sudo chmod -R 755 $JENKINS_HOME

Schritt 5: Jenkins starten und verifizieren

Starten Sie den Dienst und überwachen Sie die Protokolle, um einen erfolgreichen Start sicherzustellen.

sudo systemctl start jenkins

# Startup-Protokolle überwachen
sudo tail -f /var/log/jenkins/jenkins.log

Nach erfolgreichem Start überprüfen Sie, ob alle Jobs, Benutzer und installierten Plugins vorhanden sind und korrekt funktionieren.

Best Practices für automatisierte Backups

Um über manuelle Backups hinauszugehen, implementieren Sie Automatisierungen mithilfe von Systemwerkzeugen und externem Konfigurationsmanagement.

1. Cron-Jobs nutzen

Planen Sie das Backup-Skript (Schritte 1 und 2 aus Methode 1) so, dass es täglich oder nächtlich mithilfe von cron oder einem ähnlichen Scheduler ausgeführt wird. Stellen Sie sicher, dass der Cron-Job als Benutzer mit entsprechenden Berechtigungen zum Stoppen und Starten des Jenkins-Dienstes sowie zum Lesen und Schreiben in das $JENKINS_HOME-Verzeichnis ausgeführt wird.

2. Konfiguration als Code (CasC)

Erwägen Sie die Einführung von Jenkins Configuration as Code (CasC). CasC definiert Jenkins-Einstellungen, Jobs und Plugins mithilfe deklarativer YAML-Dateien. Durch das Speichern dieser YAML-Dateien in einem separaten Quellcode-Repository (wie Git) wird Ihre Konfiguration portabel und versionskontrolliert, was die grundlegende Backup-Anforderung drastisch vereinfacht.

Warnung: Zugangsdaten sichern

Stellen Sie beim Wiederherstellen einer Instanz sicher, dass das Verzeichnis secrets/ vorhanden und korrekt ist. Wenn Jenkins die Schlüssel zum Verschlüsseln von Zugangsdaten (wie API-Schlüssel oder Passwörter) nicht finden kann, werden diese Zugangsdaten unbrauchbar und müssen manuell neu eingegeben werden.