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

High Availability (active/active)

Deploy and operate High Availability (HA) (active/active) controllers.

HA fundamentals

HA fundamentals, features, and advantages.

Read More

HA considerations

HA implications in relation to other elements in your controller.

Read More

Pipeline builds and HA

Understand how Pipeline builds are scheduled and load-balanced in HA.

Read More

Audit your jobs for compatibility with HA

Audit your jobs and Pipeline steps for HA compatibility.

Read More

Non-CAP plugin compatibility

Review non-CAP plugin compatibility status for HA controllers.

Read More

Install HA on modern cloud platforms

Learn how to install HA on CloudBees CI on modern cloud platforms.

Read More

Install HA on traditional platforms

Learn how to install HA on CloudBees CI on traditional platforms.

Read More

Configure your agents to work with HA

Configure agents to support multiple executors in HA mode.

Read More

HA on Amazon EKS performance report

Evaluate HA performance on Amazon Elastic Kubernetes Service across different replica counts.

Read More

Migrate an existing managed controller to HA

Migrate an existing managed controller to HA with minimal downtime.

Read More

Migrate an existing client controller to HA

Migrate a non-HA client controller to HA.

Read More

Troubleshoot HA

Developer mode, HA Script console and common problems.

Read More