Documentation
Software Delivery Automation
CloudBees Software Delivery Automation
CloudBees CI
CloudBees CD/RO
CloudBees Previews
Other CloudBees Products
CloudBees Build Acceleration
CloudBees CodeShip
Cloud-Native Platform
CloudBees platform
CloudBees Feature Management (legacy)
Resources
Account management
Legal and policies
Training
Support
Plugins
CloudBees CI Plugins
CloudBees CD/RO Plugins
Lexicon
CloudBees CI
CloudBees CD/RO
CloudBees platform
CloudBees Feature Management (legacy)
CloudBees Build Acceleration
AI Help
Beta
Search
Enable dark mode
New to CloudBees or returning.
Sign in / Sign up
CloudBees CI
Resources
Account management
Legal and policies
Software Delivery Automation
CloudBees Software Delivery Automation
CloudBees CI
CloudBees CD/RO
CloudBees Previews
Cloud-Native Platform
CloudBees platform
CloudBees Compliance
CloudBees Feature Management (legacy)
Other CloudBees Products
CloudBees Build Acceleration
CloudBees CodeShip
Documentation
Documentation
API reference
Migration guides
Lexicon
Release notes
Knowledge Base
latest (2.504.3.28227)
latest (2.504.3.28227)
2.504.3.28224
2.504.2.5
2.504.1.7
2.504.1.6
2.492.3.5
2.492.2.3
2.492.2.2
2.492.1.3
2.479.3.2
2.479.3.1
2.479.2.3
2.479.1.4
2.479.1.3
2.462.3.3
2.462.2.2
2.462.1.3
Introduction
Product features
Introduction
Uniquely cloud native
Introduction
Multicloud environment
Developer centric experience
Introduction
CI as code
Contextual pipeline feedback
CloudBees CI ServiceNow integration
Pipeline policy enforcement
Introduction
Modernized pipelines
Secure CI/CD
Velero for backup and restore
Team management
Introduction
Enterprise team management and authorization
Jenkins at scale
Introduction
Optimize Continuous Integration Resources
Enterprise Grade Plugin Management
Plugin Usage Analyzer
High Availability and Horizontal Scalability
Debug Pipelines at Scale
Onboard
Introduction
Onboard for modern cloud platforms
Onboard for traditional platforms
Learn
Introduction
Train your team
Architecture for modern cloud platforms
Architecture for traditional platforms
Plan
Introduction
Feature comparison
Supported platforms
Supported platforms for CloudBees CI on modern cloud platforms
Supported platforms for CloudBees CI on traditional platforms
Modern cloud platforms
Traditional platforms
Install
Introduction
AKS installation
Introduction
Pre-installation requirements
Install
Verify Docker images
Uninstall
Amazon EKS installation
Introduction
Pre-installation requirements
Install
Verify Docker images
Uninstall
GKE installation
Introduction
Pre-installation requirements
Install
Verify Docker images
Uninstall
Kubernetes installation
Introduction
Pre-installation requirements
Install
Verify Docker images
Uninstall
OpenShift installation
Introduction
Pre-installation requirements
Install
Verify Docker images
Uninstall
TKGI installation
Introduction
Pre-installation requirements
Install
Verify Docker images
Uninstall
Traditional platforms installation
Introduction
System requirements
Verify Docker images
Install operations center
Install client controllers
Verify build components
Verify WAR files
High availability
Introduction
HA fundamentals
Get ready for HA
Install HA on modern cloud platforms
Install HA on traditional platforms
HA considerations
High Availability (active/passive) installation for CloudBees CI on traditional platforms
FIPS compliance
Introduction
What is FIPS and FIPS 140 compliance?
Install CloudBees CI on modern cloud platforms in FIPS mode
CAP plugin support in a FIPS 140-3 environment
Configure the Apache™ Ant plugin for FIPS compliance
Configure the Pipeline Maven API plugin for FIPS compliance
Known FIPS incompatibilities with CloudBees CI on modern cloud platforms
Jenkins core: FIPS 140-3 compliant artifacts with caveats
Jenkins core: Non-compliant classes and libraries
Upgrade
Introduction
Modern cloud platforms upgrade
Introduction
Migrate to Java 11
Migrate to Java 17
Migrate to Java 21
Migrate historical User Activity Monitoring Plugin data
Traditional platforms upgrade
Introduction
Migrate to Java 11
Migrate to Java 17
Migrate to Java 21
Migrate historical User Activity Monitoring Plugin data
Set up
Introduction
Configure features using Manage Jenkins
Configure SAML
Use CloudBees CI Teams
Add external client controllers
Set up agents on CloudBees CI
Use WebSockets to connect controllers to the operations center
Deploy CloudBees CI across multiple Kubernetes namespaces and clusters
Add custom header labels to CloudBees CI
Connect inbound agents
Set up HTTPS for GKE
Best practices when building container images
Connect a client controller to operations center
Disconnect a client controller from operations center
Plugin management
Introduction
Plugin management
Get started with plugin management
CloudBees Assurance Program
Beekeeper Upgrade Assistant
Add Beekeeper plugin exceptions
Find the support tier for a plugin
Install plugins
Upgrade plugins from the Plugin Manager
Uninstall plugins
Disable plugins
Review plugin usage
Configure plugin catalogs
Manage plugins with Update Center
Manage plugins in a secure environment
Pipelines
Introduction
Get started
Introduction
Common Pipeline terms
Pipeline project types
CloudBees proprietary features for Pipelines
Plan for Pipelines
Introduction
Pipeline development utilities
Determine plugin compatibility
Pipeline best practices
Create Pipelines
Introduction
Pipeline prerequisites
Create your first Pipeline
Select an agent for your Pipeline job
Create a Pipeline from SCM
Create a Pipeline in the UI
Understand and implement Pipeline as Code
Automate with Jenkinsfile
Introduction
Configure advanced Scripted Pipeline
Configure the build stage
Configure the deploy stage
Configure optional step arguments
Configure the test stage
Create a Jenkinsfile
Customize parameters
Handle failures
String interpolation
Use multiple agents
Work with the environment
Reuse configuration files
Administer Pipelines
Introduction
Manage artifacts with CloudBees Fast Archiving plugin
Enable artifact traceability with fingerprinting
Trigger jobs with a simple webhook
Restore files
Visualize the Pipeline
Insert checkpoints
Secure Pipelines
Configure Pipelines with user-scoped credentials
Enforce standards with Pipeline Policies
Specify a matrix of one or more dimensions
Convert a Freestyle project to a Declarative Pipeline
Pipeline builds and High Availability (active/active)
Control builds
Introduction
Restart aborted builds
Long-running builds
Skip next build
Consolidated Build View plugin
CloudBees Quiet Start plugin
CloudBees Template plugin
CloudBees Workspace Caching
Remote collaboration features
Introduction
Trigger a job with a notification event using Cross Team Collaboration
Enable external notification events with external HTTP endpoints
Cluster-wide copy artifacts
Cluster-wide job triggers
Pipeline templates
Introduction
Set up a Pipeline Template Catalog
Define Pipeline Template Catalogs
Set up a Pipeline Template
Parameter types in the template.yaml file
Manage Multibranch Pipeline options in the template.yaml file
Manage Pipeline Template Catalogs in bulk
Example full Maven/Java app Jenkinsfile
Pipeline syntax reference
Introduction
Use Declarative Pipeline syntax
Use Scripted Pipeline syntax
Multibranch Pipeline Template syntax
Introduction
Branch Source
Bitbucket
GitHub
Git
Branch Property Strategy
Examples
Docker
CloudBees Docker Build and Publish plugin
CloudBees Docker Traceability
Docker Pipeline plugin
CloudBees Docker Hub/Registry Notification plugin
Troubleshoot Pipelines with CloudBees Pipeline Explorer
Introduction
Administer
Introduction
Modern cloud platforms
Introduction
Get started
Navigate the operations center interface
Provision agents in a separate Kubernetes cluster from a managed controller
Provision a controller in a different OpenShift project than the operations center
Manage controllers
Manage controllers in specific Kubernetes namespaces
Migrate an existing managed controller to High Availability (HA)
Manage agents
Manage SSH credentials
Shared agents
Shared configurations
Shared cloud configuration
Trigger restrictions
Change NFS storage location
Quiet start
Move/Copy/Promote
Cluster operations
Inbound agents
Use Kaniko with CloudBees CI
Use Buildkit with CloudBees CI
Using self-signed certificates in CloudBees CI on Kubernetes
Sidecar injector for self-signed certificates on OpenShift
Auto-scale nodes on EKS
Enable auto-scaling nodes on GKE
CloudBees Amazon Web Services Deploy Engine
CloudBees Amazon AWS CLI plugin
Cloud Foundry CLI Plugin
Integrate OpenShift CLI
CloudBees CI ServiceNow integration
Create projects based on a GitHub repository structure
Use GitHub App authentication
Create Multibranch Projects and Organization Folders with large repositories
WikiText plugin
Controller Lifecycle Notifications Plugin
Traditional platforms
Introduction
Get started
Navigate the operations center interface
Manage client controllers
Migrate from High Availability (active/passive) to High Availability (active/active) on CloudBees CI on traditional platforms
Managing agents
Manage SSH credentials
Shared agents
Shared configurations
Shared cloud configuration
Trigger restrictions
Quiet start
Move/Copy/Promote
Cluster operations
Inbound agents
CloudBees CI ServiceNow integration
Create projects based on a GitHub repository structure
Use GitHub App authentication
Create Multibranch Projects and Organization Folders with large repositories
WikiText plugin
Secure
Introduction
Trust model
Pod Security Admission
Centrally manage security for controllers
CyberArk Credential Provider Plugin
CloudBees HashiCorp Vault Plugin
Enable advanced use cases: Cross-controller triggers and bulk operations
Restrict access and delegate administration with Role-Based Access Control
Example RBAC configurations
Create secure folders with Role-Based Access Control Auto Configurer
Restrict job triggers
Set up operations center-level access controls
Set up access controls on connected controllers
Test the SSH connection to an agent
Configure restricted credentials with the CloudBees Restricted Credentials plugin
Folders plugin
Folders Plus plugin
Inject secrets into builds
Manage build agents with the Nodes Plus plugin
Extended security settings
Enhanced credentials masking
Understand Beekeeper security warnings
Prevent unauthorized interaction between builds
Security recommendations
Use single sign-on (SSO) in the operations center
CloudBees CI integration with Microsoft Entra ID
Operations center specific permissions
Authentication mapping
Delegate administration
Data collection for the CloudBees Analytics Plugin
Modern DevOps external secrets management
Replace an expired certificate
List of URLs that need access
Block access to URL patterns using the CloudBees Request Filter Plugin
Serve resources from Jenkins
Verify Helm charts with a signature
Maintain
Introduction
Backup and restore
Introduction
$JENKINS_HOME directory
Best practices for backup and restore
Back up $JENKINS_HOME manually
Backup a Role-Based Access Control configuration
Restore backup files manually
Restore credentials
Configure backups using the CloudBees Backup plugin
Schedule backups in the CloudBees Backup plugin
Restore backups created with the CloudBees Backup plugin
Backup and restore on Kubernetes
Backup and restore on AWS
Backup and restore Kubernetes cluster resources using Velero
Run backups using cluster operations
Jenkins CLI
Introduction
Configure multiple client controllers with the Jenkins CLI tool
Configure an alias for the Jenkins CLI tool
Configure Jenkins CLI tool with non-TrustStore TLS certificates
CloudBees Inactive Items Plugin
Jenkins Health Advisor by CloudBees
CloudBees Pull Request Builder for GitHub plugin
Count and monitor user licenses with the CloudBees User Activity Monitoring plugin
CloudBees CI Catalog Plugin - Catalog tool
Monitor
Introduction
Traditional platforms
Introduction
Collect metrics with the CloudBees Prometheus Metrics plugin
Create metric-based alerts
Elasticsearch Reporter
Enable GC logging of controllers
Modern cloud platforms
Introduction
Example implementation with Datadog
Audit
Continuous Integration build audit report
Configuration as Code
Introduction
Get started with CasC
CasC fundamentals
CasC requirements
CasC permissions
Recommended workflow
Create a CasC bundle
Introduction
Export a CasC configuration
Transform an exported bundle
Advanced CasC bundle configuration
Validate a CasC bundle
Configure your operations center using CasC
CloudBees CI CasC for operations centers
Get started with Configuration as Code for the operations center
Configure the operations center on modern platforms using CasC
Configure the operations center on traditional platforms using CasC
Retrieve bundles using an SCM
Troubleshoot CasC
Configure your controllers using CasC
CloudBees CI CasC for controllers
Get started with Configuration as Code for controllers
Distribute CasC bundles to controllers from your operations center
Add controller CasC bundles to the operations center
Configure bundle availability for controllers
Set up a client controller using CasC
Set up a managed controller using CasC
Set up a managed controller using the CasC Controller Bundle Service
Advanced topics
Troubleshoot CasC for controllers
Update a CasC bundle
Introduction
Update a CasC bundle
Bundle update timing
Review the CasC update log
Manage plugins with CasC
Introduction
Plugin management with CasC
Determine plugin compatibility using CasC
Create an alternate plugin download site
Create items using CasC
Configure RBAC with CasC
CasC CLI commands
CasC HTTP API
CasC bundle reference
Introduction
bundle.yaml file reference
jenkins.yaml file reference
plugins.yaml file reference
plugin-catalog.yaml file reference
items.yaml file reference
rbac.yaml file reference
variables.yaml file reference
App integrations
Introduction
SCM Integration
Introduction
Enable actionable build notifications in GitHub and Bitbucket
Configure CloudBees SCM Reporting notifications
Slack Integration
Introduction
Set up actionable build notifications in Slack
Configure CloudBees CI Slack Integration users
Configure CloudBees CI Slack Integration notifications
Microsoft Teams Integration
Introduction
Set up actionable build notifications in Microsoft Teams
Configure Microsoft Teams Integration notifications
Troubleshoot
Introduction
Azure Kubernetes Service (AKS)
AWS
EKS
GKE
Kubernetes
TKGI
High Availability (active/passive) installation troubleshooting
High Availability (active/active) troubleshooting
Collect cluster logs
Update Center certificate errors
CloudBees CI JVM troubleshooting
Performance decision tree for troubleshooting
Troubleshoot memory leaks
Troubleshoot file and thread leaks
Reference
Introduction
Kubernetes on AWS EKS
Azure Kubernetes Service (AKS)
Kubernetes on GKE
Kubernetes on AWS
Kubernetes on-premise and OpenShift
Kubernetes on VMware Tanzu Kubernetes Grid Integrated Edition
Traditional platforms
Performance reports
HA on EKS Performance Test
Support tools
Generate a support bundle
Legal and policies
Support policies
Troubleshooting installation
1 minute read
This section provides troubleshooting for CloudBees CI installation.
Submit Feedback