Introduction
Introduction
IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsConfigure IP protocols for Helm chart componentsConfigure GitOps with Helm chartsVerify Helm chartsCreate custom Docker imagesVerify Docker images
IntroductionInstallation user requirementsInstallation typesDefault installation directoriesVerify installation binariesAgent security recommendations
IntroductionInstall a default configurationInstall a custom configurationRun an express agent GUI installationRun an express GUI installation (agent-only installer)Run an advanced GUI 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 the CloudBees Analytics server 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 custom CAs and CRLs in non-clustered environmentsConfigure custom CAs and CRLs in clustered environmentsConfigure agent environment variablesLicensesCreate and manage usersEdit user settingsCreate and manage groupsPersonasConfigure an external databaseConfigure CloudBees CD/RO to use an alternate databaseInstall services for non-root/non-sudo Linux installationsConfigure 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 OpenSearch Dashboards 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/ROAccess the Home pageMy work dashboardGuided tutorialsLearn about the object modelSearch and filter
IntroductionIntrinsic properties listed by object typeReserved words in CloudBees CD/ROObject types in CloudBees CD/ROSpecial characters in CloudBees CD/RO object namesContext-relative shortcuts to property pathsProperty error codesConfigure properties or property sheetsProperty BrowserProperty reference use case
IntroductionResource poolsCreate or edit resource pools
IntroductionView workspacesCreate or edit workspacesWorkspace file
IntroductionCreate a projectSchedules
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksUse the CloudBees CD/RO API to define tasksDefine manual 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 pipelinesView pipeline runsExample: 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 planning, scheduling, and trackingRelease 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
Introduction
IntroductionManage procedure runsProcedure run detailsUsing CloudBees CD/RO in your environmentJob step executionPostprocessors: Collecting data for reports
IntroductionWorkflow listsCreate or edit workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow LogTransition workflow
Introduction
IntroductionCreate and manage applicationsApplication process run detailsCreate application processesAdd process stepsProcess branchingConfigure plugin process stepsDefine manual stepsExample: Manual step with runtime parametersAttach credentials to processesFull-stack dependency viewApplication deployment optionsConfiguration drift
IntroductionMaster component examplesMaster components list
Introduction
IntroductionStage artifactsCapture snapshotsApplication rollbackManage dependencies
IntroductionCreate environmentsDefine environment tier mapsInventory trackingEnvironment inventoryGlobal environment inventoryEnvironment reservationsLock environmentsModel dynamic environmentsAutomated environment discoveryCreate a deployment task to trigger third-party toolsGenerate a deployment packageExample: Dynamic environment with Amazon and ChefExample: Deploy and troubleshoot applicationsExample: Deploy applications with provisioned cloud resourcesExample: Implement deployment strategies
IntroductionArtifactsArtifact versionsRepositories
Create object tagsCreate object schedules
IntroductionConfigure webhook triggersConfigure polling triggers
IntroductionConfigure email notificationsSelect and edit email messages for application or microservice processes
Introduction
IntroductionInstall CloudBees CD/RO pluginsCreate plugin configurationsManage pluginsCreate pluginsManage the plugin catalog

Upload configuration files to ZooKeeper

3 minute readScalability

Before starting the CloudBees CD/RO server cluster, you must populate your Apache ZooKeeper server with CloudBees CD/RO database configuration information that all CloudBees CD/RO server nodes will use in the cluster. You use ZKConfigTool to import this information into your ZooKeeper server.

You must run ZKConfigTool after changing any updatable configuration file. Even with multiple ZooKeeper machines, you must do this only once, and the data is propagated to all of those machines.

The following minimum set of files from the <data_dir>/conf directory is imported:

  • commander.properties

  • database.properties

  • keystore

  • passkey

Prerequisites

  • The CloudBees CD/RO server package must be installed on the system.

  • The system must be running a version of Java supported by CloudBees CD/RO. Java is automatically installed with CloudBees CD/RO as part of the Tools installation.

  • The ZooKeeper software must be installed on the network.

Location of ZKConfigTool

CloudBees CD/RO includes ZKConfigTool. It is installed in the following default locations.

  • Windows: C:\Program Files\CloudBees\Software Delivery Automation\server\bin\zk-config-tool-jar-with-dependencies.jar

  • Linux: /opt/cloudbees/sda/server/bin/zk-config-tool-jar-with-dependencies.jar

    For Kubernetes Linux installations, the CloudBees CD/RO path is /opt/cbflow, instead of /opt/cloudbees/sda.

ZKConfigTool command syntax

ZKConfigTool is best run from the <install_dir>/conf directory.

java -jar zk-config-tool-jar-with-dependencies.jar <option> <value>
▼
The command examples in the following table show the options and value as though they were passed for a command executed from the <install_dir>/conf directory.
Option Description

