Centro di Conoscenza DevOps
Centro di Conoscenza DevOps

Come eseguire il backup e ripristinare la tua istanza Jenkins

Proteggi la tua pipeline CI/CD padroneggiando il backup e il ripristino di Jenkins. Questa guida fornisce un tutorial passo passo di livello esperto sulla strategia di backup più affidabile: il metodo del filesystem. Scopri come identificare e archiviare dati critici all'interno della directory `$JENKINS_HOME`, concentrandoti su configurazioni, job e chiavi di sicurezza escludendo artefatti di build di grandi dimensioni. Copriamo anche i passaggi essenziali per ripristinare un'istanza, incluse correzioni cruciali dei permessi dei file, garantendo un ripristino di emergenza rapido e senza interruzioni per il tuo ambiente Jenkins.

42 visualizzazioni

Come eseguire il backup e ripristinare la tua istanza Jenkins

Jenkins funge da hub di automazione centrale per l'Integrazione Continua e la Consegna Continua (CI/CD). I dati di configurazione, incluse le definizioni dei job, le credenziali utente, le impostazioni dei plugin e la cronologia delle build, rappresentano un investimento organizzativo significativo. La perdita di questi dati a causa di guasti hardware, errori di configurazione o migrazione può bloccare completamente le pipeline di sviluppo.

Questa guida completa descrive i componenti essenziali di una strategia di backup robusta per Jenkins, concentrandosi sul metodo altamente affidabile dello snapshot del filesystem. Forniremo istruzioni passo passo per eseguire il backup sicuro della tua istanza e la procedura corrispondente per ripristinarla senza interruzioni, garantendo la continuità aziendale e la tranquillità.

Comprensione del Nucleo: La directory $JENKINS_HOME

Ogni istanza Jenkins si basa su un'unica directory radice, nota come $JENKINS_HOME. Questa directory contiene tutti i file di configurazione, i plugin, i log e i dati dei job. Eseguire il backup di Jenkins significa fondamentalmente eseguire il backup del contenuto di questa directory.

A seconda del metodo di installazione (ad esempio, pacchetto Linux, container Docker), la posizione di $JENKINS_HOME varia tipicamente:

  • Linux (Installazione tramite pacchetto): /var/lib/jenkins
  • Docker: Spesso montata su un volume, ad esempio /var/jenkins_home
  • JAR autonomo: La directory da cui è stato avviato il processo Jenkins, a meno che non sia specificata tramite variabili d'ambiente.

Identificazione dei Componenti Dati Critici

Sebbene eseguire il backup dell'intera directory $JENKINS_HOME sia l'approccio più semplice, può portare ad archivi estremamente grandi se vengono inclusi la cronologia delle build e i dati dell'area di lavoro. Per un backup rapido ed efficiente per il ripristino di emergenza, è necessario assicurarsi che le seguenti directory e file vengano acquisiti:

Componente Percorso all'interno di $JENKINS_HOME Scopo
Configurazione Globale config.xml File di configurazione principale per l'istanza radice di Jenkins.
Definizioni dei Job jobs/ Contiene sottodirectory per ogni job configurato, ognuna con il proprio config.xml.
Utenti e Credenziali users/ e credentials.xml Account utente, impostazioni del realm di sicurezza e segreti memorizzati.
Chiavi di Sicurezza secrets/ Chiavi di crittografia essenziali per decrittografare dati sensibili come le credenziali memorizzate.
Elenco Plugin plugins/ Contiene i file .hpi per tutti i plugin installati.
Definizioni Nodi nodes/ Configurazioni per tutti gli agenti di build connessi (se definiti).

Metodo 1: Il Backup del Filesystem (Consigliato)

Il metodo più affidabile per eseguire il backup di Jenkins è creare un archivio coerente e compresso dei file necessari mentre il servizio viene momentaneamente arrestato.

Passo 1: Arrestare il Servizio Jenkins

Per garantire la coerenza dei dati e prevenire scritture parziali dei file durante il processo di backup, il processo Jenkins deve essere interrotto. La mancata interruzione del servizio comporta il rischio di un backup incompleto o corrotto.

# Per i sistemi che utilizzano systemd (la maggior parte delle distribuzioni Linux moderne)
sudo systemctl stop jenkins

# Oppure, per i sistemi che utilizzano il comando service
sudo service jenkins stop

Passo 2: Creare l'Archivio di Backup

Navigare nella directory padre di $JENKINS_HOME e utilizzare tar per creare un archivio compresso. È altamente consigliabile escludere gli artefatti di build di grandi dimensioni per risparmiare spazio e tempo.

Supponendo che $JENKINS_HOME sia /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"

# Creare la directory di destinazione se non esiste
mkdir -p $BACKUP_TARGET

