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

Install CloudBees CD/RO software

6 minute readScalability

You must install CloudBees CD/RO components on all the nodes in your CloudBees CD/RO cluster. Where you install the individual components depends on the type of cluster configuration you need to create. For more information on how to install CloudBees CD/RO, see Installing CloudBees CD/RO.

Use the reliability approach if you want to minimize single points of failure in your CloudBees CD/RO installation; use the performance approach if (in addition to minimizing single points of failure), you want to maximize throughput of your CloudBees CD/RO server at the cost of using more hardware.

In the reliability approach, other CloudBees CD/RO components such as agents, repositories, and web servers are placed on the same machine as a node of the CloudBees CD/RO server cluster; in the performance approach, they are placed on other servers to leave as many resources as possible available for the CloudBees CD/RO server node.

Choose one of the following four installation approaches for your environment:

For any of these approaches, when you install agent, repository, and web server services, you can save time by configuring the software to point to a remote server location. You must also register all of these service agents as resources on the CloudBees CD/RO server. For more information, see Duplicating Repository Contents .

  • For a command-line installation, set the option --remoteServer <load_balancer_FQDN>. If you are doing an advanced installation on Linux, when prompted for the remote CloudBees CD/RO server, enter the <load_balancer_FQDN> .

  • For a graphical user interface installation, set the Server Host Name field in the "Remote CloudBees CD/RO server" installer page to < load_balancer_FQDN >:8000. The load_balancer_FQDN is the fully qualified domain name of your CloudBees CD/RO server’s load balancer machine.

For details about the overall steps for installing CloudBees Analytics on a group of servers to create a CloudBees Analytics server cluster, refer to Installing the CloudBees Analytics Server in Cluster Mode.

New CloudBees CD/RO Installation for Reliability

The reliability approach allows multiple CloudBees CD/RO services to run on a machine, but multiple instances of the service should exist to prevent single points of failure.

  1. Install the CloudBees CD/RO server and agent software on one node in the CloudBees CD/RO cluster.

    Before you install the CloudBees CD/RO server and agent software on the remaining nodes in the CloudBees CD/RO cluster, you must stop your CloudBees CD/RO web server. To stop the web server:

    • On Linux:

      • As a root user, run /etc/init.d/commanderApache stop.

      • Using systemd, run sudo systemctl stop commanderApache.

    • On Windows, stop the service and change its settings to Startup Type to Manual.

    If you do not already have a web server to temporarily point at this CloudBees CD/RO server node, CloudBees suggests installing a CloudBees CD/RO web server to complete the steps in this section.

  2. Configure CloudBees CD/RO to use an external database. At this time, the CloudBees CD/RO node is in a single-server configuration.

    For more information, see Switching to an Alternate Database .

  3. Move the plugins directory on the CloudBees CD/RO server software node to a location on the shared file system.

    For more information, see Universal Access to the Plugins Directory and Moving the Plugins Directory to a Pre-Configured Network Location.

  4. Install the CloudBees CD/RO server and agent software on the remaining nodes in the CloudBees CD/RO cluster.

  5. Install the CloudBees CD/RO repository service on one or more machines.

  6. Register agents on these machines as resources on the CloudBees CD/RO server.

  7. Install the CloudBees CD/RO web server service on one or more machines.

New CloudBees CD/RO Installation for Performance

