Table of contents

Backup and restore guide


On this page

Introduction

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.