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 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 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
9.2 (Legacy)
latest (2023.03.0)
2023.02.0
10.11
10.10
10.9
10.8
10.7
10.6
10.5
Legacy Versions
10.4 (Legacy)
10.3 (Legacy)
10.2 (Legacy)
10.1 (Legacy)
10.0 (Legacy)
9.2 (Legacy)
9.1 and earlier (Legacy)
Introduction
Architecture
Flow glossary
System requirements
Introduction
Flow server and agent compatibility
Flow server and DevOps Insight compatibility
Platform notes
Port usage
Hardware requirements
Browser requirements
Java requirements
Database requirements
Database sizing
Disk usage
Memory settings
Checksum utility
Software licenses
Installation on Kubernetes clusters (PREVIEW)
Installation on Kubernetes (PREVIEW)
Installation on traditional platforms
Introduction
Special-case installations
Installer options
Server topology best practices
Pre-installation checklist
Default installation directories
Graphical UI installation
Introduction
Express server
Advanced server
Express agent
Express Agent-only
Advanced Agent-only
DevOps Insight Server
Interactive Command-Line Installation
Introduction
Express server
Advanced server
Express Agent
Express Agent-only (standalone)
Advanced Agent-only (standalone)
DevOps Insight server installation
Silent unattended 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 DevOps Insight server installation example
Non-server platform UNIX agent installation
Introduction
UNIX agent interactive command-line
UNIX agent unattended
Installing remote agents
Introduction
Prerequisites
Permissions
Installing via the web interface
Installing via the API
Moving the artifact repository in Linux
Moving the artifact repository in Windows
Connecting Flow to a Microsoft SQL server
Installing the MySQL JDBC driver
Uninstalling CloudBees Flow
Introduction
Uninstalling CloudBees Flow on Linux, Unix, or macOS
Uninstalling CloudBees Flow on Windows
Uninstalling the CloudBees Flow DevOps Insight Server on Linux
Uninstalling the CloudBees Flow DevOps Insight Server on Windows
Signing in to Flow
Administration guide
General configuration
Introduction
The Default Zone and Gateways to Remote Zones
Applying an Enterprise License Key
External Database Configuration
Configuring CloudBees Flow to Use an Alternate Database
Configuring Server and Agent Services Autostart for Non-Root/Non-sudo Linux Installations
Universal Access to the Plugins Directory
Configuring Single Sign-On
Environment Proxy Server Configuration
Increasing File Descriptors on Linux
Adjusting Swappiness on Linux
Setting Variables on Windows Agent Machines
Configuring Kibana to Work With DevOps Insight
Horizontal scalability configuration
Introduction
Architecture of a CloudBees Flow 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 Flow 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 Flow server cluster from zookeeper
Adding a node to an existing cluster
Configuring web server properties
Configuring repository server properties
Configuring Flow agents
Configuring the cluster workspace
Configuring Flow repositories
Adding trusted agents to clusters
Verifying Flow services
Accessing Flow with clustering
Health check for the Flow cluster
Additional Ways to improve a cluster
Installing the DevOps Insight server in cluster mode
Disaster recovery
Maintenance
Introduction
CloudBees Flow server backups
Restoring a Flow Server
Switching to an alternate database
Switching to the built-in database
Maintaining DevOps Insight server data
Apache web server or agent certificates
Using chkconfig
Starting and stopping servers and agents manually
Collecting Flow logs
Web interface online help system
Upgrade guide
Upgrade roadmap for traditional platforms
Upgrading a non-clustered environment
Upgrading a clustered environment
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 DevOps Insight server
Configuration settings preserved after an upgrade
User guide
Introduction to CloudBees Flow
Introduction
CloudBees Flow Architecture
Roadmap to CloudBees Flow
Plugins and Cloudbees Field-Contributed Solutions
Guided Tutorials
Deploy UI Elements
Introduction
Signing in to CloudBees Flow
Home Page
Personas
Access Control
My Work Dashboard
Object List Layout
Object Schedules
Pagination
Searching and Filtering
Hierarchy Menu
Property Browser
Projects in CloudBees Flow
Object Tags
Deployment Automation
Introduction
Applications and Processes
Environments
Creating or Editing a Project in the Deploy Web UI
Parameters
Master Components
Master Component Examples
Master Components List UI
Artifact Staging
Rollback
Managing Application or Microservice Dependencies
Manual Steps and Tasks
Process Branching
Property Reference Use Case
Snapshots
Inventory Tracking
Environment Inventory
Microservice Deployment Using Containers
Deployment Packages
Deployment Strategies
Deployment Examples
Automated Environment Discovery
Environment Reservations
Full-Stack Dependency View
Configuration Drift
Deployment Examples
Introduction
Guidelines for Modeling and Deploying Applications in CloudBees Flow
Examples: Modeling and Deploying Applications
Example: Manual Step with Runtime Parameters
Attaching Credentials to Application and Component Processes
Plugin Process Steps
Adding Process Steps
Deploying Applications in Dynamic Environments
Introduction
Modeling Dynamic Environments
Deploying Applications with Provisioned Cloud Resources
Retiring Dynamic Environments
Dynamic Environment Example with Amazon and Chef
Developer Task: Creating Custom Plugins
Pipeline concepts
Introduction
Pipeline stages and gates
Pipeline access control
Pipeline tasks
Entry and exit gates
Pipeline conditions
Pipeline start and end stages and stage skipping
Wait dependencies
Event-based triggers
Pipeline UI
Authoring and running pipelines
Introduction
Defining gate approvals
Pipeline objects and conditions
Pipeline stage summary
Credentials in pipelines
Running pipelines
Viewing pipeline runs
Troubleshooting 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
Release Management
Introduction
Release Concepts
Release Planning, Scheduling, and Tracking
Release and Environment Reservations Calendar
Visibility and Status of Release Pipelines
Release Definition
Release Dashboard
Planned Versus Actual View
Path to Production View
Release Summary
Running and Ending Releases
Data Retention
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
Self-Service Catalogs
Notifications
Introduction
Setting Email Notifications
Selecting and Editing Email Messages for Application or Microservice Processes
DevOps Insight user guide
DevOps Insight Overview
Understanding the DevOps Insight Data Model
Creating a Report
Creating a Dashboard
Introduction
Creating a New Dashboard Using the UI
Copying an Existing Dashboard
Adding Widgets to an Existing Dashboard
Elasticsearch Basics
Extending the Data Model
Dashboard Reference
Introduction
Viewing a Dashboard
Releases Dashboard
Application Deployments Dashboard
Microservice Deployments Dashboard
Release Command Center Dashboard
Continuous Integration Dashboard
Code Commit Trends Dashboard
Configuring the DevOps Insight Server
DevOps Foresight install and user guide
Introduction
Platform notes
Introduction
Software Licenses
Installing DevOps Foresight
Introduction
Graphical User Interface Installation
Interactive Command-Line Installation
Silent Unattended Installation Example
Configuration
Upgrading
Uninstalling
Introduction
Uninstalling on Linux
Uninstalling on Windows
Security guide
Introduction
Credentials and user impersonation
Credentials application and component processes
Use Case: using credentialsin deployment automation
credentials in pipelines
credentials in releases
Cross-site request forgery protection
Plugins guide
Plugin list
Troubleshooting guide
Introduction
CloudBees Flow server is unresponsive and displays an outofmemory error
Windows PHP does not handle time zones correctly
CloudBees Flow self-signed server certificate fails security scan
CloudBees Flow CA or intermediate CA certificate expires
Linux upgrade breaks symbolic links
Built-In database schema on disk is older than required by CloudBees Flow server for upgrade
Automation platform guide
Introduction
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 Flow
Using Cloudbees Flow in Your Environment
CloudBees Flow Installed Tools
Automation Platform Tasks
Introduction
Access Control
Defining entries
Privileges - create new or edit existing privileges
Artifacts
Artifact details
Create new or edit existing artifact
Artifact versions
Artifact version details
Edit an existing artifact version
Repositories
Create new or edit existing repositories
Email configurations
Create new or edit existing email configurations
Email Notifiers
Procedure Details
Create new or edit existing procedure
Create new or edit existing step
Publish Artifact Version step
Retrieve Artifact Version step
Send Email step
New Extract Preflight Sources step
Parameter - create new or edit existing parameter
Projects
Create new or edit existing project
Project Details
Run Procedure
Create new or edit existing schedule
Create new or edit existing credential
Property - create new or edit existing property
Nested Property Sheet
Reports
Create a new report
Searching and Filtering
Search Results
Source Control Configurations
Create new or edit existing configurations
Users
Users and Groups
Create new or edit existing local user
User Details
Edit User Settings
Groups
Create new or edit existing group
Group Details
Directory Providers
Create new or edit existing directory providers
Single Sign-On
Test Directory Provider
Workflows
Workflow Definition - create new or edit exiting workflow definition
Workflow Definition Details
Run Workflow
Workflow Details
Workflow Log
Transition Workflow
Workspaces
Workspace - create new or edit existing workspace
Workspace file
Database Configuration
Defect Tracking Configurations
Defect Tracking - create new or edit existing configuration
Defect Tracking Reports
Event Log
Home Page
Job Configuration
Shortcuts
Jobs Quick View
New Report
Jobs
Job Step Details
Licenses
View License
Import License
Plugin Manager
Resources/Pools
Resource Pools
Resource Pool - create new or edit existing pool
Resource Pool Details
Zones
Gateways
Server
Settings - edit existing property settings
Automation Platform Objects and Functionality
Introduction
Access Control
Artifact Management
Authenticating Users for LDAP and Active Directory
Auto-Discovery
Defect Tracking
ElectricSentry
Job Step Execution Environment
Preflight Builds
Properties
Postprocessors
Reports
Workflow Overview
Workspaces and Disk Space Management
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
Legal and policies
Support policies
Supported platforms
CloudBees subscription and services agreement
Feature definitions
Maintaining CloudBees Flow
1 minute read
You are browsing an older version of this page.
Click here
to view the latest released version.
Refer to
Maintenance Lifecycle
for details.
This section contains common maintenance procedures.
CloudBees Flow server backups
Submit Feedback