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 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
Search
New to CloudBees or returning.
Sign in / Sign up
CloudBees CD/RO
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 Feature Management
CloudBees Release Orchestration SaaS
CloudBees Value Stream Management
Other CloudBees Products
CloudBees Build Acceleration
CloudBees CodeShip
CloudBees Jenkins Platform
Documentation
Documentation
API reference (Stable)
DSL API reference (Preview)
Groovy API reference (Preview)
Perl API reference (Preview)
Plugin developer kit
Plugin documentation
Technical evaluation
Lexicon
Release notes
Knowledge Base
latest (2023.08.0)
latest (2023.08.0)
2023.06.0
2023.04.0
2023.03.0
2023.02.0
10.11
10.10
10.9
Legacy Versions
10.8 (Legacy)
10.7 (Legacy)
10.6 (Legacy)
10.5 (Legacy)
10.4 (Legacy)
10.3 (Legacy)
10.2 (Legacy)
10.1 (Legacy)
10.0 (Legacy)
9.2 (Legacy)
9.1 and earlier (Legacy)
Introduction
Product features
Advanced, model-based deployment
Process-as-code
Secure, scalable, and robust architecture
Unified object and data model
Introduction
Native CI pipeline integration
Key metrics across releases and CI/CD pipelines
Onboard
Learn
Architecture
CloudBees CD/RO APIs
Plan
Introduction
Use cases
CloudBees field-contributed plugins and solutions
Server topology best practices
Pipelines and releases
Deployment strategies
Pre-installation checklist for traditional platforms
System requirements
Introduction
CloudBees CD/RO server and agent requirements
CloudBees Analytics server requirements
Platform notes
Kubernetes cluster and storage requirements
Port usage
Database requirements
Disk usage
Memory settings
Checksum utility
Software licenses
Install
Kubernetes installation
Introduction
Install CloudBees CD/RO within Kubernetes
Configure Helm charts
Kubernetes platform-specific configurations
Kubernetes configuration options
Configure GitOps with Helm charts
Verify Helm charts
Create custom Docker images
Verify Docker images
Traditional installation
Introduction
Special-case installations
Installer options
Default installation directories
Verify installation binaries
UI installation methods
Introduction
Install a default configuration
Install a custom configuration
Run an express agent UI installation
Run an express UI installation (agent-only installer)
Run an advanced UI installation (agent-only installer)
Install CloudBees Analytics
Interactive command-line Linux traditional installation
Introduction
Run an express server command-line installation
Run an advanced command-line installation
Run an express agent command-line installation
Express agent command-line installation (agent-only installer)
Advanced command-line installation (agent-only installer)
Install with the interactive command-line installer
Silent unattended traditional installation
Introduction
Run a silent installation
Silent installation arguments
Linux silent installation examples
Windows silent installation examples
CloudBees Analytics server unattended installation
Non-server installation for UNIX agents
Introduction
UNIX agent interactive command-line installation
Silent installation method for UNIX or macOS agents
Remote host traditional installation with Centralized Agent Management
Introduction
Prerequisites
Permissions to install or upgrade remote agents
Install remote agents using the web interface
Install via the API
CloudBees Tools installation
Move the artifact repository
Move the artifact repository in Linux
Move the artifact repository in Windows
Connect CloudBees CD/RO to a Microsoft SQL server
Install the MySQL JDBC connector
Uninstall CloudBees CD/RO on traditional platforms
Introduction
Uninstall CloudBees CD/RO on Linux, Unix, or macOS
Uninstall on Window
Uninstall the CloudBees Analytics server on Linux
Uninstall the CloudBees Analytics server on Windows
Upgrade
Upgrade on Kubernetes
Upgrade on traditional platforms
Introduction
Upgrade a non-clustered environment
Upgrade a clustered environment
UI upgrade method
Interactive command-line upgrade method
Silent upgrade method
Copy repository contents
Upgrade remote agents
Upgrade the CloudBees Analytics server
Configuration settings preserved after an upgrade
Set up
Configure CloudBees CD/RO
Introduction
Zones and gateways
Configure agent environment variables
Licenses
Personas
Configure an external database
Configure CloudBees CD/RO to use an alternate database
Configure autostart for non-root/non-sudo Linux installations
Configure universal access to the plugins directory
Configure an environment proxy server
System health monitoring
Increase file descriptors on Linux and Linux Docker containers
Adjust swappiness on Linux
Set variables on Windows agent machines
Server properties
Server settings
Source code synchronization
Configure the CloudBees Analytics server
Introduction
Configure initial events for Workload Insights
Configure Kibana to work with CloudBees Analytics
Configure horizontal scalability
Introduction
Architecture of a CloudBees CD/RO cluster
Resource, agent, and procedure considerations
Software for clustering
Dependencies for clustering
Configure clustering
Separate agents from CloudBees CD/RO servers
Prepare your cluster resources
Install and configure a load balancer
Install ZooKeeper
Configure a multi-ZooKeeper cluster
Install CloudBees CD/RO software
Configure repository servers
Configure machines to operate in clustered mode
Run a cluster in single-server mode
Add the configuration to ZooKeeper
Upload configuration files to ZooKeeper
Get cluster information from ZooKeeper
Add a node to an existing cluster
Configure web server properties
Configure repository server properties
Configure CloudBees CD/RO agents
Configure the cluster workspace
Configure CloudBees CD/RO repositories
Add trusted agents to clusters
Verify CloudBees CD/RO services
Access CloudBees CD/RO with clustering
Health check for the CloudBees CD/RO cluster
Additional ways to improve a cluster
Install the CloudBees Analytics server in cluster mode
Use self-signed certificates in CloudBees CD/RO on Kubernetes
Configure Disaster Recovery and recover from a disaster
Operate
Sign in to CloudBees CD/RO
Access the Home page
Guided tutorials
Learn about the object model
Create and modify properties
Introduction
Intrinsic properties
Reserved words
Property shortcuts
Property error codes
Property Browser
Property reference use case
Create and manage projects
Introduction
Create a project
Create and run pipelines
Introduction
Pipeline stages and gates
Pipeline access control
Pipeline tasks
Use the CloudBees CD/RO API to define tasks
Entry and exit gates
Pipeline conditions
Pipeline start and end stages and stage skipping
Wait dependencies
Native CI integration
Pipeline UI
Author and run pipelines
Define stage gate rules
Pipeline objects and conditions
Pipeline stage summary
Credentials in pipelines
Run pipelines
Example: Create a manual task in a pipeline
Example: Plu