Documentation
Software Delivery Automation
CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews
Other CloudBees Products
CloudBees Build Acceleration CloudBees CodeShip CloudBees Jenkins Platform
CloudBees Platform
CloudBees.io CloudBees Feature Management CloudBees Release Orchestration SaaS CloudBees Value Stream Management
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 Feature Management CloudBees Release Orchestration SaaS CloudBees Build Acceleration
AI HelpBeta
Search
Enable dark mode
New to CloudBees or returning.
Sign in / Sign up

Resources

Account management cbsupport CLI Legal and policies

Software Delivery Automation

CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews

CloudBees Platform

CloudBees.io CloudBees Feature Management CloudBees Release Orchestration SaaS CloudBees Value Stream Management

Other CloudBees Products

CloudBees Build Acceleration CloudBees CodeShip CloudBees Jenkins Platform

Documentation API reference Migration guides Lexicon Release notes Knowledge Base

latest (2.440.2.1)2.440.2.1 2.440.1.4 2.440.1.3 2.426.3.3 2.426.2.2 2.426.1.3 2.426.1.2 2.414.3.8 2.414.3.7 2.414.2.2 2.414.1.4 2.401.3.4 2.401.3.3 2.401.2.6 2.401.2.5 2.401.2.3 2.401.1.3 2.387.3.5 2.387.3.3 2.387.2.4 2.387.2.3 2.387.1.2

Introduction Multicloud environment

Introduction CI as code Contextual pipeline feedback CloudBees CI ServiceNow integration

Introduction Modernized pipelines Secure CI/CD Velero for backup and restore

Introduction Enterprise team management and authorization

Introduction Optimize Continuous Integration Resources Enterprise Grade Plugin Management Plugin Usage Analyzer High Availability and Horizontal Scalability Debug Pipelines at Scale

Onboarding for modern cloud platforms

Onboarding for traditional platforms

Train your team

Architecture for modern cloud platforms

Architecture for traditional platforms

Feature comparison

Supported platforms for CloudBees CI on modern cloud platforms Supported platforms for CloudBees CI on traditional platforms

Modern cloud platforms

Traditional platforms

Introduction Pre-installation requirements Installing Verifying Docker images Uninstalling

Introduction Pre-installation requirements Installing Verifying Docker images Uninstalling

Introduction Pre-installation requirements Installing Verifying Docker images Uninstalling

Introduction Pre-installation requirements Installing Verifying Docker images Uninstalling

Introduction Pre-installation requirements Installing Verifying Docker images Uninstalling

Introduction Pre-installation requirements Installing Verifying Docker images Uninstalling

Introduction System requirements Verifying Docker images Installing operations center Installing client controllers Installing build agents Verifying build components Verifying WAR files

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

Introduction Migrate to Java 11 Migrate to Java 17 Migrating historical User Activity Monitoring Plugin data

Introduction Migrate to Java 11 Migrate to Java 17 Migrating historical User Activity Monitoring Plugin data

Introduction Configuring features using Manage Jenkins Using CloudBees CI Teams Adding external client controllers Using WebSockets to connect controllers to operations center Deploying CloudBees CI across multiple Kubernetes clusters Adding custom header labels to CloudBees CI Connecting inbound agents Launching inbound agents Setting up HTTPS for GKE Best practices when building container images

Introduction Configuring features using Manage Jenkins Adding external client controllers Connecting a client controller to operations center Adding custom header labels to CloudBees CI Connecting build agents

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

Introduction Pipeline terms Pipeline project types CloudBees Pipeline benefits

Introduction Using Pipeline development utilities Determining plugin compatibility Pipeline best practices

Introduction Prerequisites Creating your first Pipeline Creating Pipelines in SCM Creating Pipelines in Web UI Using Pipeline as Code

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

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)

Introduction Restarting aborted builds Long-running builds Skip next build Consolidated Build View plugin CloudBees Quiet Start plugin CloudBees Template plugin CloudBees Git Validated Merge plugin CloudBees Workspace Caching

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

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

Introduction Using Declarative Pipeline syntax Using Scripted Pipeline syntax

Introduction Branch Source Bitbucket Git Branch Property Strategy Examples

CloudBees Docker Build and Publish plugin CloudBees Docker Traceability Docker Pipeline plugin CloudBees Docker Hub/Registry Notification plugin

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 Managing 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 WikiText plugin

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 WikiText plugin

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

Introduction Configuring network requirements 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 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 Understanding Beekeeper security warnings Preventing unauthorized interaction between builds Security recommendations Extended security settings 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 List of URLs that need access Blocking access to URL patterns using the CloudBees Request Filter Plugin Serving resources from Jenkins

Introduction Explaining $JENKINS_HOME Best practices for backup and restore Backing up manually Restoring manually Restoring credentials Using the CloudBees Backup Plugin Scheduling your backups in the CloudBees Backup Plugin Restoring 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 Configuring multiple client controllers Configuring an alias for the Jenkins CLI tool Configuring the Jenkins CLI tool to work with non-TrustStore SSL certificates CasC bundle management on operations center

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

Collecting metrics

Creating metric-based alerts

Elasticsearch Reporter

Enable GC logging of controllers

Introduction Example implementation with Datadog

Continuous Integration build audit report

CasC fundamentals

CasC requirements

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

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

CasC CLI commands

Introduction Enabling actionable build notifications in GitHub and Bitbucket Configuring CloudBees SCM Reporting notifications

Introduction Setting up actionable build notifications in Slack Configuring CloudBees Slack Integration users Configuring CloudBees Slack Integration notifications

Introduction Setting up actionable build notifications in Microsoft Teams Configuring CloudBees Microsoft Teams Integration users Configuring CloudBees Microsoft Teams Integration notifications

Azure Kubernetes Service (AKS)

High Availability (active/passive) installation troubleshooting

High Availability (active/active) troubleshooting

Collecting cluster logs

Update Center certificate errors

CloudBees Jenkins JVM troubleshooting

Performance decision tree for troubleshooting

Troubleshooting memory leaks

Troubleshooting file and thread leaks

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

Generating a support bundle

cbsupport CLI documentation

Support policies

Controlling builds

1 minute read

CloudBees CI has several plugins that help control builds. This section describes how to use each of them.

Restarting aborted builds

© CloudBees, Inc. 2010 - 2024

Privacy Policy|Legal Notices|Security