Kubernetes installation
IntroductionInstallationConfiguring Helm chartsPlatform-specific configurationsVerifying Helm chartsCreating Docker imagesVerifying Docker imagesHow-tos
Traditional installation
IntroductionSpecial-case installationsInstaller optionsServer topology best practicesDefault installation directoriesVerifying installation binaries
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
Configuring the CloudBees Analytics server
IntroductionConfiguring initial events for Workload Insights
Introduction
Microservice applications
Traditional applications
IntroductionArtifact stagingSnapshotsRollbackManaging dependencies
Processes
IntroductionApplications and processesManaging ApplicationsCreating processesAdding process stepsProcess branchingConfiguring plugin process stepsManual steps and tasksExample: manual step with runtime parameters
Environments
IntroductionCreating environmentsCreating environment tier mapsInventory trackingEnvironment inventoryGlobal environment inventoryEnvironment reservationsEnvironment lockingModeling dynamic environmentsAutomated environment discoveryExample: dynamic environment with Amazon and Chef
Master Components
IntroductionMaster Component ExamplesMaster components list
Deployment strategies
IntroductionThird-party DeploymentApplication 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
IntroductionRelease and Environment Reservations CalendarVisibility and Status of Release PipelinesRelease DefinitionDeploy with Argo RolloutsRelease DashboardPlanned Versus Actual ViewPath to Production ViewRelease SummaryRunning and Ending Releases
Pipeline concepts
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksUse API to define tasksEntry and exit gatesPipeline conditionsPipeline start and end stages and stage skippingWait dependenciesNative CI integration Pipeline UI
Authoring and running pipelines
IntroductionDefining gate approvalsPipeline objects and conditionsPipeline stage summaryCredentials in pipelines
Pipeline examples
IntroductionExample: Creating a manual task in a pipelineExample: plugin pipeline tasksExample: integrating test automation in release pipelinesExample: leveraging test data management and service virtualization in release pipelinesExample: Surfacing Jenkins build details in Flow
Signing in to CloudBees CD/RO
Guided Tutorials
Home page
Personas
Viewing and changing access control privileges on objects
My work dashboard
Object list layout
Object schedules
Event-based triggers
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 propertiesServer settingsSource code synchronizationGitOps configuration with Helm charts
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
Plugin management
IntroductionInstalling pluginsCreating configurationsManaging pluginsCreating pluginsManaging the plugin catalog
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 modeUsing self-signed certificates in CloudBees CD/RO on KubernetesDisaster recovery
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
IntroductionArtifact managementAuthenticating users for ldap and active directoryAuto-discoveryDefect trackingElectricSentryJob step execution environmentPreflight buildsPostprocessorsReportsWorkflow overviewWorkspaces and disk space management
Properties
IntroductionIntrinsic propertiesReserved wordsProperty 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
IntroductionCloudBees CD/RO job detailsJob step details
Licenses
IntroductionView licenseImport license
Procedures, steps, and parameters
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
Projects, schedules, and credentials
IntroductionCreate new or edit existing projectsProject detailsCreate 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 resultsEdit 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

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.

Upgrading the CloudBees Analytics server