IntroductionPipeline termsPipeline project typesCloudBees Pipeline benefits
IntroductionUsing Pipeline development utilitiesDetermining plugin compatibilityPipeline best practices
IntroductionPrerequisitesCreating your first PipelineCreating Pipelines in SCMCreating Pipelines in Web UIUsing Pipeline as Code
IntroductionConfig Adv ScriptedConfig Build StageConfig Deploy StageConfig Optional Step ArgsConfig Test StageCreating JenkinsfileCustomizing ParametersHandling FailuresString InterpolationUsing Multiple AgentsWorking With The Env
IntroductionManaging artifactsTracing artifactsTriggering jobs with a simple webhookRestoring filesVisualizing PipelineInserting checkpointsSecuring PipelinesConfiguring Pipelines with user-scoped credentialsUsing Pipeline PoliciesSpecifying a matrix of one or more dimensionsConverting a Freestyle project to a Declarative Pipeline
IntroductionRestarting aborted buildsLong-running buildsSkip next buildConsolidated Build View pluginCloudBees Quiet Start pluginCloudBees Template pluginCloudBees Git Validated Merge plugin
IntroductionTrigger a job with a notification event using Cross Team CollaborationEnable external notification events with external HTTP endpointsCluster-wide copy artifactsCluster-wide job triggers
IntroductionSetting up a Pipeline Template CatalogDefining Pipeline Template CatalogsSetting Up A Pipeline TemplateUsing parameters in template.yamlManaging multibranch Pipeline options in template.yamlManaging Pipeline Template Catalogs in bulkExample full Maven/Java app Jenkinsfile
IntroductionUsing Declarative Pipeline syntaxUsing Scripted Pipeline syntax
IntroductionBranch SourceBitbucketGitBranch Property StrategyExamples
CloudBees Docker Build and Publish pluginCloudBees Docker TraceabilityDocker Pipeline pluginCloudBees Docker Hub/Registry Notification plugin
IntroductionExplaining $JENKINS_HOMEBest practices for backup and restoreBacking up manuallyRestoring manuallyRestoring credentialsUsing the CloudBees Backup PluginScheduling your backups in the CloudBees Backup PluginRestoring from CloudBees Backup PluginUsing cluster operations to run backups
IntroductionGetting the CLI toolUsing the CLI toolExamples of usageConfiguring multiple client controllersConfiguring an alias for the Jenkins CLI toolConfiguring the Jenkins CLI tool to work with non-TrustStore SSL certificatesCasC bundle management on operations center
CloudBees Inactive Items Plugin
Jenkins Health Advisor by CloudBees
CloudBees Pull Request Builder for GitHub plugin
Counting and monitoring user licenses with the CloudBees User Activity Monitoring plugin
Support policies

Backing up manually

1 minute read

This chapter provides guidance for backing up your $JENKINS_HOME directory.

If you are using CloudBees Jenkins Platform, you also have the option to use the CloudBees Backup Plugin for backup and recovery.

If you are performing a manual backup of CloudBees Jenkins Platform or Jenkins, the recommended manual backup process is to schedule a cron job on a regular cadence to create a tarball of your $JENKINS_HOME directory.

The basic steps for backup:

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

  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.

There is no need to stop Jenkins when performing a backup.

Things to consider:

  • Refer to Explaining $JENKINS_HOME to determine what you want to include in your backup.

  • Store backup files on a different server for better security and in case of data corruption.

  • Store backup files on a different network for better security and in case of data corruption.

CloudBees Jenkins Platform

In CloudBees Jenkins Platform, you can backup $JENKINS_HOME manually using the following command. In the following example, you are directly logged in (remotely via SSH or physically on the machine at a command-line terminal):

  1. Navigate to your $JENKINS_HOME configuration from the command line:

    cd $JENKINS_HOME
    ▼

  2. Create a compressed file:

tar -czvf /backups/jenkins_home/production-backup-2021-10-26.tar.gz .
The CloudBees Backup Plugin steps you through creating an operations center job for both backup and recovery. Even if you prefer to create your backups manually, consider setting it up as an operations center job that backs up everything across all controllers.
Best practices for backup and restore
Restoring manually