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
cbsupport CLI
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
cbsupport CLI
Legal and policies
Software Delivery Automation
CloudBees Software Delivery Automation
CloudBees CI
CloudBees CD/RO
CloudBees Previews
Cloud-Native Platform
CloudBees platform
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.479.2.3)
latest (2.479.2.3)
2.479.1.4
2.479.1.3
2.462.3.3
2.462.2.2
2.462.1.3
2.452.3.2
2.452.2.4
2.452.2.3
2.452.1.2
2.440.3.8
2.440.3.7
2.440.2.1
2.440.1.4
2.440.1.3
2.426.3.3
2.426.2.2
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
Onboarding for modern cloud platforms
Onboarding 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
Installing
Verifying Docker images
Uninstalling
Amazon EKS installation
Introduction
Pre-installation requirements
Installing
Verifying Docker images
Uninstalling
GKE installation
Introduction
Pre-installation requirements
Installing
Verifying Docker images
Uninstalling
Kubernetes installation
Introduction
Pre-installation requirements
Installing
Verifying Docker images
Uninstalling
OpenShift installation
Introduction
Pre-installation requirements
Installing
Verifying Docker images
Uninstalling
TKGI installation
Introduction
Pre-installation requirements
Installing
Verifying Docker images
Uninstalling
Traditional platforms installation
Introduction
System requirements
Verifying Docker images
Installing operations center
Installing client controllers
Verifying build components
Verifying WAR files
High availability
Introduction
HA (active/active) fundamentals
Installation on modern cloud platforms (active/active)
Installation on traditional platforms (active/active)
HA (active/active) considerations
Specific 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-2 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-2 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
Migrating historical User Activity Monitoring Plugin data
Traditional platforms upgrade
Introduction
Migrate to Java 11
Migrate to Java 17
Migrating historical User Activity Monitoring Plugin data
Set up
Introduction
Configuring features using Manage Jenkins
Using CloudBees CI Teams
Adding external client controllers
Connecting build agents
Using WebSockets to connect controllers to the operations center
Deploy CloudBees CI across multiple Kubernetes clusters
Adding custom header labels to CloudBees CI
Connecting inbound agents
Setting up HTTPS for GKE
Best practices when building container images
Connecting a client controller to operations center
Plugin management
Introduction
Plugin management
Getting started with plugin management
CloudBees Assurance Program
Beekeeper Upgrade Assistant
Adding Beekeeper plugin exceptions
Finding the support tier for a plugin
Installing plugins
Upgrading plugins from the Plugin Manager
Uninstalling plugins
Disabling plugins
Reviewing plugin usage
Configuring plugin catalogs
Managing plugins with Update Center
Managing plugins in a secure environment
Pipelines
Introduction
Getting started
Introduction
Pipeline terms
Pipeline project types
CloudBees Pipeline benefits
Planning for Pipelines
Introduction
Using Pipeline development utilities
Determining plugin compatibility
Pipeline best practices
Creating Pipelines
Introduction
Prerequisites
Creating your first Pipeline
Selecting agents
Creating Pipelines in SCM
Creating Pipelines in Web UI
Using Pipeline as Code
Automating with Jenkinsfile
Introduction
Config Adv Scripted
Config Build Stage
Config Deploy Stage
Config Optional Step Args
Config Test Stage
Creating Jenkinsfile
Customizing Parameters
Handling Failures
String Interpolation
Using Multiple Agents
Working With The Env
Reusing Configuration Files
Administering Pipelines
Introduction
Managing artifacts
Tracing artifacts
Triggering jobs with a simple webhook
Restoring files
Visualizing Pipeline
Inserting checkpoints
Securing Pipelines
Configuring Pipelines with user-scoped credentials
Using Pipeline Policies
Specifying a matrix of one or more dimensions
Converting a Freestyle project to a Declarative Pipeline
Pipeline builds and HA (active/active)
Controlling builds
Introduction
Restarting 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
Setting up a Pipeline Template Catalog
Defining Pipeline Template Catalogs
Setting Up A Pipeline Template
Using parameters in template.yaml
Managing multibranch Pipeline options in template.yaml
Managing Pipeline Template Catalogs in bulk
Example full Maven/Java app Jenkinsfile
Pipeline syntax reference
Introduction
Using Declarative Pipeline syntax
Using Scripted Pipeline syntax
Multibranch Pipeline Template syntax
Introduction
Branch Source
Bitbucket
Git
Branch Property Strategy
Examples
Docker
CloudBees Docker Build and Publish plugin
CloudBees Docker Traceability
Docker Pipeline plugin
CloudBees Docker Hub/Registry Notification plugin
CloudBees Pipeline Explorer plugin
Introduction
Administer
Introduction
Modern cloud platforms
Introduction
Getting started
Navigating the operations center
Provisioning managed controllers in multiple Kubernetes clusters
Provisioning agents in a separate Kubernetes cluster from a managed controller
Provisioning a controller in a different namespace than the operations center
Provisioning a controller in a different OpenShift project than the operations center
Managing controllers
Manage controllers in specific Kubernetes namespaces
Migrating an existing managed controller to High Availability (HA)
Managing agents
Shared agents
Shared configuration
Shared cloud configuration
Trigger restrictions
Changing NFS storage location
Quiet start
Move/Copy/Promote
Cluster operations
Inbound agents
Using Kaniko
Using Buildkit (docker buildx)
Sidecar injector for self-signed certificates on Kubernetes
Sidecar injector for self-signed certificates on OpenShift
Using auto-scaling nodes on EKS
Using auto-scaling nodes on GKE
CloudBees Amazon Web Services Deploy Engine
Amazon Web Services CLI Plugin
Cloud Foundry CLI Plugin
Integrate OpenShift CLI
ServiceNow integration
Creating projects based on GitHub repository structure
Using GitHub App authentication
Create Multibranch Projects and Organization Folders with large repositories
WikiText plugin
Controller Lifecycle Notifications Plugin
Traditional platforms
Introduction
Getting started
Navigating the operations center
Managing client controllers
Migrating from High Availability (active/passive) to High Availability (active/active) on CloudBees CI on traditional platforms
Managing agents
Shared agents
Shared configuration
Shared cloud configuration
Trigger restrictions
Quiet start
Move/Copy/Promote
Cluster operations
Java web start agents
ServiceNow integration
Creating projects based on GitHub repository structure
Using GitHub App authentication
Create Multibranch Projects and Organization Folders with large repositories
WikiText plugin
Secure
Introduction
Trust model
Pod Security Admission
Centrally managing security for controllers
Cyberark Credential Provider Plugin
HashiCorp Vault Plugin
Enabling advanced use cases: cross controller triggers and bulk operations
Restricting access and delegating administration with Role-Based Access Control
Creating secure folders with Role-Based Access Control Auto Configurer
Restricting job triggers
Setting up operations center access controls
Setting up access controls on connected controllers
Testing the SSH connection to an agent
Configuring restricted credentials with the CloudBees Restricted Credentials plugin
Folders
Folders Plus
Injecting secrets into builds
Managing build agents with Nodes Plus plugin
Extended security settings
Enhanced credentials masking
Understanding Beekeeper security warnings
Preventing unauthorized interaction between builds
Security recommendations
Using single sign-on (SSO)
CloudBees CI integration with Microsoft Entra ID
operations center specific permissions
Authentication mapping
Example configurations
Delegating administration
Data collection for the CloudBees Analytics Plugin
External secrets management
Replacing an expired certificate
List of URLs that need access
Blocking access to URL patterns using the CloudBees Request Filter Plugin
Serving resources from Jenkins
Verifying Helm Charts Published with a Signature
Maintain
Introduction
Backup and restore
Introduction
$JENKINS_HOME directory
Best practices for backup and restore
Back up $JENKINS_HOME manually
Restore $JENKINS_HOME 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 clusters using Velero
Run backups using cluster operations
Jenkins CLI
Introduction
Configuring multiple client controllers with the Jenkins CLI tool
Configure an alias for the Jenkins CLI tool
Configuring 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
Collecting metrics
Creating 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
CasC fundamentals
CasC requirements
CasC permissions
CasC for operations center
Introduction
Getting started
Creating a bundle
Configuring the operations center on modern platforms
Configuring the operations center on traditional platforms
Retrieving bundles using SCM
Updating a bundle
Bundle update timing for the operations center
Viewing the operations center update log
Creating items
Configuring RBAC
Determining plugin compatibility
Troubleshooting
CasC for controllers
Introduction
Getting started
Creating a bundle
Adding controller bundles to the operations center
Updating a bundle
Bundle update timing for controllers
Viewing the controller update log
Configuring bundle availability
Setting up a managed controller
Setting up a client controller
Creating items
Configuring RBAC
Determining plugin compatibility
Advanced topics
Troubleshooting
Plugin management with CasC
Create an alternate plugin download site
CasC CLI commands
CasC HTTP API
App integrations
Introduction
SCM Integration
Introduction
Enabling actionable build notifications in GitHub and Bitbucket
Configuring CloudBees SCM Reporting notifications
Slack Integration
Introduction
Setting up actionable build notifications in Slack
Configuring CloudBees Slack Integration users
Configuring CloudBees Slack Integration notifications
Microsoft Teams Integration
Introduction
Setting up actionable build notifications in Microsoft Teams
Configuring CloudBees Microsoft Teams Integration users
Configuring CloudBees 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
Collecting cluster logs
Update Center certificate errors
CloudBees CI JVM troubleshooting
Performance decision tree for troubleshooting
Troubleshooting memory leaks
Troubleshooting 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
Support tools
Generating a support bundle
Legal and policies
Support policies
Troubleshooting installation
1 minute read
This section provides troubleshooting for CloudBees CI installation.
Submit Feedback