The performance approach requires separate machines for each CloudBees CD/RO service.

  1. Install just the CloudBees CD/RO server software on all the nodes in the CloudBees CD/RO cluster.

    For more information, see Silent Unattended Installation Method .

    If you do not already have a CloudBees CD/RO web server that you can temporarily point at this CloudBees CD/RO server node, you may also want to install a CloudBees CD/RO web server that can be used for the following two steps in this section. Before you install the CloudBees CD/RO server and agent software on the remaining nodes in the CloudBees CD/RO cluster, turn off the web server . You turn off the web server on Linux by using the command /etc/init.d/commanderApache stop, or on Windows by stopping the service and setting the Startup Type to Manual.

  2. Configure one instance of the CloudBees CD/RO server software to use an external database.

    At this time, the CloudBees CD/RO node is in a single-server configuration.

    For more information, see Switching to an Alternate Database .

  3. Move the plugins directory on the CloudBees CD/RO server software node to a location on the shared file system.

    For more information, see Universal Access to the Plugins Directory and Moving the Plugins Directory to a Pre-Configured Network Location.

  4. Install the following software services on one or more individual machines.

    Each service should not be installed with any other CloudBees CD/RO software components. CloudBees CD/RO agent CloudBees CD/RO repository server ** CloudBees CD/RO web server

  5. Remove any agents that were automatically installed with the CloudBees CD/RO server.

    For more information, see Separating Agents from CloudBees CD/RO Servers and Verifying CloudBees CD/RO Services .

Converting an Existing CloudBees CD/RO Installation for Reliability

Because this is a conversion of an existing CloudBees CD/RO system, one or more machines with the CloudBees CD/RO server, agent, web server, and repository software already exist. The reliability approach allows multiple CloudBees CD/RO services to run on a machine, but multiple instances of the service should exist to prevent single points of failure.

  1. Upgrade the existing CloudBees CD/RO software according to the instructions in Upgrade on traditional platforms.

    Horizontal scalability is supported starting with CloudBees CD/RO 5.0.

  2. Verify that CloudBees CD/RO is pointing to an external database.

    To verify which database is in use: sign in to CloudBees CD/RO and select Administration > Database Configuration to see the current database.

  3. Verify that CloudBees CD/RO is configured to use a plugins directory located on the shared file system.

    For more information, see Universal Access to the Plugins Directory.

  4. Install the CloudBees CD/RO server and agent software on the remaining nodes for the CloudBees CD/RO cluster.

  5. Install the CloudBees CD/RO repository server on one or more machines.

  6. Install the CloudBees CD/RO web server on one or more machines.

  7. Register the machine agents as resources on the CloudBees CD/RO server.

Converting an Existing CloudBees CD/RO Installation for Performance

Because this is a conversion of an existing CloudBees CD/RO system, one or more machines with the CloudBees CD/RO server, agent, web server, and repository software already exist. The performance approach requires separate machines for each CloudBees CD/RO service.

  1. Upgrade the existing CloudBees CD/RO software according to the instructions in Upgrade on traditional platforms.

    Horizontal scalability is supported starting with CloudBees CD/RO 5.0.

  2. Verify that CloudBees CD/RO is pointing to an external database.

    To verify which database is in use sign in to CloudBees CD/RO and select Administration > Database Configuration to see the current database.

    The database connection is successfully configured if you can log into CloudBees CD/RO.

    See Switching to an Alternate Database if additional configuration is required.

  3. Verify that CloudBees CD/RO is configured to use a plugins directory located on the shared file system.

    For more information, see Universal Access to the Plugins Directory xref:configure:plugins-directory/plugins-dir.adoc#moving-the-plugins-dir.

  4. Remove any web server or agent software that is installed with the original CloudBees CD/RO machine.

    This software will be reinstalled on a separate system.

  5. Install the CloudBees CD/RO server software on the nodes for the CloudBees CD/RO cluster.

  6. Install the following software services on one or more individual machines.

    Each machine should not be installed with any other CloudBees CD/RO software services.

    • CloudBees CD/RO agent

    • CloudBees CD/RO repository server

    • CloudBees CD/RO web server

  7. Remove any agents that were automatically installed with the CloudBees CD/RO server, web server, and repository services.

    The original CloudBees CD/RO machine as well as the new installations should be checked to verify that the agent software is removed.

    For more information, see Separating Agents from CloudBees CD/RO Servers and Verifying CloudBees CD/RO Services .

  8. Remove any repository server software that is installed with the original CloudBees CD/RO machine after you duplicate the repository server contents.

    For more information, see Duplicating Repository Contents.

    If necessary, install the repository software on additional machines.

Configure a multi-ZooKeeper cluster
Configure repository servers