It is very important to have Jenkins backup with its data and configurations. It includes, job configs, build logs, plugins, plugin configuration etc.
In this article, we will cover different scenarios for backing up Jenkins data and configurations.
Jenkins Backup Using Thin Backup Plugin
Jenkins Thin Backup is a popular plugin for backing up Jenkins. It backs up all the data based on your schedule and it handles the backup retention as well.
To get started, first install the plugin.
1. Go to Manage Jenkins –> Manage Plugins
2. Click the Available tab and search for “Thin backup”
3. Install the plugin and restart Jenkins.[irp posts=”1289″ name=”How to Setup Custom UI Theme For Jenkins”]
Once installed, follow the steps given below for configuring backup settings.
1. Go to Manage Jenkins — > ThinBackup
2. Click settings option.
3. Enter the backup options as shown below and save it. All the options are self-explanatory. The backup directory you specify should be writable by the user which is running the Jenkins service. All the jenkins backup will be saved to the backup directory you specify.
4. Now, you can test if the backup is working by clicking the
Backup Now option. It will create a backup of jenkins data in the backup directory you specified in the settings.
5. If you check the backup directory in the server, you can see the backup created. For every new backup, it will attach the timestamp to the folder name and keeps the old backup based on the retention policy you mentioned in the settings.
An example is shown below.
[[email protected] backup]$ pwd /var/lib/jenkins/backup [[email protected] backup]$ ls FULL-2017-08-20_05-42 FULL-2017-08-20_05-43 FULL-2017-08-20_05-44 [[email protected] backup]$
Backing up the Backup
It is not a good idea to keep the jenkins back in Jenkins itself. It is a must to move thin backups to cloud storage or any other backup location. So that, even if Jenkins server crashes you will have all the data.
If you are on AWS, Azure or Google CLoud, you can upload the backups respective storage solutions.
Jenkins Backup Using Disk Snapshots
As you know, Jenkins doesn’t have a database. All the configurations are stored as files in the
If your environment supports disk snapshots, here is what you can do for backing up jenkins data.
- Attach an external disk to your Jenkins server.
- Mount the disk to the server on a folder, say
- If you have existing data, move all data from
- Restart Jenkins and check if you jenkins is using the newly mounted disk.
- Now, you can take a timely snapshot of the extra disk. This will serve as a point in time backup for your jenkins.
Also, we suggest you use the Thin backup plugin in conjunction with disk snapshots.