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 the CloudBees Analytics server in cluster mode

4 minute readScalability

The CloudBees Analytics server uses the OpenSearch search engine to gather data from the CloudBees CD/RO server for use in the CloudBees Analytics dashboards such as the Deployments, Releases, and Release Command Center dashboards. OpenSearch is a powerful search and analysis engine, and part of this power lies in the ability to scale for better performance and stability.

An OpenSearch cluster is a collection of one or more nodes (servers) that holds your entire data and provides federated indexing and search capabilities across all nodes. A cluster is identified by a unique name, which is set using the Server Cluster name provided to the CloudBees Analytics server installer. This name is important, because a node can be part of a cluster only if the node is set up to join the cluster by its name.

A node is a single server that is part of your cluster, stores your data, and participates in the cluster’s indexing and search capabilities. Just like a cluster, a node is identified by a name, which is set using the Node name provided to the CloudBees Analytics server installer.

A cluster can have any number of nodes. At least three nodes are recommended for a cluster.

Creating a typical CloudBees Analytics cluster

To set up a typical CloudBees Analytics cluster deployment, complete the following steps.

Choosing the security mode for the cluster

If the mode will be password protected, then you must choose a password. This password must be used during installation for every node in cluster and it must be the same for all nodes. If the cluster will not be password protected, then all nodes must be installed using the same mode.

Installing the first node in the cluster

Use one of the following installer modes:

  • GUI mode—In the Cluster Settings installer screen, check the This is the first node in the cluster checkbox.

    For details about this screen and when it appears during the installation session, see Running an Advanced Graphical User Interface Installation .

  • Console mode—Answer Yes at the Do you want to specify additional cluster mode settings? prompt and at the Is this node the first node to be installed in the cluster? prompt.

    For details about when these prompts appear during the installation session, see Running an Advanced Command-Line Installation .

  • Silent mode—Additional arguments are not needed (cluster mode is the default).

This node will be a master node and a data node automatically.

Retrieve the certificate file containing a CA-signed certificate for the CloudBees Analytics server, which is located at <DATA_DIR>/conf/analytics/signing-ca.p12. This file is needed for installing the CloudBees Analytics server on all other cluster nodes.

Installing each additional node

Perform this step on each additional node. These settings should be the same across all additional nodes. Use one of the following installer modes:

  • GUI mode—In the Cluster Settings pane, uncheck the This is the first node in the cluster checkbox. For details about this screen and when it appears during the installation session, see Running an Advanced Graphical User Interface Installation .

    Then specify the certificate file containing a CA-signed certificate retrieved from the first node on the Advanced Settings pane.

  • Console mode—Answer Yes at the Do you want to specify additional cluster mode settings? prompt and No at the Is this node the first node to be installed in the cluster? prompt.

    For details about when these prompts appear during the installation session, see Running an Advanced Command-Line Installation .

    Then specify the certificate file containing a CA-signed certificate retrieved from the first node at the PKCS#12 file containing a CA-signed certificate for the CloudBees Analytics Server prompt.

    You can leave this entry blank for a new installation in non-clustered mode or for the first node in clustered mode. In this case, the installer will generate a new self-signed certificate and will use it to sign other TLS certificates.

  • Silent mode—Use the --serverNodeAdditional command line argument and specify the certificate file containing a CA-signed certificate retrieved from the first node using the --serverCACertificateFile command line argument.

The cluster name must be the same for all nodes.
During node installation, the list of other nodes should be specified. It is mandatory for additional nodes and optional for the first node. You should specify all available master nodes in this list.

Configuring the load balancer and the CloudBees CD/RO server

You must configure a load balancer to balance one port for the CloudBees Analytics services:

  • TCP port of the CloudBees Analytics service. The default port number is 9201.

You must configure the CloudBees CD/RO server to use the load balancer host by using the instructions in Install and configure a load balancer.

DNS issue and publish host setting

The Publish host setting is critical for nodes in a cluster. By default, this setting contains the value of the node’s hostname. The cluster will not work if this hostname resolves as an internal IP address that is unreachable by other nodes or as the IP address of the loopback interface (such as 127.0.0.1). If this is the case, then messages similar to the following will be in the log file:

[2024-03-20T21:42:49,037][WARN ][o.o.c.c.ClusterFormationFailureHelper] [dev.c.flow-testing-project.internal] cluster-manager not discovered yet, this node has not previously joined a bootstrapped cluster, and this node must discover cluster-manager-eligible nodes [dev.c.flow-testing-project.internal, foo, bar] to bootstrap a cluster: have discovered [{dev.c.flow-testing-project.internal}{LBovyYaMTJ2vR8TwX_GQsQ}{Rk0FzS7STyuLvS9bjhXy3A}{dev.c.flow-testing-project.internal}{10.30.176.76:9301}{dim}{shard_indexing_pressure_enabled=true}]; discovery will continue using [] from hosts providers and [{dev.c.flow-testing-project.internal}{LBovyYaMTJ2vR8TwX_GQsQ}{Rk0FzS7STyuLvS9bjhXy3A}{dev.c.flow-testing-project.internal}{10.30.176.76:9301}{dim}{shard_indexing_pressure_enabled=true}] from last-known cluster state; node term 0, last-accepted version 0 in term 0
[2024-03-20T21:42:49,039][WARN ][o.o.d.SeedHostsResolver  ] [dev.c.flow-testing-project.internal] failed to resolve host [foo]
java.net.UnknownHostException: foo
        at java.net.InetAddress$CachedAddresses.get(InetAddress.java:801) ~[?:?]
        at java.net.InetAddress.getAllByName0(InetAddress.java:1533) ~[?:?]
▼

To fix this issue, you must specify a hostname that resolves to a real IP address by setting --serverPublishHost in console or silent install modes or in the corresponding field in GUI installation mode. Also, the exact IP address can be passed to this setting.

Changing the password for secure access to a CloudBees Analytics cluster

To change the password for secure access to a CloudBees Analytics cluster, you must perform the reconfiguration with the corresponding changes over each node in the cluster.

Additional ways to improve a cluster
Use self-signed certificates in CloudBees CD/RO on Kubernetes