--commanderPropertiesFile <path_to_file>

Import the CloudBees CD/RO server conf/commander.properties file.

Example:

--commanderPropertiesFile commander.properties
▼

--confSecurityFolder <path_to_file>

Import the CloudBees CD/RO server conf/security folder.

Example:

--confSecurityFolder security
▼

--databasePropertiesFile <path_to_file>

Import the CloudBees CD/RO server conf/database.properties file.

Example:

--databasePropertiesFile database.properties
▼

--help

Show the command help.

--keystoreFile <path_to_file>

Import the CloudBees CD/RO server conf/keystore file.

Example:

--keystoreFile keystore
▼

--passkeyFile <path_to_file>

Import the CloudBees CD/RO server conf/passkey.

Example:

--passkeyFile passkey
▼

--readFile <path_on_zookeeper> <path_to_file>

Read the specified file from the ZooKeeper server. Possible values for <path_on_zookeeper> are:

  • /commander/conf/commander.properties

  • /commander/conf/database.properties

  • /commander/conf/keystore

  • /commander/conf/passkey

--readFolder <path_on_zookeeper> <path_to_folder>

Read the specified folder from the ZooKeeper server. Possible values for <path_on_zookeeper> are:

  • /commander/conf/security

--version

Show the version number of the ZKConfigTool tool.

--writeFile <path_on_zookeeper> <path_to_file>

Write the specified file to the ZooKeeper server. Possible Values for <path_on_zookeeper> are:

  • /commander/conf/commander.properties

  • /commander/conf/database.properties

  • /commander/conf/keystore

  • /commander/conf/passkey

--writeFolder <path_on_zookeeper> <path_to_folder>

Write the specified folder to the Zookeeper server. Possible values for <path_on_zookeeper> are:

  • /commander/conf/security

Importing the Configuration Files into the ZooKeeper Server Using ZKConfigTool

Run ZKConfigTool to populate the ZooKeeper server with configuration information. The system must have the CloudBees CD/RO tools installed and must be able to communicate with ZooKeeper.

The following command shows how to run ZKConfigTool from the <data_dir>\conf directory.

Linux:

../jre/bin/java -DCOMMANDER_ZK_CONNECTION=<ZooKeeper_Server_IP>:2181 -jar ../server/bin/zk-config-tool-jar-with-dependencies.jar com.electriccloud.commander.cluster.ZKConfigTool --databasePropertiesFile database.properties --keystoreFile keystore --passkeyFile passkey --commanderPropertiesFile commander.properties --confSecurityFolder security
▼

Windows:

"C:\Program Files\CloudBees\Software Delivery Automation\jre\bin\java.exe" -DCOMMANDER_ZK_CONNECTION=<ZooKeeper_Server_IP>:2181 -jar "C:\Program Files\CloudBees\Software Delivery Automation\server\bin\zk-config-tool-jar-with-dependencies.jar" com.electriccloud.commander.cluster.ZKConfigTool --databasePropertiesFile database.properties --keystoreFile keystore --passkeyFile passkey --commanderPropertiesFile commander.properties --confSecurityFolder security
▼

Copying the Configuration Files to the Other Server Nodes

After you upload the new configuration files:

  1. Shut down all running CloudBees CD/RO servers in the cluster.

  2. Start one CloudBees CD/RO server in the cluster.

  3. Check if the CloudBees CD/RO server is running fully by entering the following ectool command:

    ectool --server localhost --timeout 900 getServerStatus --block 1 --serverStateOnly 1
    ▼

    This command runs for 900 seconds (15 minutes) or until getServerStatus displays either bootstrap or running.

  4. If the output says bootstrap, enter the command again until it says running.

    You can also use tail to follow the <data_dir>\logs\commander-<hostname>.log file to check for errors that could prevent the CloudBees CD/RO server from going to running state.

  5. Copy all configuration files to each of the conf folders of the other server nodes.

    This ensures parity for all server nodes in the cluster.

  6. After the first CloudBees CD/RO server is in running state, start the other CloudBees CD/RO servers so that they can join the cluster.

  7. After all CloudBees CD/RO servers are in running state, check the view of the cluster.

    • On Linux platforms, enter:

      <install_dir>/bin/ectool --server localhost getServerStatus --diagnostics 1 | grep -i "\(<view>\|<service_name>\|<participants>\)"
      ▼

    • On Windows platforms, enter:

      <install_dir>\bin\ectool --server localhost getServerStatus --diagnostics 1 | findstr "<view> <service_name> <participants>" 2>NULL
      ▼
Add the configuration to ZooKeeper
Get cluster information from ZooKeeper