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

Configure repository servers

3 minute readScalability

This section describes how to configure repository servers for high availability.

Overall Steps for Configuring Repository Servers

The overall steps for configure repository servers for high availability are as follows:

IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].

Duplicating Repository Contents to a New Repository Server

To duplicate the contents of an existing repository server to a new repository server:

  1. Stop both repository servers.

  2. Copy the entire contents of the repository backingstore directory from the existing repository server to the corresponding location on the new repository server.

    The default location for the backingstore directory ( DATA_DIR/repository-data ) is: UNIX— /opt/cloudbees/sda/repository-data Windows— C:\ProgramData\CloudBees\Software Delivery Automation\repository-data

  3. Restart both repository servers.

Configuring Each Existing Repository Server for Clustered Operation

Additional configuration is required for any repository server that existed before being converted to operate in a cluster or was not configured to point to a remote server location during installation. You must point each of these repository servers to the CloudBees CD/RO server’s load balancer machine instead of directly to a CloudBees CD/RO server. To do so, enter the following command on each repository server:

/opt/cloudbees/sda/bin/ecconfigure --repositoryTargetHostName load_balancer_FQDN
▼

This avoids an AccessDenied error when an artifact is uploaded from the Automation Platform UI:

To point a repository server to the CloudBees CD/RO server’s load balancer machine:

  1. Locate the ecconfigure tool.

    • On Linux, it is usually at /opt/cloudbees/sda/bin/ecconfigure.

    • On Windows, it is usually at C:\Program Files\CloudBees\Software Delivery Automation\bin\ecconfigure.exe.

  2. Run the tool with the following option on the repository server.

    You might need to do this as root or with administrator privileges:

    ecconfigure --repositoryTargetHostName load_balancer_FQDN
    ▼

    where load_balancer_FQDN is the fully-qualified domain name of your CloudBees CD/RO server’s load balancer machine.

Pointing Each Repository Server to the Repository Backingstore

In a non-clustered configuration, the repository server is configured to store artifact versions in a directory called the repository backingstore. By default, the backingstore is the DATA_DIR/repository-data directory in the repository installation. In a clustered configuration, you must point each repository server to a common backingstore location.

Windows

In C:\ProgramData\CloudBees\Software Delivery Automation\conf\repository\server.properties on each repository server, set REPOSITORY_BACKING_STORE to a UNC path to a network share on the file server, and then restart that repository server.

For example, set:

REPOSITORY_BACKING_STORE=//10.0.109.72/repo_data/repository-data
▼

You can also configure this by running the ecconfigure --repositoryStorageDirectory command on each repository server. For example, enter:

ecconfigure --repositoryStorageDirectory //10.0.109.72/repo_data/repository-data
▼

Linux

If the network file share is Linux, mount it to the DATA_DIR/repository-data on all repository servers. For example, you can mount the file share for DATA_DIR/repository-data in the /etc/fstab file on each Linux repository server.

This means that you do not need to run the ecconfigure –repositoryStorageDirectory command to change REPOSITORY_BACKING_STORE from its REPOSITORY_BACKING_STORE= repository-data default value.

Opening the 7800 and 8200 Firewall Inbound Ports on Each Repository Server

On each repository server, make sure that the firewall inbound ports for 7800 and 8200 are open. This allows the load balancer to balance these ports.

Load balancing the repository local agent port 7800 is optional. If you choose to do so, you can register just the repository local agent load balancer port 7800 in the DevOps Essentials  Platform Home Page  Cloud  Resources page on the CloudBees CD/RO server. Otherwise, you must register each repository local agent on the Resources page.

Registering the Repository to the CloudBees CD/RO Cluster

You must use the load balancer URL to register the repository to the CloudBees CD/RO cluster so that the CloudBees CD/RO server can find the repository server load balancer. To do so:

  1. Navigate to DevOps Essentials  Platform Home Page  Artifacts  Repositories on the CloudBees CD/RO server.

  2. Verify that URL for the specified Repository Name points to the load balancer machine.

Registering the Repository Local Agents to the CloudBees CD/RO Cluster

You must register the repository local agents to the CloudBees CD/RO cluster. You can do this by registering only the load balancer as the agent resource if you already load-balanced port 7800 of the repository local agents.

If you did not load balance port 7800, you must register each repository local agent in the DevOps Essentials  Platform Home Page  Cloud  Resources page on the CloudBees CD/RO server.

Re-Creating a Deleted DATA_DIR /tmp Directory on a CloudBees CD/RO Web Server

Each CloudBees CD/RO web server that is load balanced requires a DATA_DIR/tmp directory. When you upload artifacts using the Automation Platform UI, that web server uses this folder as an intermediate location to upload the artifacts to the repository. This means that if the following error appears on a web server during file upload from the UI, you must re-create this folder on that machine:

Upload file: Error in tempdir() using /app/cloudbees/sda/tmp/XXXXXXXXXX:
Parent directory (/app/cloudbees/sda/tmp) does not exist
▼
Install CloudBees CD/RO software
Configure machines to operate in clustered mode