IntroductionInstallationFrequently asked questionsConfiguration valuesCreating Docker images
IntroductionSpecial-case installationsInstaller optionsServer topology best practicesDefault installation directories
IntroductionDefault configurationCustom configurationExpress agentExpress agent-onlyAdvanced agent-onlyCloudBees Analytics server
IntroductionExpress serverAdvanced serverExpress agentExpress agent-only (standalone)Advanced agent-only (standalone)CloudBees Analytics server 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
IntroductionUNIX agent interactive command-lineUNIX agent unattended
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
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
IntroductionConfiguring initial events for Workload Insights
Introduction
Microservice applications
IntroductionArtifact stagingSnapshotsRollbackManaging dependencies
IntroductionApplications and processesManaging ApplicationsCreating processesAdding process stepsProcess branchingPlugin process stepsManual steps and tasksExample: manual step with runtime parameters
IntroductionCreating environmentsCreating environment tier mapsInventory trackingEnvironment inventoryGlobal environment inventoryEnvironment reservationsEnvironment lockingModeling dynamic environmentsAutomated environment discoveryExample: dynamic environment with Amazon and Chef
IntroductionMaster Component ExamplesMaster components list
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
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
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
Viewing and changing access control privileges on objects
My work dashboard
Object list layout
Object schedules
Event-based triggers
IntroductionPaginationSearching and filteringHierarchy menuProperty browserProjects in CloudBees CD/ROObject tags
IntroductionCleanupStalledJobClusterInfoTooleccertecconfigureecdaemonecproxyecremotefilecopyZKConfigtool
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 settingsSource code synchronizationGitOps configuration with Helm charts
Data Retention
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
IntroductionSetting Email NotificationsSelecting and Editing Email Messages for Application or Microservice Processes
Producing audit reports
Configuration drift
IntroductionInstalling pluginsCreating configurationsManaging pluginsCreating pluginsManaging the plugin catalog
Self-Service Catalogs
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
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 and disk space management
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
IntroductionView licenseImport license
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
IntroductionCreate new or edit existing projectsProject detailsCreate new or edit existing schedulesCreate new or edit existing credentials
IntroductionNested Property Sheet
Reports
IntroductionResource poolsCreate new or edit existing poolsResource pool detailsZonesGateways
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 detailsDirectory providersCreate new or edit existing directory providersSingle sign-onTest directory provider
IntroductionCreate new or edit exiting workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow logTransition workflow
IntroductionCreate new or edit existing workspacesWorkspace file

Starting and Stopping Servers and Agents Manually

2 minute readReference

CloudBees CD/RO servers and agents must be manually stopped and started for administrative maintenance, upgrades, third-party software installations, or system maintenance.

Stopping the CloudBees CD/RO Agent Service

To stop the CloudBees CD/RO agent service, choose one of the following options.

Windows

  1. Go to Control Panel > Administrative Tools > Services.

  2. Right-click CloudBees CD/RO Agent and click Stop.

Windows Command Line

Open a command window as Administrator and enter:

sc stop CommanderAgent
▼

Linux

Log into a shell as root and enter one of the following commands:

  • Linux: /etc/init.d/commanderAgent stop

  • macOS: launchctl unload /Library/LaunchDaemons/ecmdrAgent.plist

Stopping All CloudBees CD/RO Server Services

To stop all CloudBees CD/RO server services, choose one of the following options.

Windows

  1. Go to Control Panel > Administrative Tools > Services.

  2. Right-click CloudBees CD/RO Server and click Stop.

  3. Right-click CloudBees CD/RO Web Server and click Stop.

  4. Right-click CloudBees CD/RO Database (if it exists) and click Stop.

  5. Right-click CloudBees CD/RO Repository Server and click Stop.

Windows Command Line

Open a command window as Administrator and enter:

sc stop CommanderServer
sc stop CommanderApache
sc stop CommanderDatabase
sc stop CommanderRepository
▼

Linux

Log into a shell as root and enter:

/etc/init.d/commanderServer stop
/etc/init.d/commanderApache stop
/etc/init.d/commanderDatabase stop
/etc/init.d/commanderRepository stop
▼

Stopping All CloudBees Analytics Services

CloudBees Analytics uses services for Elasticsearch. To stop this service, log into the CloudBees Analytics server and choose the following option.

Windows

  1. Go to Control Panel > Administrative Tools > Services.

  2. Right-click CloudBees CD/RO Elasticsearch Service and click Stop.

Windows Command Line

Open a command window as Administrator and enter:

sc stop CommanderElasticsearch
▼

Linux

Log into a shell as root and enter:

/etc/init.d/commanderElasticsearch stop
▼

Starting the CloudBees CD/RO Agent Service

To start the CloudBees CD/RO agent service, choose one of the following options.

Windows

  1. Go to Control Panel > Administrative Tools > Services.

  2. Right-click CloudBees CD/RO Agent and click Start.

Windows Command Line

Open a command window as Administrator and enter:

sc start CommanderAgent
▼

Linux

Log into a shell as root and enter one of the following commands:

  • Linux: /etc/init.d/commanderAgent stop

  • macOS: launchctl load /Library/LaunchDaemons/ecmdrAgent.plist

Starting All CloudBees CD/RO Server Services

To start all CloudBees CD/RO server services, choose one of the following options.

Windows

  1. Go to Control Panel > Administrative Tools > Services.

  2. Right-click CloudBees CD/RO Database (if it exists) and click Start.

  3. Right-click CloudBees CD/RO Server and click Start.

  4. Right-click CloudBees CD/RO Web Server and click Start.

  5. Right-click CloudBees CD/RO Repository Server and click Start.

Windows Command Line

Open a command window as Administrator and enter:

sc start CommanderDatabase
sc start CommanderServer
sc start CommanderApache
sc start CommanderRepository
▼

Linux

Log into a shell as root and enter:

/etc/init.d/commanderDatabase start
/etc/init.d/commanderServer start
/etc/init.d/commanderApache start
/etc/init.d/commanderRepository start
▼

Starting All CloudBees Analytics Services

To start the CloudBees Analytics service Elasticsearch, log into the CloudBees Analytics server and choose one of the following options.

Windows

  1. Go to Control Panel > Administrative Tools > Services.

  2. Right-click CloudBees CD/RO Elasticsearch Service and click Start.

Windows Command Line

Open a command window as Administrator and enter:

sc start CommanderElasticsearch
▼

Linux

Log into a shell as root and enter:

/etc/init.d/commanderElasticsearch start
▼
Using chkconfig
Collecting CloudBees CD/RO logs