Introduction
Introduction
Explaining $JENKINS_HOME
Best practices for backup and restore
Backing up manually
IntroductionRestoring manuallyRestoring credentials
Using the CloudBees Backup Plugin
IntroductionScheduling your backups in the CloudBees Backup PluginRestoring from CloudBees Backup Plugin
Backup and restore on Kubernetes
Backup and restore on AWS
Using Velero for backup and restore of Kubernetes clusters
Using cluster operations to run backups
Introduction
Getting the CLI tool
Using the CLI tool
Examples of usage
From CloudBees Jenkins Platform Controllers
Configuring an alias for the Jenkins CLI tool
Configuring the Jenkins CLI tool to work with non-TrustStore SSL certificates
Managing CasC bundles and creating items
About plugins
IntroductionRestart Aborted Builds pluginAWS CLI pluginCloudBees Amazon Web Services Deploy EngineMicrosoft Azure CLI pluginCloudBees Backup pluginCloudBees Bitbucket Branch Source pluginCloudBees Assurance ProgramCloudBees CasC API pluginCloudBees CasC Client pluginCloudBees CasC Items API pluginCloudBees CasC Items Commons pluginCloudBees CasC Items Controller pluginCloudBees CasC Items Server pluginCloudBees CasC Server pluginCloud Foundry CLI pluginConsolidated Build View pluginCloudBees Docker Build and Publish pluginCloudBees Docker TraceabilityDocker Pipeline pluginCloudBees Docker Hub/Registry NotificationCloudBees Even Scheduler pluginCloudBees Fast Archiving pluginFolders pluginFolders Plus pluginGitHub Branch Source pluginJenkins Health Advisor by CloudBeesCloudBees Long-Running Build pluginMonitoring pluginNodes Plus pluginOpenShift CLI pluginCloudBees Plugin Usage Analyzer pluginCloudBees Prometheus Metrics pluginPull Request Builder for GitHub pluginCloudBees Quiet Start pluginSecure Copy pluginSkip Next Build pluginSSH Build Agents pluginCloudBees Support pluginTemplate pluginCloudBees Label Throttling pluginUser Activity MonitoringCloudBees Git Validated Merge pluginVisual Studio Team Services pluginWikitext Security plugin
Plugin management
IntroductionGetting started with plugin managementCloudBees Assurance ProgramBeekeeper Upgrade AssistantAdding Beekeeper plugin exceptionsFinding the support tier for a pluginInstalling pluginsUpgrading plugins from the Plugin ManagerUninstalling pluginsDisabling pluginsReviewing plugin usageConfiguring plugin catalogsManaging plugins with Update CenterManaging plugins in a secure environment
Getting started
IntroductionPipeline termsPipeline project typesCloudBees Pipeline benefits
Planning for Pipelines
IntroductionUsing Pipeline development utilitiesDetermining plugin compatibilityPipeline best practices
Creating Pipelines
IntroductionPrerequisitesCreating your first PipelineCreating Pipelines in SCMCreating Pipelines in Web UIUsing Pipeline as Code
Automating with Jenkinsfile
IntroductionConfig Adv ScriptedConfig Build StageConfig Deploy StageConfig Optional Step ArgsConfig Test StageCreating JenkinsfileCustomizing ParametersHandling FailuresString InterpolationUsing Multiple AgentsWorking With The Env
Administering Pipelines
IntroductionControlling buildsManaging 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
Remote collaboration features
IntroductionTrigger a job with a notification event using Cross Team CollaborationEnable external notification events with external HTTP endpointsCluster-wide copy artifactsCluster-wide job triggers
Pipeline templates
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
Pipeline syntax reference
IntroductionUsing Declarative Pipeline syntaxUsing Scripted Pipeline syntax
Multibranch Pipeline Template syntax
IntroductionBranch SourceBitbucketGitHubGitBranch Property StrategyExamples
Introduction
CloudBees Jenkins JVM troubleshooting
Performance decision tree for troubleshooting
Troubleshooting memory leaks
Troubleshooting file and thread leaks
Generating a support bundle
cbsupport CLI documentation

Restoring credentials

1 minute read

There are two primary use cases where you may need to move credentials between controllers:

  • Cloning a controller.

  • Moving jobs from a monolithic controller into a smaller team controller.

Managing credentials when cloning a controller

You may need to create a test controller from the backup of a production controller. If you do so, and the controllers are in the same cluster, you may receive errors, and should use the following instructions to resolve the problem:

  1. Log into the origin controller and stop the controller.

  2. Using administrative SSH or console access, log into the controller and remove the following files:

    • $JENKINS_HOME/license.xml

    • $JENKINS_HOME/operations-center-cloud*

    • $JENKINS_HOME/operations-center-client*

    • $JENKINS_HOME/com.cloudbees.opscenter.client.plugin.OperationsCenterRootAction.xml

  3. Disable security:

    1. Open $JENKINS_HOME/config.xml.

    2. Locate the line <useSecurity>true</useSecurity> and change the value to <useSecurity>false</useSecurity>.

    3. Save $JENKINS_HOME/config.xml.

  4. Start the Jenkins service.

  5. Create a new client controller in operations center and push the modified configuration in $JENKINS_HOME/config.xml to it.

Managing credentials when moving jobs between controllers

If you are moving a set of jobs from a monolithic controller to a team controller and you receive "duplicate instance" errors:

  1. Stop Jenkins.

  2. Change to the $JENKINS_HOME directory.

  3. Delete the secret.key file.

  4. Delete the license.xml file.

  5. Start Jenkins.

Go to Manage Jenkins → Manage License to display your instance ID. You can also go to https://$JENKINS_URL/license to view the instance ID associated with your license.
Restoring manually