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

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 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.04.0)2023.03.0 2023.02.0 10.11 10.10 10.9 10.8 10.7 10.6

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)

Advanced, model-based deployment

Process-as-code

Secure, scalable, and robust architecture

Unified object and data model

Introduction Native CI pipeline integration

CloudBees CD/RO APIs

CloudBees field-contributed plugins and solutions

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

Kubernetes installation

Introduction Installation Configuring Helm charts Platform-specific configurations Verifying Helm charts Creating Docker images Verifying Docker images How-tos

Traditional installation

Introduction Special-case installations Installer options Server topology best practices Default installation directories Verifying installation binaries

Graphical UI traditional installation

Introduction Default configuration Custom configuration Express agent Express agent-only Advanced agent-only CloudBees Analytics server

Interactive command-line traditional installation

Introduction Express server Advanced server Express agent Express agent-only (standalone)Advanced agent-only (standalone)CloudBees Analytics server installation

Silent unattended traditional installation

Introduction Silent install overview Silent install arguments Linux installation examples Windows installation examples Linux repository server installation example Windows repository server installation example Windows or Linux CloudBees Analytics server installation example

Non-server platform UNIX agent installation

Introduction UNIX agent interactive command-line UNIX agent unattended

Remote agent tradition installation

Introduction Prerequisites Permissions Installing via the web interface Installing via the API

CloudBees Tools installation

Moving the artifact repository in Linux

Moving the artifact repository in Windows

Connecting CloudBees CD/RO to a Microsoft SQL server

Installing the MySQL JDBC driver

Uninstalling CloudBees CD/RO

Introduction Uninstalling CloudBees CD/RO on Linux, Unix, or macOS Uninstalling CloudBees CD/RO on Windows Uninstalling the CloudBees Analytics Server on Linux Uninstalling the CloudBees Analytics Server on Windows

Signing in to CloudBees CD/RO

Upgrading a non-clustered environment

Upgrading a clustered environment

Upgrade CloudBees CD/RO on Kubernetes

Choosing the correct upgrade method

Introduction User interface upgrade method Interactive command-line upgrade method Silent (unattended) upgrade method Copying repository contents

Upgrading remote agents

Upgrading the CloudBees Analytics server

Configuration settings preserved after an upgrade

Configuring the CloudBees Analytics server

Introduction Configuring initial events for Workload Insights

Microservice applications

Traditional applications

Introduction Artifact staging Snapshots Rollback Managing dependencies

Processes

Introduction Applications and processes Managing Applications Creating processes Adding process steps Process branching Configuring plugin process steps Manual steps and tasks Example: manual step with runtime parameters

Environments

Introduction Creating environments Creating environment tier maps Inventory tracking Environment inventory Global environment inventory Environment reservations Environment locking Modeling dynamic environments Automated environment discovery Example: dynamic environment with Amazon and Chef

Master Components

Introduction Master Component Examples Master components list

Deployment strategies

Introduction Third-party Deployment Application deploy options Deploying and troubleshooting applications Deployment packages Deployment examples Deploying applications with provisioned cloud resources Example: implementing deployment strategies

Property reference use case

Creating a project

Full-stack dependency view

Configuration drift

Attaching credentials to processes

Developer task: creating custom plugins

Introduction

Introduction Release and Environment Reservations Calendar Visibility and Status of Release Pipelines Release Definition Deploy with Argo Rollouts Release Dashboard Planned Versus Actual View Path to Production View Release Summary Running and Ending Releases

Pipeline concepts

Introduction Pipeline stages and gates Pipeline access control Pipeline tasks Use 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

Authoring and running pipelines

Introduction Defining gate approvals Pipeline objects and conditions Pipeline stage summary Credentials in pipelines Run pipelines

Pipeline examples

Introduction Example: Creating a manual task in a pipeline Example: plugin pipeline tasks Example: integrating test automation in release pipelines Example: leveraging test data management and service virtualization in release pipelines Example: Surfacing Jenkins build details in Flow

Signing in to CloudBees CD/RO

Guided Tutorials

Viewing and changing access control privileges on objects

My work dashboard

Object list layout

Object schedules

Event-based triggers

UI elements

Introduction Pagination Searching and filtering Hierarchy menu Property browser Projects in CloudBees CD/RO Object tags

Tools and utilities

Introduction CleanupStalledJob ClusterInfoTool eccert ecconfigure ecdaemon ecproxy ecremotefilecopy ZKConfigtool

General configuration

Introduction The default zone and gateways to remote zones Setting agent environment variables Licenses External Database Configuration Configuring CloudBees CD/RO to Use an Alternate Database Configuring autostart for non-root/non-sudo Linux installations Universal access to the plugins directory Environment proxy server configuration System health monitoring Increasing file descriptors on Linux Adjusting swappiness on Linux Setting variables on Windows agent machines Configuring Kibana to work with CloudBees Analytics Server properties Server settings Source code synchronization GitOps configuration with Helm charts

Change tracking

Introduction Performance consequences of change tracking Estimating database growth Best practices for change tracking Configuring change tracking Searching the change history Viewing the change history Modifying what you see in the change history Reverting changes to a tracked object and its tracked contents Exporting a previous state of a tracked object and its tracked contents

Notifications

Introduction Setting Email Notifications Selecting and Editing Email Messages for Application or Microservice Processes

Producing audit reports

Configuration drift

Plugin management

