IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsConfigure GitOps with Helm chartsVerify Helm chartsCreate custom Docker imagesVerify Docker images
IntroductionSpecial-case installationsInstaller optionsDefault installation directoriesVerify installation binaries
IntroductionInstall a default configurationInstall a custom configurationRun an express agent UI installationRun an express UI installation (agent-only installer)Run an advanced UI installation (agent-only installer)Install CloudBees Analytics
IntroductionRun an express server command-line installationRun an advanced command-line installationRun an express agent command-line installationExpress agent command-line installation (agent-only installer)Advanced command-line installation (agent-only installer)Install with the interactive command-line installer
IntroductionRun a silent installationSilent installation argumentsLinux silent installation examplesWindows silent installation examplesCloudBees Analytics server unattended installation
IntroductionUNIX agent interactive command-line installationSilent installation method for UNIX or macOS agents
IntroductionPrerequisitesPermissions to install or upgrade remote agentsInstall remote agents using the web interfaceInstall via the API
CloudBees Tools installation
Move the artifact repository in LinuxMove the artifact repository in Windows
Connect CloudBees CD/RO to a Microsoft SQL server
Install the MySQL JDBC connector
IntroductionUninstall CloudBees CD/RO on Linux, Unix, or macOSUninstall on WindowUninstall the CloudBees Analytics server on LinuxUninstall the CloudBees Analytics server on Windows
IntroductionZones and gatewaysConfigure agent environment variablesLicensesPersonasConfigure an external databaseConfigure CloudBees CD/RO to use an alternate databaseConfigure autostart for non-root/non-sudo Linux installationsConfigure universal access to the plugins directoryConfigure an environment proxy serverSystem health monitoringIncrease file descriptors on Linux and Linux Docker containersAdjust swappiness on LinuxSet variables on Windows agent machinesServer propertiesServer settingsSource code synchronization
IntroductionConfigure initial events for Workload InsightsConfigure Kibana to work with CloudBees Analytics
IntroductionArchitecture of a CloudBees CD/RO clusterResource, agent, and procedure considerationsSoftware for clusteringDependencies for clusteringConfigure clusteringSeparate agents from CloudBees CD/RO serversPrepare your cluster resourcesInstall and configure a load balancerInstall ZooKeeperConfigure a multi-ZooKeeper clusterInstall CloudBees CD/RO softwareConfigure repository serversConfigure machines to operate in clustered modeRun a cluster in single-server modeAdd the configuration to ZooKeeperUpload configuration files to ZooKeeperGet cluster information from ZooKeeperAdd a node to an existing clusterConfigure web server propertiesConfigure repository server propertiesConfigure CloudBees CD/RO agentsConfigure the cluster workspaceConfigure CloudBees CD/RO repositoriesAdd trusted agents to clustersVerify CloudBees CD/RO servicesAccess CloudBees CD/RO with clusteringHealth check for the CloudBees CD/RO clusterAdditional ways to improve a clusterInstall the CloudBees Analytics server in cluster modeUse self-signed certificates in CloudBees CD/RO on KubernetesConfigure Disaster Recovery and recover from a disaster
Sign in to CloudBees CD/RO
Access the Home page
Guided tutorials
Learn about the object model
IntroductionIntrinsic propertiesReserved wordsProperty shortcutsProperty error codesProperty BrowserProperty reference use case
IntroductionCreate a project
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksUse the CloudBees CD/RO API to define tasksEntry and exit gatesPipeline conditionsPipeline start and end stages and stage skippingWait dependenciesNative CI integrationPipeline UIAuthor and run pipelinesDefine stage gate rulesPipeline objects and conditionsPipeline stage summaryCredentials in pipelinesRun pipelinesExample: Create a manual task in a pipelineExample: Plugin pipeline tasksExample: Integrate test automation in release pipelinesExample: Leverage test data management and service virtualization in release pipelines
IntroductionRelease and environment reservations calendarVisibility and status of release pipelinesRelease definitionDeploy with Argo RolloutsRelease dashboardPlanned versus actual view for pipeline statusPath to production viewRelease summaryRun and end releases
Service catalog
Create and manage procedures
Define parameters
IntroductionCreate and manage applicationsCreate processesAdd process stepsProcess branchingConfigure plugin process stepsDefine manual steps and tasksExample: Manual step with runtime parametersAttach credentials to processesFull-stack dependency viewApplication deployment optionsConfiguration drift
IntroductionMaster component examplesMaster components list
Model and deploy microservice applications
IntroductionStage artifactsCapture snapshotsApplication rollbackManage dependencies
IntroductionCreate environmentsDefine environment tier mapsInventory trackingEnvironment inventoryGlobal environment inventoryEnvironment reservationsLock environmentsModel dynamic environmentsExample: Dynamic environment with Amazon and ChefAutomated environment discoveryCreate a deployment task to trigger third-party toolsGenerate a deployment package
Example: Deploy and troubleshoot applicationsExample: Deploy applications with provisioned cloud resourcesExample: Implement deployment strategies
Create object tags
Create object schedules
Configure event-based triggers
IntroductionConfigure email notificationsSelect and edit email messages for application or microservice processes
Automate workflows with GitHub Actions
IntroductionInstall pluginsCreate plugin configurationsManage pluginsCreate pluginsManage the plugin catalogDeveloper task: Create custom plugins
My work dashboard
Search and filter
Introduction
Build-test automation
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
IntroductionAutomation platform home pageCustomizing the automation platform UIConfiguring CloudBees CD/ROUsing CloudBees CD/RO in your environmentCloudBees CD/RO Installed tools
IntroductionArtifact managementAuthenticating users for ldap and active directoryAuto-discoveryDefect trackingElectricSentryJob step execution environmentPreflight buildsPostprocessorsReportsWorkflow overviewWorkspaces overview
IntroductionIntrinsic propertiesReserved wordsProperty shortcutsProperty error codes
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
IntroductionDefining entriesCreate new or edit existing privileges
IntroductionArtifact detailsCreate new or edit existing artifactsArtifact versionsArtifact version detailsEdit an existing artifact versionRepositoriesCreate new or edit existing repositories
Database configuration
IntroductionCreate new or edit existing configurationsDefect tracking reports
IntroductionCreate new or edit existing email configurationsEmail notifiers
Event log
IntroductionJob configurationShortcutsJobs quick view
IntroductionCloudBees CD/RO job detailsJob step details
IntroductionProcedure runsCreate 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
IntroductionProject detailsCreate new or edit existing schedulesCreate new or edit existing credentials
IntroductionNested Property Sheet
Reports
IntroductionResource poolsCreate new or edit existing poolsResource pool details
IntroductionSearch resultsEdit existing property settings
IntroductionCreate new or edit existing configurations
IntroductionUsersCreate new or edit existing local usersUser detailsEdit user settingsGroupsCreate new or edit existing groupsGroup detailsCreate new or edit existing directory providersSingle sign-onTest directory provider
IntroductionCreate new or edit exiting workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow logTransition workflow
Introduction Create or modify WorkspacesWorkspace file