# Creare l'archivio, escludendo cronologia build e aree di lavoro
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

Suggerimento: Inclusione della Cronologia Build

Se la conservazione della cronologia delle build (jobs/*/builds) è fondamentale, è possibile rimuovere il flag --exclude corrispondente. Tuttavia, prepararsi a dimensioni dell'archivio che potrebbero raggiungere centinaia di gigabyte.

Passo 3: Verificare e Archiviare Offsite

Una volta creato l'archivio, testarne l'integrità e trasferirlo immediatamente su una posizione di archiviazione esterna e geograficamente separata (ad esempio, bucket S3, unità di rete) per proteggersi da guasti a livello di sito.

Passo 4: Riavviare Jenkins

sudo systemctl start jenkins

Metodo 2: Utilizzo del Plugin di Backup di Jenkins (Soluzione Parziale)

Sebbene esistano plugin come ThinBackup o Backup Plugin, spesso acquisiscono solo i file di configurazione (config.xml) e potrebbero non gestire in modo robusto file di grandi dimensioni o tutti gli elementi di sicurezza necessari. Questi sono generalmente adatti per eseguire il backup solo delle configurazioni dei job e non dovrebbero essere considerati per una strategia di ripristino di emergenza completa e sicura.

Ripristino della tua Istanza Jenkins

Il ripristino comporta la copia dei dati di backup nella directory $JENKINS_HOME della macchina di destinazione e la verifica della corretta proprietà dei file prima di avviare il servizio.

Passo 1: Preparare l'Ambiente di Destinazione

Assicurarsi che il sistema di destinazione (o il sistema riparato) abbia Jenkins installato, ma mantenere il servizio arrestato.

sudo systemctl stop jenkins

Passo 2: Cancellare i Dati Jenkins Esistenti (Opzionale ma Consigliato)

Se si sta ripristinando su una macchina che ospitava precedentemente Jenkins, cancellare il contenuto esistente di $JENKINS_HOME per garantire un ambiente pulito.

# Usare con cautela il comando 'rm -rf'!
sudo rm -rf /var/lib/jenkins/*

Passo 3: Estrarre l'Archivio di Backup

Copiare l'archivio compresso (jenkins_backup_latest.tar.gz) sulla macchina di destinazione ed estrarlo nella directory $JENKINS_HOME. Il flag -C specifica la directory di destinazione per l'estrazione.

# Supponendo che l'archivio sia in /tmp e JENKINS_HOME sia /var/lib/jenkins
sudo tar -xzvf /tmp/jenkins_backup_latest.tar.gz -C /var/lib/

# Nota: Se il comando tar ha incluso la directory padre nell'archivio, regolare il percorso.
# Il risultato dovrebbe essere il contenuto dell'archivio che sostituisce il contenuto di /var/lib/jenkins

Passo 4: Verificare e Correggere i Permessi

Questo è il passaggio più critico dopo il ripristino. Se la proprietà dei file non è corretta, Jenkins non si avvierà o non funzionerà in modo sicuro. È necessario impostare la proprietà in modo ricorsivo sull'utente e sul gruppo con cui viene eseguito il servizio Jenkins (spesso 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

Passo 5: Avviare Jenkins e Verificare

Avviare il servizio e monitorare i log per garantire un avvio riuscito.

sudo systemctl start jenkins

# Monitorare i log di avvio
sudo tail -f /var/log/jenkins/jenkins.log

All'avvio riuscito, verificare che tutti i job, gli utenti e i plugin installati siano presenti e funzionino correttamente.

Best Practice per i Backup Automatizzati

Per andare oltre i backup manuali, implementare l'automazione utilizzando strumenti di sistema e la gestione della configurazione esterna.

1. Sfruttare i Cron Job

Programmare lo script di backup (Passaggi 1 e 2 del Metodo 1) per l'esecuzione giornaliera o notturna utilizzando cron o uno scheduler simile. Assicurarsi che il cron job venga eseguito come utente con le autorizzazioni appropriate per arrestare e avviare il servizio Jenkins e leggere/scrivere nella directory $JENKINS_HOME.

2. Configuration as Code (CasC)

Considerare l'adozione di Jenkins Configuration as Code (CasC). CasC definisce le impostazioni di Jenkins, i job e i plugin utilizzando file YAML dichiarativi. Memorizzando questi file YAML in un repository di controllo della sorgente separato (come Git), la configurazione diventa portatile e versionata, semplificando drasticamente il requisito di backup principale.

Avviso: Protezione delle Credenziali

Durante il ripristino di un'istanza, assicurarsi che la directory secrets/ sia presente e corretta. Se Jenkins non riesce a trovare le chiavi utilizzate per crittografare le credenziali (come chiavi API o password), tali credenziali diventeranno inutilizzabili e dovranno essere reinserite manualmente.