Backup and restore guide

On this page

This guide covers the backup and restore process for all Jenkins-based installations:

  • CloudBees Core

  • CloudBees Jenkins Distribution

  • CloudBees Jenkins Platform

  • CloudBees Jenkins Enterprise v1

  • Jenkins deployments with optional CloudBees Jenkins Support subscription

Basic steps

What does the backup and restore process involve for a Jenkins-based deployment?

The basic steps for backup:

  1. Determine what you want to backup using Explaining $JENKINS_HOME.

  2. Determine how often you want to backup your $JENKINS_HOME.

  3. Determine how you want to schedule the backup (cron is recommended if available).

  4. Consider our Best practices for backup and restore.

  5. If you are running CloudBees Core, decide between performing manual backups or using the CloudBees Backup Plugin. Other deployments should perform manual backups.

For the restore process:

  1. Consider our Best practices for backup and restore.

  2. If you performed a manual backup, restore $JENKINS_HOME manually.

  3. If you are using CloudBees Core, you can use the CloudBees Backup Plugin to create a job to recover from backup.

  4. If you are running CloudBees Core on AWS, refer to Backup and restore on AWS for additional information.

  5. If you need to restore jobs to a different Jenkins instance ID, follow the procedure in the Restoring credentials section.

Copyright © 2010-2019 CloudBees, Inc.Online version published by CloudBees, Inc. under the Creative Commons Attribution-ShareAlike 4.0 license.CloudBees and CloudBees DevOptics are registered trademarks and CloudBees Core, CloudBees CodeShip, CloudBees Jenkins Enterprise, CloudBees Jenkins Platform, CloudBees Jenkins Operations Center and DEV@cloud are trademarks of CloudBees, Inc. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Jenkins is a registered trademark of the non-profit Software in the Public Interest organization. Used with permission. See here for more info about the Jenkins project. The registered trademark Jenkins® is used pursuant to a sublicense from the Jenkins project and Software in the Public Interest, Inc. Read more at Apache, Apache Ant, Apache Maven, Ant and Maven are trademarks of The Apache Software Foundation. Used with permission. No endorsement by The Apache Software Foundation is implied by the use of these marks.Other names may be trademarks of their respective owners. Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this content, and CloudBees was aware of a trademark claim, the designations have been printed in caps or initial caps. While every precaution has been taken in the preparation of this content, the publisher and authors assume no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.