Backup and restore strategies in Jenkins - Commands & Configuration

Introduction

Backing up Jenkins means saving its important data so you can recover it if something breaks. Restoring means using that saved data to bring Jenkins back to a working state. This helps avoid losing jobs, settings, and plugins.

Before upgrading Jenkins to a new version to avoid losing data if the upgrade fails

After creating or changing important jobs or configurations to keep a safe copy

When moving Jenkins to a new server or environment

If Jenkins crashes or data gets corrupted and you need to recover quickly

To keep a history of Jenkins state for auditing or compliance

Commands

This command creates a compressed backup file of the Jenkins home directory, which contains all jobs, plugins, and configurations. We use the current date in the filename to keep backups organized.

Terminal

tar -czf jenkins_backup_$(date +%F).tar.gz /var/lib/jenkins

Expected Output

No output (command runs silently)

→

-c - Create a new archive

→

-z - Compress the archive using gzip

→

-f - Specify the filename of the archive

This command lists the backup file with details like size and date to confirm the backup was created successfully.

Terminal

ls -lh jenkins_backup_2024-06-01.tar.gz

Expected Output

-rw-r--r-- 1 user user 150M Jun  1 12:00 jenkins_backup_2024-06-01.tar.gz

→

-l - Show detailed file information

→

-h - Show file sizes in human-readable format

Stop the Jenkins service before restoring to avoid conflicts or data corruption during the restore process.

Terminal

sudo systemctl stop jenkins

Expected Output

No output (command runs silently)

Extract the backup archive to the Jenkins home directory to restore all jobs, plugins, and settings.

Terminal

sudo tar -xzf jenkins_backup_2024-06-01.tar.gz -C /var/lib/jenkins

Expected Output

No output (command runs silently)

→

-x - Extract files from the archive

→

-z - Decompress gzip archive

→

-f - Specify the archive filename

→

-C - Change to this directory before extracting

Start the Jenkins service again after restoring the backup to resume normal operation.

Terminal

sudo systemctl start jenkins

Expected Output

No output (command runs silently)

Check the status of Jenkins to make sure it is running properly after the restore.

Terminal

sudo systemctl status jenkins

Expected Output

● jenkins.service - Jenkins Continuous Integration Server

   Loaded: loaded (/lib/systemd/system/jenkins.service; enabled; vendor preset: enabled)

   Active: active (running) since Sat 2024-06-01 12:05:00 UTC; 10s ago

 Main PID: 1234 (java)

    Tasks: 30 (limit: 4915)

   Memory: 200.0M

   CGroup: /system.slice/jenkins.service

           └─1234 /usr/bin/java -jar /usr/share/jenkins/jenkins.war

Key Concept

If you remember nothing else from this pattern, remember: always stop Jenkins before restoring backups to avoid data corruption.

Common Mistakes

Trying to restore backup files while Jenkins is still running

This can cause data corruption because Jenkins may overwrite files during restore.

Always stop the Jenkins service before restoring backup files.

Backing up only the jobs folder and ignoring plugins and configurations

This causes incomplete backups and Jenkins may not work correctly after restore.

Backup the entire Jenkins home directory to include all important data.

Not verifying the backup file size or existence before deleting old backups

You might delete a backup that failed or is incomplete, losing your recovery option.

Always check backup files with ls or similar commands before cleaning old backups.

Summary

Use tar to create a compressed backup of the Jenkins home directory.

Stop Jenkins before restoring backups to prevent data corruption.

Start Jenkins after restoring and verify it is running properly.