Configuration settings preserved after an upgrade

2 minute readDeveloper productivity

The following configuration settings are saved and reloaded during a CloudBees CD/RO software upgrade.

Agent

Properties in <data_dir>/conf/agent.conf

artifactCache

caFile

caPath

certFile

duplicateDetectionListSize

idleOutboundConnectionTimeout

idlePostRunnerTimeout

idleServerRequestWorkerTimeout

idleWorkerTimeout

keyFile

loadProfile

logFile

logLevel

logMaxFiles

logMaxSize

outboundRequestInitialRetryInterval

outboundRequestMaxRetryInterval

outboundRequestTimeout

pluginsPath

port

proto

serverConnectTimeout

serverReadTimeout

unixShellPattern

verifyPeer

Properties in <data_dir>/conf/agent/wrapper.conf

set.ECWRAPPER_WRITE_MAX_ATTEMPTS

set.ECWRAPPER_WRITE_RETRY_INTERVAL

wrapper.console.format

wrapper.java.additional.<n> where n must be ≥ 10000 (custom parameter)

wrapper.java.additional.700

wrapper.java.additional.701

wrapper.java.additional.702

wrapper.java.additional.703

wrapper.java.additional.704

wrapper.java.additional.705

wrapper.java.additional.710

wrapper.java.additional.711

wrapper.java.additional.714

wrapper.java.additional.715

wrapper.java.classpath.<n> (where n must be ≥ 1)

wrapper.java.initmemory

wrapper.java.initmemory.percent

wrapper.java.library.path.<n> (where n must be ≥ 1)

wrapper.java.maxmemory

