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 Help
Beta
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.io
CloudBees Feature Management
CloudBees Release Orchestration SaaS
CloudBees Value Stream Management
Other CloudBees Products
CloudBees Build Acceleration
CloudBees CodeShip
CloudBees Jenkins Platform
Documentation
Documentation
Automation Platform (Legacy)
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.10.0)
latest (2023.10.0)
2023.08.0
2023.06.0
2023.04.0
2023.03.0
2023.02.0
10.11
10.10
Legacy Versions
10.9 (Legacy)
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
Introduction
CloudBees CD/RO APIs
Introduction
Plan
Introduction
CloudBees CD/RO 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 the CloudBees Analytics server 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
Introduction
Configuration settings preserved after a Kubernetes upgrade
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 a traditional upgrade
Set up
Configure CloudBees CD/RO
Introduction
Zones and gateways
Configure custom CAs and CRLs in non-clustered environments
Configure custom CAs and CRLs in clustered environments
Configure agent environment variables
Licenses
Create and manage users and groups
Active users
Create or edit a local user
User details
Groups
Create or edit a local group
Group details
Personas
Configure an external database
Configure CloudBees CD/RO to use an alternate database
Install services for non-root/non-sudo Linux installations
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
Get started
Sign in to CloudBees CD/RO
Access the Home page
My work dashboard
Guided tutorials
Learn about the object model
Search and filter
Create and modify properties
Introduction
Intrinsic properties listed by object type
Reserved words in CloudBees CD/RO
Special characters in CloudBees CD/RO object names
Context-relative shortcuts to property paths
Property error codes
Configure properties or property sheets
Property Browser
Property reference use case
Create and manage resources
Introduction
Resource pools
Create or edit resource pools
Resource pool details
Define and use workspaces
Introduction
View workspaces
Create or edit workspaces
Workspace file
Create and manage projects
Introduction
Create a project
Schedules
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
View pipeline runs
Example: Create a manual task in a pipeline
Example: Plugin pipeline tasks
Example: Integrate test automation in release pipelines
Example: Leverage test data management and service virtualization in release pipelines
Create and manage releases
Introduction
Release and environment reservations calendar
Visibility and status of release pipelines
Release definition
Deploy with Argo Rollouts
Release dashboard
Planned versus actual view for pipeline status
Path to production view
Release summary
Run and end releases
Service catalog
Introduction
Create and manage procedures
Introduction
Manage procedure runs
Procedure run details
Using CloudBees CD/RO in your environment
Job step execution
Preflight Builds
Postprocessors: Collecting data for reports
Design and manage processes with workflows
Introduction
Workflow lists
Create or edit workflow definitions
Workflow definition details
Run workflow
Workflow details
Workflow Log
Transition workflow
Define parameters
Introduction
Create applications and processes
Introduction
Create and manage applications
Application process run details
Create processes
Add process steps
Process branching
Configure plugin process steps
Define manual steps and tasks
Example: Manual step with runtime parameters
Attach credentials to processes
Full-stack dependency view
Application deployment options
Configuration drift
Create master components
Introduction
Master component examples
Master components list
Model and deploy microservice applications
Introduction
Model and deploy traditional applications
Introduction
Stage artifacts
Capture snapshots
Application rollback
Manage dependencies
Deploy applications into environments
Introduction
Create environments
Define environment tier maps
Inventory tracking
Environment inventory
Global environment inventory
Environment reservations
Lock environments
Model dynamic environments
Automated environment discovery
Create a deployment task to trigger third-party tools
Generate a deployment package
Example: Dynamic environment with Amazon and Chef
Example: Deploy and troubleshoot applications
Example: Deploy applications with provisioned cloud resources
Example: Implement deployment strategies
Manage artifacts
Introduction
CloudBees CD/RO artifacts
Create or edit artifacts
Artifact versions
Edit an existing artifact version
Repositories
Create object tags and schedules
Create object tags
Create object schedules
Configure event-based triggers
Introduction
Configure webhook triggers
Configure polling triggers
Notifications
Introduction
Configure email notifications
Select and edit email messages for application or microservice processes
Automate workflows with GitHub Actions
Introduction
Plugin management
Introduction
Install plugins
Create plugin configurations
Manage plugins
Create plugins
Manage the plugin catalog
Developer task: Create custom plugins
Secure
Introduction
Access control
Introduction
System access control objects
View and change access control privileges on objects
Access control lists
Access control inheritance
Access control for jobs
Access control scenarios for pipelines, releases, and procedures
Access control examples for increased security
Credentials
Introduction
Credential management
Credentials in pipelines
Use case: Attach credentials in deployment automation
Impersonation concepts
Enhanced security configurations
Introduction
Enable or disable cross-site request forgery protection
Configure HTTP Strict Transport Security
Maintain
Maintain CloudBees CD/RO
Back up a CloudBees CD/RO server
Restore a CloudBees CD/RO server
Change the database password
Switch to an alternate database
Switch from an alternate database to the built-in database
Collect CloudBees CD/RO logs
View event logs
Generate a new Apache web server or agent certificate
Start and stop servers and agents manually
Maintain CloudBees Analytics
Introduction
Maintain CloudBees Analytics server data
Maintain CloudBees Analytics server data on Kubernetes
Start and stop servers and agents manually
Tools and utilities
Introduction
chkconfig
ClusterInfoTool
eccert
ecconfigure
ecdaemon
ecproxy
ecremotefilecopy
ZKConfigTool
Monitor
Introduction
Manage data with CloudBees Analytics
Introduction
Understand the CloudBees Analytics data model
Create a report
Elasticsearch basics
Extend the data model
CloudBees Analytics custom dashboards
Introduction
Create a new dashboard
Copy an existing dashboard
Manage widgets
Export dashboards to PDF
CloudBees Analytics built-in dashboards
Introduction
Application Deployments dashboard
CI Plugin Usage dashboard
CI Workload Insights dashboard
Code Commit Trends dashboard
Continuous Integration dashboard
DORA metrics
Microservice Deployments dashboard
Release Command Center dashboard
Releases dashboard
Audit
Data retention
Audit reports
Introduction
Change tracking
Introduction
Performance consequences of change tracking
Estimate database growth
Best practices for change tracking
Configure change tracking
Search the change history
View the change history
Modify what you see in the change history
Revert changes to a tracked object and its tracked contents
Export a tracked object’s previous state
Troubleshoot
Introduction
CloudBees CD/RO server is unresponsive and displays an outofmemory error
Windows PHP does not handle time zones correctly
CloudBees CD/RO self-signed server certificate fails security scan
AES-encoded passkey was accidentally overwritten
CloudBees CD/RO CA or intermediate CA certificate expires
Linux upgrade breaks symbolic links
Built-in database schema on disk is older than required for upgrade
Troubleshoot pipelines
Clean up stalled jobs
Troubleshoot the data pipeline between CloudBees Analytics and CloudBees CI
Legal and policies
Support policies
Feature definitions
Third-party libraries
CloudBees CD/RO
CloudBees CD/RO automates and orchestrates software releases, pipelines, and deployments — personalized for each user — with the analytics and insight to measure, track, and improve results.
Watch the overview
Quick links
Onboarding
What's new
Troubleshooting
Onboard
Start here. Our onboarding page is a map that guides new users through our documentation so that you can learn, plan, install, set up, and operate.
Advanced, Model-Based Deployment
Make releases boring by replacing brittle scripts with powerful, reusable abstract models. Enable predictable, repeatable deployments for any workload to any environment at any scale.
Process-as-Code
Onboard applications quickly and define release pipelines with a Groovy-based domain specific language (DSL) for automation that is versionable, testable, reusable, and refactorable.
Secure, Scalable, and Robust Architecture
Agent-based, clustering architecture for fault tolerance, unlimited scalability, and impenetrable security.
Unified Object and Data Model
Allow for tighter control over who has access to what resources to ensure the sanctity of the CI pipeline.
Key Metrics Across Releases and CI/CD Pipelines
Learn how to access and use raw data that goes into creating the CloudBees Analytics dashboards and reports.
Popular docs and resources
Architecture
CloudBees CD/RO supports enterprise-scale software production. Based on a three-tier architecture, CloudBees CD/RO scales to handle large, complex environments.
Installing on Kubernetes
Installing on Kubernetes is a preview feature, but users can explore using Helm to install.
CloudBees Analytics
With CloudBees Analytics, included with CloudBees CD/RO, track progress and identity patterns with 360º visibility into metrics across all CloudBees CD/RO processes.
Submit Feedback