Introduction Installing plugins Creating configurations Managing plugins Creating plugins Managing the plugin catalog

Self-Service Catalogs

Horizontal scalability configuration

Introduction Architecture of a CloudBees CD/RO Cluster Resource, agent, and procedure considerations Software for clustering Dependencies for clustering Configuring clustering Separating agents from flow servers Preparing your cluster resources Installing and configuring a load balancer Installing ZooKeeper Configuring a multi-ZooKeeper cluster Installing CloudBees CD/RO software Configuring repository servers Configuring machines to operate in clustered mode Running a cluster in single-server mode Adding the configuration to ZooKeeper Uploading configuration files to ZooKeeper Getting Information on the CloudBees CD/RO server cluster from ZooKeeper Adding a node to an existing cluster Configuring web server properties Configuring repository server properties Configuring CloudBees CD/RO agents Configuring the cluster workspace Configuring CloudBees CD/RO repositories Adding trusted agents to clusters Verifying CloudBees CD/RO services Accessing CloudBees CD/RO with clustering Health check for the CloudBees CD/RO cluster Additional Ways to improve a cluster Installing the CloudBees Analytics server in cluster mode Using self-signed certificates in CloudBees CD/RO on Kubernetes Disaster recovery

Access control

Introduction System access control objects Access control lists Access control inheritance Access control for jobs Access control for pipelines, releases, and procedures Access control examples

Credentials and user impersonation

Introduction Credential management Using credentials Use Case: Attaching credentials in deployment automation Impersonation concepts

Enhanced security configurations

CloudBees CD/RO server backups

Restoring a CloudBees CD/RO Server

Changing the database password

Switching to an alternate database

Switching to the built-in database

Maintaining CloudBees Analytics server data

Maintaining CloudBees Analytics server data on Kubernetes

Apache web server or agent certificates

Using chkconfig

Starting and stopping servers and agents manually

Collecting CloudBees CD/RO logs

Web interface online help system

Managing data with CloudBees Analytics

Introduction Data model Creating a report Elasticsearch basics Extending the data model

CloudBees Analytics custom dashboards

Introduction Creating a new dashboard Copying an existing dashboard Managing widgets Exporting dashboards to PDF

CloudBees Analytics built-in dashboards

Introduction Application Deployments CI Plugin Usage CI Workload Insights Code Commit Trends Continuous Integration DORA metrics Microservice Deployments Release Command Center Releases

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

The AES 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 by CloudBees CD/RO server for upgrade

Troubleshooting pipelines

Troubleshooting the data pipeline

Build-test automation

Getting started

Introduction Scenario 1 - Creating a simple procedure Scenario 2 - Creating a procedure that uses an SCM Scenario 3 - Notification, scheduling, and reporting Scenario 4 - Multi-agent build and test

Automation platform setup

Introduction Automation platform home page Customizing the automation platform UI Configuring CloudBees CD/RO Using CloudBees CD/RO in your environment CloudBees CD/RO Installed tools

Automation platform objects

Introduction Artifact management Authenticating users for ldap and active directory Auto-discovery Defect tracking ElectricSentry Job step execution environment Preflight builds Postprocessors Reports Workflow overview Workspaces and disk space management

Properties

Introduction Intrinsic properties Reserved words Property shortcuts Property error codes

Tutorials

Introduction Adding a link to a job Calling a subprocedure Checking the outcome of preceding steps Conditional execution Custom parameter layouts Email notifications Executing tasks on all resources in a pool Factory procedures Postp extension Publishing and retrieving an artifact Reserving a resource for the job step duration Running steps in parallel Step timeouts and steps that always run Storing and retrieving properties in a job Working with properties stored in a procedure

Using special characters in object names

Access control

Introduction Defining entries Create new or edit existing privileges

Artifact management

Introduction Artifact details Create new or edit existing artifacts Artifact versions Artifact version details Edit an existing artifact version Repositories Create new or edit existing repositories

Database configuration

Defect tracking

Introduction Create new or edit existing configurations Defect tracking reports

Email configurations and notifiers

Introduction Create new or edit existing email configurations Email notifiers

Home page

Introduction Job configuration Shortcuts Jobs quick view

Jobs

Introduction CloudBees CD/RO job details Job step details

Procedures, steps, and parameters

Introduction Procedure runs Create new or edit existing procedure Create new or edit existing steps Publish artifact version steps Retrieve artifact version steps Send email steps Extract preflight sources steps Create new or edit existing parameters

Projects, schedules, and credentials

Introduction Project details Create new or edit existing schedules Create new or edit existing credentials

Properties

Introduction Nested Property Sheet

Resources and pools

Introduction Resource pools Create new or edit existing pools Resource pool details

Search

Introduction Search results Edit existing property settings

Source control

Introduction Create new or edit existing configurations

Users and groups

Introduction Users Create new or edit existing local users User details Edit user settings Groups Create new or edit existing groups Group details Create new or edit existing directory providers Single sign-on Test directory provider

Workflows

Introduction Create new or edit exiting workflow definitions Workflow definition details Run workflow Workflow details Workflow log Transition workflow

Workspaces

Introduction Create new or edit existing workspaces Workspace file

Support policies

Feature definitions

Third-party libraries

Maintaining CloudBees CD/RO

1 minute readReference

This section contains common maintenance procedures.

© CloudBees, Inc. 2010 - 2023

Privacy Policy|Legal Notices|Security