thinBackup

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID thinBackup Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
1.7.4
Oct 14, 2013
1.509
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
Thomas Fuerer (id: tofuatjava)
Matthias Steinkogler (id: alienllama)
Usage Installations 2013-Apr 3552
2013-May 3638
2013-Jun 3823
2013-Jul 4066
2013-Aug 4228
2013-Sep 4430
2013-Oct 4669
2013-Nov 4800
2013-Dec 4840
2014-Jan 5230
2014-Feb 5444
2014-Mar 5672

This plugin simply backs up the global and job specific configurations (not the archive or the workspace).

Compatibility

This plugin needs Hudson 1.377 (1.409 or greater recommended) or newer for automated backups (manual backups also work in older versions).

Why another backup plugin

The Backup Plugin only does manual backups, and stores all data found in JENKINS_HOME. This is sometimes (e.g. big Jenkins environment) not practical because of time and disk space requirements, and because it can only be manually triggered. thinBackups can be scheduled and only backs up the most vital configuration info.

Documentation

This plugin adds another management link to 'Manage Hudson' called ThinBackup which looks like this:

This new link provides the following actions:

Backup Now

Triggers a manual full back up right now.

Restore


Select the date of the backup you would like to restore. After the restore finishes you are redirected to the plugin main page. To activate the restored settings you need to restart jenkins.

Note: The file 'nextBuildnumber' will not be backed up or restored to prevent buildnumber collision by default. The archive and the workspace will not be deleted or changed, but all backed up files will simply be overwritten with the restored versions (e.g. config.xml, thinBackup.xml -> for more info simply look in a backup).

.

Restore next build number file (if found in backup)

If this option is enabled, the file nextBuildNumber will also be restored.
*Note:*Take special care when restoring a backup that contains a nextBuildNumber file, as this may potentially cause a lot of problems.

Restore plugins

If this option is enabled, the plugins get restored. You need an active internet connection to the update server, because plugins will be downloaded from the update server to keep the backup small.

Settings

Backup directory

Specify the backup directory. The Jenkins process needs write access to this directory. You can use environment variables like ${JENKINS_WORKSPACE} to specify the path.

Backup schedule for full backups

Specify schedule when a full backup is triggered. Cron notation is used. A full backup backs up all files even if there were no changes.

Backup schedule for differential backups

Specify schedule when a differential backup is triggered. Cron notation is used. A differential backup stores only modified data since the last full backup. If there are no changes detected, no diff backup will be created.

Note: You do not need to specify a differential backup schedule if you only need full backups. Because differential backups depend on full backups, a schedule for full backups is mandatory if you specify a differential backup schedule.

Wait until Jenkins/Hudson is idle to perform a backup

It is very recommended to enable this option (default). Nevertheless, many users report that the quiet mode is blocking the execution of long running jobs. If you disable this option the backup will be made without waiting for a safe state of your instance. In other words, the backup will be done immediately, and this could cause corrupt backups.

Force Jenkins to quite mode after specified minutes

Force a quiet mode after the specified time in minutes to force a safe environment for the back up. Zero means the quite mode is forced directly when the back up is triggered by the scheduler. Read more about the back up process below.

Max number of backup sets

To save disk space, you can specify the maximum number of stored backup sets. A backup set is defined as a full backup together with its referencing diff backups. Older backup sets will be deleted after the next full backup action. This also applies to zipped backup sets.

Files excluded from backup

If you have specific files you do not want to back up, entering a regex here which identifies those files will prevent them being backed up. All files with a name matching this regular expression will not be backed up. Leave empty if not needed. If the expression is invalid, it will be disregarded.

Back up build results

If this option is enabled, build results will also be backed up. This is potentially a lot of data, so think carefully about it. Once you decide to backup build results you get also to option about backup your build archives. Once again, be careful with this option, because it could be very time consuming and needs probably a lot of disk space!

Back up 'userContents'

Jenkins provides a URL where you can put common data (e.g. static HTML, Tools, ...). you can back up all these data if you check this option.

Backup only builds marked to keep

If this option is enabled, only builds results/artifacts on builds which are marked "Keep this build forever" are backed up.

Clean up differential backups

If this option is enabled, all differential backups are removed whenever a new full backup is done.

Move old backups to ZIP files

If this is checked, then whenever a new full backup is performed all old backup sets will be moved to ZIP files. Each ZIP file will contain one backup set, i.e. one full backup and any diff backups referencing it. The file name will identify the time frame where the backups are included (i.e. the time stamp of the full backup and the time stamp of the latest diff backup).

Note: The setting "Max number of backup sets" applies to backup ZIP files created by thinBackup as well.

Note: In case "Clean up differential backups" is checked, diff cleanup will be performed before zipping is done, and therefore no diff backups will be in the ZIP files.

Back up process

Because many of you are asking why Jenkins is going to shutdown when a back up is triggered, I decided to explain my ideas behind the back up process.
First of all, Jenkins will not be shut down at any time.
Second, I use the build-in quiet mode (Jenkins is going to shutdown) to ensure a safe environment during the back up process and cancel the quiet mode afterwards. This could be misleading, I know, but there is no point where Jenkins will be shutdown.

So what is a safe environment?
A safe environment would mean that no jobs are running. Because a running job could change a file in the workspace (results, build output, ...), in this case the file could be locked. This situation should be avoided by using the quiet mode.

How it works, an example:

  • The scheduler triggers a backup
  • There are active jobs and some jobs are waiting in the queue
  • The back up waits for a safe environment (recommended way). This means running jobs will be finished in any case. Waiting jobs will be started as long Jenkins is not in the quiet mode. The 'Force Jenkins to quite mode after specified minutes' option will force Jenkins after the specified time into the quiet mode. From this point on no further jobs will be started until the backup is finished.
    In case of 'Wait until Jenkins/Hudson is idle to perform a backup' is disabled the backup will be done immediately.
  • The back up starts when no job is running.
  • Once the back up is finished the quiet mode will be canceled. Manually canceling the quiet mode will force a new quiet period.

Changelog

Version Comment
1.7.4
fixed issued: JENKINS-20026
1.7.3 fixed issues: JENKINS-17475
Upgrade Jenkins core version to 1.509, verions before this are not tested and midge be buggy.
1.7.2 fixed issues: JENKINS-16426 (-> JENKINS-16897 )
improvements: JENKINS-16609
1.7.1 defect artifact - Please do not use!
1.7 new features: JENKINS-10947: Plug-ins will be restored from the update server
improvements:JENKINS-15681: Support for Cloudbees Folders
fixed issues: JENKINS-15514
1.6.2
fixed issues: JENKINS-14288, JENKINS-12173, JENKINS-12098
1.6.1
fixed issues: JENKINS-14111, JENKINS-13980
1.6
fixed issues: JENKINS-13427
improvements: JENKINS-13059
1.5
fixed issues:
improvements: JENKINS-8565; JENKINS-11062; JENKINS-11678; JENKINS-11975
new features: JENKINS-10994
1.4 fixed issues: JENKINS-10377; JENKINS-10381
1.3 fixed issues: JENKINS-9117;JENKINS-8955;JENKINS-9171;JENKINS-9669
new features: Compress old backupsets; exclude files from backup via regex
1.2 fixed issues: JENKINS-8782;JENKINS-8781; JENKINS-8606;JENKINS-8564
JENKINS-8583 will be fixed if you use Jenkins greater or equal 1.396
1.1 first published version
1.0 never published because of release problems

Feature Requests

Please let us know if you would have another option or feature for this plugin by simply enter an issue or write us an email. THANKS

Labels

Edit
plugin-misc plugin-misc Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment