Introduction
IntroductionPre-installation requirementsInstallUninstall
IntroductionPre-installation requirementsInstallVerify and inspect Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify and inspect Docker imagesUninstall
IntroductionPre-installation requirements for KubernetesKubernetes Gateway API for CloudBees CI on modern cloud platformsKubernetes Gateway API supported implementationsGateway API features required by CloudBees CIVerify Kubernetes Gateway API prerequisitesDeploy a Kubernetes Gateway API namespace topologyInstall CloudBees CI with Kubernetes Gateway APIMigrate from Ingress to Gateway APIClean up Helm values for Gateway API migrationVerify and inspect Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify and inspect Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify and inspect Docker imagesUninstall
IntroductionSystem requirementsVerify Docker imagesInstall operations centerInstall client controllersVerify build componentsVerify WAR files
Introduction
IntroductionCommon Pipeline termsPipeline project typesCloudBees proprietary features for Pipelines
IntroductionPipeline development utilitiesDetermine plugin compatibilityPipeline best practices
IntroductionUse Declarative Pipeline syntaxUse Scripted Pipeline syntax
IntroductionPipeline prerequisitesCreate your first PipelineSelect an agent for your Pipeline jobCreate a Pipeline from SCMCreate a Pipeline in the UIUnderstand and implement Pipeline as Code
IntroductionConfigure advanced Scripted PipelineConfigure the build stageConfigure the deploy stageConfigure optional step argumentsConfigure the test stageCreate a JenkinsfileCustomize parametersHandle failuresString interpolationUse multiple agentsWork with the environmentReuse configuration files
IntroductionEnable artifact traceability with fingerprintingTrigger jobs with a simple webhookRestore filesVisualize the PipelineInsert checkpointsSecure PipelinesConfigure Pipelines with user-scoped credentialsEnforce standards with Pipeline PoliciesSpecify a matrix of one or more dimensionsConvert a Freestyle project to a Declarative Pipeline
IntroductionRestart aborted buildsSkip next buildConsolidated Build View pluginCloudBees Quiet Start pluginCloudBees Template pluginCloudBees Workspace Caching
IntroductionTrigger a job with a notification event using Cross Team CollaborationEnable external notification events with external HTTP endpointsCluster-wide copy artifactsCluster-wide job triggers
IntroductionSet up a Pipeline Template CatalogDefine Pipeline Template CatalogsSet up a Pipeline TemplateParameter types in the template.yaml fileManage Multibranch Pipeline options in the template.yaml fileManage Pipeline Template Catalogs in bulkExample full Maven/Java app Jenkinsfile
IntroductionBranch SourceBitbucketGitHubGitBranch Property StrategyExamples
CloudBees Docker Traceability
Introduction
Introduction
Introduction
IntroductionGet startedNavigate the operations center interfaceProvision agents in a separate Kubernetes cluster from a managed controllerProvision a controller in a different OpenShift project than the operations centerManage controllersManage controllers in specific Kubernetes namespacesManage agentsOpt in to the Git LFS agent imageManage SSH credentialsShared agentsShared configurationsShared cloud configurationTrigger restrictionsChange NFS storage locationQuiet startMove/Copy/PromoteCluster operationsInbound agentsUse Kaniko with CloudBees CIUse Buildkit with CloudBees CIUsing self-signed certificates in CloudBees CI on KubernetesSidecar injector for self-signed certificates on OpenShiftAuto-scale nodes on EKSEnable auto-scaling nodes on GKECloud Foundry CLI PluginCloudBees CI ServiceNow integrationCreate projects based on a GitHub repository structureUse GitHub App authenticationCreate Multibranch Projects and Organization Folders with large repositoriesController Lifecycle Notifications plugin
IntroductionGet startedNavigate the operations center interfaceManage client controllersManaging agentsManage SSH credentialsShared agentsShared configurationsShared cloud configurationTrigger restrictionsQuiet startMove/Copy/PromoteCluster operationsInbound agentsCloudBees CI ServiceNow integrationCreate projects based on a GitHub repository structureUse GitHub App authenticationCreate Multibranch Projects and Organization Folders with large repositories
Introduction
Trust modelCentrally manage securityPod Security Admission
Use single sign-on (SSO) in the operations centerConfigure SAMLIntegrate Microsoft Entra IDSet up SSO Relay for CloudBees CI single sign-on
Role-based access control (RBAC)Example RBAC configurationsRBAC auto-configurer pluginRestrict job triggersAccess controls on the operations centerAccess controls on controllersOperations center specific permissionsAuthentication mappingDelegate administrationFoldersFolders Plus
Authenticate automated processes with CloudBees CI service accountsService account scope and visibilityGet started with CloudBees CI service accountsService accounts CLIService account API endpointsCreate and use service accounts with Configuration as CodeService account security considerations
OAuth client credential bindingRestricted credentialsInjecting secretsMask ephemeral secrets in Pipeline build logsEnhanced credentials maskingExternal secrets managementCyberArk credential providerManage secrets with HashiCorp VaultShared credentials administrative monitor
Cross-controller triggersTest the SSH connection to an agentManage build agents with Nodes PlusExtended security settings
Beekeeper security warningsCloudBees administrative monitorsSecurity recommendationsData collection
Replace an expired certificateList of URLs that need accessBlock access to URL patternsServe resources from JenkinsVerify Helm charts with a signature
Introduction
Introduction$JENKINS_HOME directoryBest practices for backup and restoreBack up $JENKINS_HOME manuallyBackup a Role-Based Access Control configurationRestore backup files manuallyRestore credentialsConfigure backups using the CloudBees Backup pluginSchedule backups in the CloudBees Backup pluginRestore backups created with the CloudBees Backup pluginBackup and restore on KubernetesBackup and restore on AWSBackup and restore Kubernetes cluster resources using VeleroRun backups using cluster operations
IntroductionConfigure multiple client controllers with the Jenkins CLI toolConfigure an alias for the Jenkins CLI toolConfigure Jenkins CLI tool with non-TrustStore TLS certificates
CloudBees Inactive Items Plugin
Jenkins Health Advisor by CloudBees
Count and monitor user licenses with the CloudBees User Activity Monitoring plugin
Count and monitor user licenses with the CloudBees User License Counting (ULC) system
Introduction
IntroductionHigh Availability fundamentalsHigh Availability considerationsPipeline builds and High AvailabilityAudit your jobs for compatibility with High AvailabilityNon-CAP plugin compatibilityInstall High Availability on CloudBees CI on modern cloud platformsInstall High Availability on CloudBees CI on traditional platformsConfigure your agents to work with High AvailabilityHigh Availability on Amazon EKS performance reportMigrate an existing managed controller to High AvailabilityMigrate an existing client controller to High AvailabilityTroubleshoot High Availability
IntroductionInstall High Availability on CloudBees CI on traditional platformsMigrate from High Availability (active/passive) to High Availability (active/active) on CloudBees CI on traditional platformsTroubleshoot High Availability installation
Introduction
IntroductionCasC requirementsCasC permissionsRecommended workflow
IntroductionExport a CasC configurationTransform an exported bundleAdvanced CasC bundle configurationValidate a CasC bundle
IntroductionGet started with Configuration as Code for the operations centerConfigure the operations center on modern platforms using CasCConfigure the operations center on traditional platforms using CasCRetrieve bundles using an SCMTroubleshoot CasC
IntroductionGet started with Configuration as Code for controllersDistribute CasC bundles to controllers from your operations centerAdd controller CasC bundles to the operations centerConfigure bundle availability for controllersSet up a client controller using CasCSet up a managed controller using CasCSet up a managed controller using the CasC Controller Bundle ServiceAdvanced topicsTroubleshoot CasC for controllers
IntroductionUpdate a CasC bundleBundle update timingReview the CasC update log
IntroductionPlugin management with CasCDetermine plugin compatibility using CasCCreate an alternate plugin download site
Create items using CasC
Configure RBAC with CasC
CasC CLI commands
CasC HTTP API
Introductionbundle.yaml file referencejenkins.yaml file referenceplugins.yaml file referenceplugin-catalog.yaml file referenceitems.yaml file referencerbac.yaml file referencevariables.yaml file reference
Support policies