wrapper.java.maxmemory.percent

wrapper.logfile

wrapper.logfile.format

wrapper.logfile.loglevel

wrapper.logfile.maxfiles

wrapper.logfile.maxsize

wrapper.ntservice.dependency.<n>

wrapper.ntservice.interactive

wrapper.ntservice.starttype

wrapper.ping.interval

wrapper.ping.timeout

wrapper.request_thread_dump_on_failed_jvm_exit

wrapper.shutdown.timeout

wrapper.startup.timeout

wrapper.successful_invocation_time

Properties in <data_dir>/conf/agent/agent.properties

AGENT_ACCEPT_QUEUE_SIZE

AGENT_CRL_FILE

AGENT_DOMAIN_NAME

AGENT_KEYSTORE

AGENT_KEYSTORE_PASSWORD

AGENT_LOCAL_PORT

AGENT_MAX_HTTP_THREADS

AGENT_PORT

AGENT_PROTOCOL

AGENT_SERVER_SESSIONS_FILE

IDLE_CONNECTION_TIMEOUT

MAX_CONNECTIONS

MAX_CONNECTIONS_PER_ROUTE

MAX_LOGGED_prompt_LENGTH

OUTBOUND_CONNECT_TIMEOUT

CloudBees CD/RO server

Properties in <data_dir>/conf/commander.properties

COMMANDER_ACCEPT_QUEUE_SIZE

COMMANDER_BATCH_DB_REQUESTS_OVERRIDE

COMMANDER_CERT

COMMANDER_CRITICAL_SERVICES_MAX_ATTEMPTS_TO_BE_IN_PRIMARY_CLUSTER

COMMANDER_CRITICAL_SERVICES_MONITORING_ENABLED

COMMANDER_CRITICAL_SERVICES_MONITORING_FREQUENCY

COMMANDER_CRL_FILE

COMMANDER_DATA_DIR_MONITORING_ENABLED

COMMANDER_FORCE_ENABLE_ADMIN

COMMANDER_HTTPS_PORT

COMMANDER_KEY

COMMANDER_KEYSTORE

COMMANDER_KEYSTORE_PASSWORD

COMMANDER_LOG_DIR_MONITORING_ENABLED

COMMANDER_MAX_API_THREADS

COMMANDER_MAX_DISPATCH_THREADS

COMMANDER_MAX_HTTP_THREADS

COMMANDER_MAX_QUARTZ_THREADS

COMMANDER_MAX_WORKFLOW_THREADS

COMMANDER_MQ_DATADIR

COMMANDER_MQ_DIR_MONITORING_ENABLED

COMMANDER_MQ_DISK_SPACE_MONITORING_ENABLED

COMMANDER_MQ_DISK_SPACE_MONITORING_IN_CLUSTER_ONLY

COMMANDER_MQ_HARD_DISK_SPACE_LIMIT

COMMANDER_MQ_SOFT_DISK_SPACE_LIMIT

COMMANDER_NESTED_LDAP_GROUPS_MAXIMUM_DEPTH_LIMIT

COMMANDER_PASSWORD_KEYFILE

COMMANDER_PORT

COMMANDER_SERVER_NAME

COMMANDER_STOMP_PORT

org.apache.coyote.USE_CUSTOM_STATUS_MSG_IN_HEADER

Properties in <data_dir>/conf/wrapper.conf

set.default.COMMANDER_HTTPS_PORT

wrapper.syslog.loglevel

set.default.COMMANDER_XML_READER_STRIP_WHITESPACE_TEXT

set.default.COMMANDER_PORT

set.default.INSTALL_DIRECTORY

set.default.DATA_DIRECTORY

wrapper.java.additional.<n> where n must be ≥ 10000 (custom parameter)

wrapper.console.format

wrapper.java.additional.250

wrapper.java.additional.240

wrapper.java.additional.350

wrapper.java.additional.260

wrapper.java.additional.601

wrapper.java.additional.600

wrapper.java.additional.603

wrapper.java.additional.602

wrapper.java.additional.702

wrapper.java.additional.703

wrapper.java.additional.704

wrapper.java.additional.705

wrapper.java.additional.710

wrapper.java.additional.711

wrapper.java.additional.714

wrapper.java.additional.715

wrapper.java.additional.800

wrapper.java.additional.802

wrapper.java.additional.801

wrapper.java.additional.901

