Introduction
Architecture
Introduction
Use cases
CloudBees field-contributed plugins and solutions
Pre-installation checklist for traditional platforms
System requirements
IntroductionCloudBees CD/RO server and agent requirementsCloudBees Analytics server requirementsPlatform notesKubernetes cluster and storage requirementsPort usageDatabase requirementsDisk usageMemory settingsChecksum utilitySoftware licenses
Kubernetes installation
IntroductionInstallationFrequently asked questionsConfiguration values
Traditional installation
IntroductionSpecial-case installationsInstaller optionsServer topology best practicesDefault installation directories
Graphical UI traditional installation
IntroductionDefault configurationCustom configurationExpress agentExpress agent-onlyAdvanced agent-onlyCloudBees Analytics server
Interactive command-line traditional installation
IntroductionExpress serverAdvanced serverExpress agentExpress agent-only (standalone)Advanced agent-only (standalone)CloudBees Analytics server installation
Silent unattended traditional installation
IntroductionSilent install overviewSilent install argumentsLinux installation examplesWindows installation examplesLinux repository server installation exampleWindows repository server installation exampleWindows or Linux CloudBees Analytics server installation example
Non-server platform UNIX agent installation
IntroductionUNIX agent interactive command-lineUNIX agent unattended
Remote agent tradition installation
IntroductionPrerequisitesPermissionsInstalling via the web interfaceInstalling via the API
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
IntroductionUninstalling CloudBees CD/RO on Linux, Unix, or macOSUninstalling CloudBees CD/RO on WindowsUninstalling the CloudBees Analytics Server on LinuxUninstalling the CloudBees Analytics Server on Windows
Signing in to CloudBees CD/RO
Introduction
Upgrading a non-clustered environment
Upgrading a clustered environment
Choosing the correct upgrade method
IntroductionUser interface upgrade methodInteractive command-line upgrade methodSilent (unattended) upgrade methodCopying repository contents
Upgrading remote agents
Upgrading the CloudBees Analytics server
Configuration settings preserved after an upgrade
Introduction
Microservice applications
Traditional applications
IntroductionArtifact stagingSnapshotsRollbackManaging dependencies
Processes
IntroductionApplications and processesCreating processesAdding process stepsProcess branchingPlugin process stepsManual steps and tasksExample: manual step with runtime parameters
Environments
IntroductionCreating environmentsCreating environment tier mapsInventory trackingEnvironment inventoryEnvironment reservationsEnvironment lockingModeling dynamic environmentsAutomated environment discoveryExample: dynamic environment with Amazon and Chef
Master Components
IntroductionMaster Component ExamplesMaster components list
Deployment strategies
IntroductionApplication deploy optionsDeploying and troubleshooting applicationsDeployment packagesDeployment examplesDeploying applications with provisioned cloud resourcesExample: implementing deployment strategies
Property reference use case
Creating a project
Parameters
Full-stack dependency view
Configuration drift
Attaching credentials to processes
Developer task: creating custom plugins
Introduction
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
IntroductionPipeline concepts
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
Native CI integration
Event-based triggers
Pipeline UI
IntroductionAuthoring and running pipelines
Defining gate approvals
Pipeline objects and conditions
Pipeline stage summary
Credentials in pipelines
IntroductionPipeline examples
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
Home page
Personas
Access control
My work dashboard
Object list layout
Object schedules
UI elements
IntroductionPaginationSearching and filteringHierarchy menuProperty browserProjects in CloudBees CD/ROObject tags
Tools and utilities
IntroductionCleanupStalledJobClusterInfoTooleccertecconfigureecdaemonecproxyecremotefilecopyZKConfigtool
General configuration
IntroductionThe default zone and gateways to remote zonesSetting agent environment variablesLicensesExternal Database ConfigurationConfiguring CloudBees CD/RO to Use an Alternate DatabaseConfiguring autostart for non-root/non-sudo Linux installationsUniversal access to the plugins directoryEnvironment proxy server configurationSystem health monitoringIncreasing file descriptors on LinuxAdjusting swappiness on LinuxSetting variables on Windows agent machinesConfiguring Kibana to work with CloudBees AnalyticsServer settings
Data Retention
Change tracking
IntroductionPerformance consequences of change trackingEstimating database growthBest practices for change trackingConfiguring change trackingSearching the change historyViewing the change historyModifying what you see in the change historyReverting changes to a tracked object and its tracked contentsExporting a previous state of a tracked object and its tracked contents
Notifications
IntroductionSetting Email NotificationsSelecting and Editing Email Messages for Application or Microservice Processes
Producing audit reports
Configuration drift
Self-Service Catalogs
Horizontal scalability configuration
IntroductionArchitecture of a CloudBees CD/RO ClusterResource, agent, and procedure considerationsSoftware for clusteringDependencies for clusteringConfiguring clusteringSeparating agents from flow serversPreparing your cluster resourcesInstalling and configuring a load balancerInstalling ZooKeeperConfiguring a multi-ZooKeeper clusterInstalling CloudBees CD/RO softwareConfiguring repository serversConfiguring machines to operate in clustered modeRunning a cluster in single-server modeAdding the configuration to ZooKeeperUploading configuration files to ZooKeeperGetting Information on the CloudBees CD/RO server cluster from ZooKeeperAdding a node to an existing clusterConfiguring web server propertiesConfiguring repository server propertiesConfiguring CloudBees CD/RO agentsConfiguring the cluster workspaceConfiguring CloudBees CD/RO repositoriesAdding trusted agents to clustersVerifying CloudBees CD/RO servicesAccessing CloudBees CD/RO with clusteringHealth check for the CloudBees CD/RO clusterAdditional Ways to improve a clusterInstalling the CloudBees Analytics server in cluster modeDisaster recovery
Introduction
Credentials and user impersonation
Credential management
Using credentials
Impersonation concepts
Use Case: using credentials in deployment automation
Cross-site request forgery protection
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
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
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
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
Introduction
Build-test automation
Getting started
IntroductionScenario 1 - Creating a simple procedureScenario 2 - Creating a procedure that uses an SCMScenario 3 - Notification, scheduling, and reportingScenario 4 - Multi-agent build and test
Automation platform setup
IntroductionAutomation platform home pageCustomizing the automation platform UIConfiguring CloudBees CD/ROUsing CloudBees CD/RO in your environmentCloudBees CD/RO Installed tools
Automation platform objects
IntroductionAccess controlArtifact managementAuthenticating users for ldap and active directoryAuto-discoveryDefect trackingElectricSentryJob step execution environmentPreflight buildsPostprocessorsReportsWorkflow overviewWorkspaces and disk space management
Properties
IntroductionIntrinsic propertiesProperty shortcutsProperty error codes
Tutorials
IntroductionAdding a link to a jobCalling a subprocedureChecking the outcome of preceding stepsConditional executionCustom parameter layoutsEmail notificationsExecuting tasks on all resources in a poolFactory proceduresPostp extensionPublishing and retrieving an artifactReserving a resource for the job step durationRunning steps in parallelStep timeouts and steps that always runStoring and retrieving properties in a jobWorking with properties stored in a procedure
Using special characters in object names
Access control
IntroductionDefining entriesCreate new or edit existing privileges
Artifact management
IntroductionArtifact detailsCreate new or edit existing artifactsArtifact versionsArtifact version detailsEdit an existing artifact versionRepositoriesCreate new or edit existing repositories
Database configuration
Defect tracking
IntroductionCreate new or edit existing configurationsDefect tracking reports
Email configurations and notifiers
IntroductionCreate new or edit existing email configurationsEmail notifiers
Event log
Home page
IntroductionJob configurationShortcutsJobs quick view
Jobs
IntroductionJob step details
Licenses
IntroductionView licenseImport license
Plugin manager
Procedures, steps, and parameters
IntroductionCreate new or edit existing procedureCreate new or edit existing stepsPublish artifact version stepsRetrieve artifact version stepsSend email stepsExtract preflight sources stepsCreate new or edit existing parameters
Projects, schedules, and credentials
IntroductionCreate new or edit existing projectsProject detailsRun proceduresCreate new or edit existing schedulesCreate new or edit existing credentials
Properties
IntroductionNested Property Sheet
Reports
Resources and pools
IntroductionResource poolsCreate new or edit existing poolsResource pool detailsZonesGateways
Search
IntroductionSearch results
Server
IntroductionEdit existing property settings
Source control
IntroductionCreate new or edit existing configurations
Users and groups
IntroductionUsersCreate new or edit existing local usersUser detailsEdit user settingsGroupsCreate new or edit existing groupsGroup detailsDirectory providersCreate new or edit existing directory providersSingle sign-onTest directory provider
Workflows
IntroductionCreate new or edit exiting workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow logTransition workflow
Workspaces
IntroductionCreate new or edit existing workspacesWorkspace file
Support policies
Supported platforms for traditional installations
Supported platforms for Kubernetes installations
Third-party libraries
CloudBees subscription and services agreement
Feature definitions

Default Installation Directories

1 minute readReference

CloudBees CD/RO uses the following default installation directories:

You can change the installation directories when you install the CloudBees CD/RO software.
Server topology best practices