Troubleshoot High Availability (active/active)

3 minute readTroubleshooting

If CloudBees High Availability (HA) is not working as expected, use this page to troubleshoot.

HA developer mode

The HA feature provides a developer mode to troubleshoot HA problems in controllers running in HA mode.

To enable developer mode in a controller:

  1. Select in the upper-right corner to navigate to the Manage Jenkins page.

  2. Select CloudBees CI High Availability.

  3. Select Configure on the left navigation pane.

  4. Select Enable developer mode, and then select Save or Apply.

    Enable developer mode
    Figure 1. Enable developer mode

Developer mode is a powerful tool to troubleshoot and understand High Availability. When enabled, the controller provides additional information about the High Availability mode:

  • A button with the current replica name appears in the page footer.

  • The background color for the replica button changes from one replica to another.

  • When selected, the replica button on the footer redirects to the CloudBees CI High Availability screen.

    Footer in developer mode
    Figure 2. Footer in developer mode

  • The consolidated queue widget displays the queue items in all the replicas.

  • In developer mode, CloudBees CI adds the replica name to those items queued in other replicas.

  • Names for items queued in the current replica remain the same.

Build name in developer mode
Figure 3. Build name in developer mode

From the CloudBees CI High Availability screen, additional to enabling developer mode, you can also change the replica you are using. To switch the session to a different replica:

  • Navigate to the CloudBees CI High Availability screen.

  • Select Status on the left navigation pane.

  • Select Reset sticky session.

Switch to another replica
Figure 4. Switch to another replica

When the Reset sticky session is selected, CloudBees CI randomly assigns a new replica. If there is no change, and you are assigned to the same replica, you can reload the page and try again until a new replica is assigned.

The Reset sticky session button only displays if your Gateway API controller supports cookie-based session affinity. However, you may be assigned to a different replicas if, while using your browser developer tools, you remove CloudBees CI cookies and sign in again.

High Availability (HA) Script Console

The CloudBees CI High Availability screen provides a High Availability Script Console. This console allows CloudBees CI users to run scripts across all the current controller replicas and displays the results. To access the HA Script Console, select Script Console on the left.

HA Script Console
Figure 5. HA Script Console

  1. Select Script Console to access the HA Script Console.

  2. Type your scripts in the scripts area.

  3. Run your HA scripts. When selected, the script will be executed in all the controller replicas.

Results for the HA Script Console
Figure 6. Results for the HA Script Console

View running builds in HA controllers

In HA mode, you can view all running builds across controller replicas to help monitor build activity and diagnose issues more efficiently.

To view all running builds in an HA controller:

  1. Select in the upper-right corner to navigate to the Manage Jenkins page.

  2. Select CloudBees CI High Availability.

  3. Select Running builds in the left navigation pane.

    All currently running builds are displayed across all controller replicas, including the build name, build number, duration, and the replica handling each build. You can optionally:

    • Select to abort a build.

    • Select the build name to view the build status.

    • Select to view the Console Output page for the build.

    View running builds in HA controllers
    Figure 7. View running builds in HA controllers

Include HA information in your support bundle

The CloudBees Support plugin allows you to generate a support bundle that contains commonly requested diagnostic information used by CloudBees to resolve support issues.

This plugin is installed by default with CloudBees CI. For more information about how to generate support bundles and the information collected by CloudBees from support bundles, refer to Generate a support bundle.

To include specific High Availability (HA) information in a controller support bundle:

  1. From the root of you controller, select Support on the left navigation pane.

  2. Select the Information from other replicas option in the CloudBees Support screen. When this option is selected, the generated support bundle contains the HA information in the replicas/ directory. The replicas/ directory will include the following subdirectories:

    • The live/ directory contains a subdirectory with data for each current replica.

    • The exited/ directory contains a subdirectory with data for each replica previously used and replaced. For example, replicas that were replaced during rolling restarts or rolling upgrades.

  3. Select Generate Bundle to generate and download the support bundle with the HA information.

Include specific HA information in your controller support bundle
Figure 8. Include specific HA information in your controller support bundle
This option is only available for controllers that run in HA mode.
Migrate an existing client controller to High Availability