wrapper.java.additional.803

wrapper.java.additional.903

wrapper.java.additional.902

wrapper.java.additional.950

wrapper.java.additional.1600

wrapper.java.additional.1601

wrapper.java.classpath.<n> (where n must be ≥ 1)

wrapper.java.initmemory

wrapper.java.initmemory.percent

wrapper.java.library.path.<n> (where n must be ≥ 1)

wrapper.java.maxmemory

wrapper.java.maxmemory.percent

wrapper.logfile

wrapper.logfile.format

wrapper.logfile.loglevel

wrapper.logfile.maxfiles

wrapper.logfile.maxsize

wrapper.ping.interval

wrapper.ping.timeout

wrapper.request_thread_dump_on_failed_jvm_exit

wrapper.shutdown.timeout

wrapper.startup.timeout

Repository server

Properties in <data_dir>/conf/repository/server.properties

AGENT_URL

COMMANDER_HOST

IDLE_CONNECTION_TIMEOUT

MAX_CONNECTIONS

MAX_CONNECTIONS_PER_ROUTE

REPOSITORY_ACCEPT_QUEUE_SIZE

REPOSITORY_BACKING_STORE

REPOSITORY_KEYSTORE

REPOSITORY_KEYSTORE_PASSWORD

REPOSITORY_MAX_HTTP_THREADS

REPOSITORY_PORT

REPOSITORY_PROTOCOL

VALIDATE_FROM_DISK

Properties in <data_dir>/conf/repository/wrapper.conf

set.default.DATA_DIRECTORY

set.default.INSTALL_DIRECTORY

set.default.REPOSITORY_PORT

set.default.REPOSITORY_PROTOCOL

wrapper.console.format

wrapper.java.additional.400

wrapper.java.additional.401

wrapper.java.additional.402

wrapper.java.additional.701

wrapper.java.additional.702

wrapper.java.additional.703

wrapper.java.classpath.<n> (where n must be ≥ 1)

wrapper.java.initmemory

wrapper.java.initmemory.percent

wrapper.java.library.path.<n> (where n must be ≥ 1)

wrapper.java.maxmemory

wrapper.java.maxmemory.percent

wrapper.logfile

wrapper.logfile.format

wrapper.logfile.loglevel

wrapper.logfile.maxfiles

wrapper.logfile.maxsize

wrapper.ping.interval

wrapper.ping.timeout

wrapper.request_thread_dump_on_failed_jvm_exit

wrapper.shutdown.timeout

wrapper.startup.timeout

wrapper.successful_invocation_time

wrapper.syslog.loglevel

Web server

Properties in <data_dir>/apache/conf/httpd.conf

Listen

ServerName

SetEnv COMMANDER_HTTPS_PORT

SetEnv COMMANDER_PLUGINS

SetEnv COMMANDER_PORT

SetEnv COMMANDER_SERVER

SetEnv no_proxy

RewriteCond %{HTTPS}

Properties in <data_dir>/apache/conf/extra/auth-kerberos.conf

KrbConstrainedDelegation

webEnableKrb5Trace

KrbServiceName

Properties in <data_dir>/apache/conf/php.ini

date.timezone

max_file_uploads

memory_limit

post_max_size

upload_max_filesize

Properties in <data_dir>/apache/conf/ssl.conf

SSLCertificateKeyFile

SSLCertificateFile

Listen

Properties in <data_dir>/apache/htdocs/commander/config.php

$config["connectTimeout"]

csrfProtection

Built-in database

Properties in <data_dir>/conf/mariadb/mariadb.conf

port (under sections [mysqld] and [client])

innodb_buffer_pool_size

Adding custom Java options to the CloudBees CD/RO server and agent

Use the ecconfigure tool with --agentWrapperJavaAdditional=nnnnn=value for an agent or --wrapperJavaAdditional=nnnnn=value for the CloudBees CD/RO server to add custom Java options during an upgrade.

nnnnn must be an unique integer >= 10000.

For example, running ecconfigure --wrapperJavaAdditional=10000=-Dcom.sun.jndi.ldap.read.timeout=20000 adds wrapper.java.additional.10000=-Dcom.sun.jndi.ldap.read.timeout=20000 to the <DATA_DIR>/conf/wrapper.conf of the CloudBees CD/RO server. After a CloudBees CD/RO server upgrade, this custom JVM parameter is preserved.