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

Installation types

7 minute readReference

This section describes the various installation interfaces and available options for specific platform types.

For more information on which operating system versions are supported, refer to Supported platforms for CloudBees CD/RO on traditional platforms.

GUI installations (Windows and X Window)

This section describes the GUI-based installation options available for CloudBees CD/RO on supported Windows operating systems and Linux platforms with the X Window System installed.

CloudBees CD/RO full installer

The following GUI-based installation options are available for CloudBees CD/RO using the full installer.

To download the latest CloudBees CD/RO installers, navigate to the CloudBees downloads page.

Express Server

CloudBees recommends this installation option for quickly installing CloudBees CD/RO software for evaluation, development, and testing purposes. This option installs the CloudBees CD/RO server, web server, repository server, built-in database, and agent on one machine. Additionally, CloudBees Tools are installed. The default CloudBees CD/RO server settings are used. For more information, refer to Install a default configuration.

The CloudBees CD/RO installer includes a demo license that limits the software to two concurrent job steps and installing the CloudBees CD/RO-provided built-in database. Using the built-in database is not supported in clustered CloudBees CD/RO environments. Additionally, this option does not support migrating data when you upgrade to newer CloudBees CD/RO versions.

Using an external database requires a CloudBees CD/RO enterprise license. You must configure an external database when you install your enterprise license to prevent error messages about an unsupported configuration or a license requirement. This is not supported using the Express Server option.

Advanced

CloudBees recommends using this option for production environments and to install CloudBees CD/RO components on separate machines. Using this option allows you to install and configure individual components, directories, and ports.

For production environments, CloudBees recommends installing each CloudBees CD/RO component on separate machines. Additionally, there are specific agent security recommendation that can be found on Agent security recommendations.

This option also allows you to install single components or any combination of the CloudBees CD/RO server, built-in/external database, web server, repository server, or agent on the machine. A local agent and CloudBees Tools are also automatically installed. For more information, refer to Install a custom configuration.

Express Agent

CloudBees recommends this option for installing an agent on managed hosts where you want to run job steps. This option installs a single CloudBees CD/RO agent or trusted agent and CloudBees Tools. For more information, refer to Run an express agent GUI installation.

There are specific agent security recommendation that can be found on Agent security recommendations.
To install agents on multiple machines, refer to Silent unattended installation.

CloudBees Analytics prerequisites

The CloudBees CD/RO full installer includes two GUI-based options to install the prerequisites for CloudBees Analytics:

These options do not install CloudBees Analytics; they only install the required CloudBees CD/RO components to run CloudBees Analytics. To install CloudBees Analytics, refer to CloudBees Analytics installer.

  • Install CloudBees Analytics prerequisites with the built-in database.

    • CloudBees recommends this option for local evaluation, development, and testing purposes with the build-in database. It should not be used for production environments, and cannot be used to cluster CloudBees Analytics.

    • This option installs the CloudBees CD/RO server, web server, built-in database, agent, and CloudBees Tools on one machine.

  • Install CloudBees Analytics prerequisites without the built-in database.

    • CloudBees recommends this option for local evaluation, development, and testing purposes using your database. It should not be used for production environments. It may be used for testing clustered CloudBees Analytics environments.

    • This option installs the CloudBees CD/RO server, web server, agent, and CloudBees Tools on one machine.

      After installation, you must configure your own custom database, which requires a CloudBees CD/RO enterprise license. Refer to Configure an external database for more information.

CloudBees CD/RO agent installer

The following GUI-based installations are possible using the standalone CloudBees CD/RO agent installer:

To download the latest CloudBees CD/RO installers, navigate to the CloudBees downloads page.

  • Express Agent: Install an agent to run jobs on a remote instance of CloudBees CD/RO using default configurations for ports, installation and data directories, and other settings. This method also includes an option to assign the agent as a Trusted agent, which ensures it only accepts jobs from the specific configured server. For more information, refer to Run an express GUI installation (agent-only installer).

  • Advanced Agent: Install an agent to run jobs on a remote instance of CloudBees CD/RO using custom configurations for ports, installation and data directories, and other settings. This method also includes an option to assign the agent as a Trusted agent, which ensures it only accepts jobs from the specific configured server. For more information, refer to Run an advanced GUI installation (agent-only installer).

There are specific agent security recommendation that can be found on Agent security recommendations.

CloudBees Analytics installer

The standalone CloudBees Analytics installer allows GUI-based installations of CloudBees Analytics. During installation, you can:

To download the latest CloudBees CD/RO installers, navigate to the CloudBees downloads page.

  • Configure custom setting for CloudBees Analytics, such as ports, installation and data directories, and other settings.

  • Configure local or remote CloudBees CD/RO servers to communicate with.

  • Configure clustering options for CloudBees Analytics.

    Clustering CloudBees Analytics requires a CloudBees CD/RO enterprise license.

For more information, refer to Install CloudBees Analytics.

Interactive CLI installation (Linux)

These installation options provide interactive CLI prompts for installing CloudBees CD/RO on a supported server platform. These installation methods are available only for Linux platforms.

CloudBees CD/RO full installer

This section describes the CLI-based installation options available for CloudBees CD/RO using the full installer for Linux.

To download the latest CloudBees CD/RO installers, navigate to the CloudBees downloads page.

Express Server

CloudBees recommends this installation option for quickly installing CloudBees CD/RO software for evaluation, development, and testing purposes. This option installs the CloudBees CD/RO server, web server, repository server, built-in database, and agent on one machine. Additionally, CloudBees Tools are installed. The default CloudBees CD/RO server settings are used. For more information, refer to Run an express server command-line installation.

The CloudBees CD/RO installer includes a demo license that limits the software to two concurrent job steps and installing the CloudBees CD/RO-provided built-in database. Using the built-in database is not supported in clustered CloudBees CD/RO environments. Additionally, this option does not support migrating data when you upgrade to newer CloudBees CD/RO versions.

Using an external database requires a CloudBees CD/RO enterprise license. You must configure an external database when you install your enterprise license to prevent error messages about an unsupported configuration or a license requirement. This is not supported using the Express Server option.

SDA

The CloudBees CD/RO full installer includes a CLI-based options to install the prerequisites for CloudBees Analytics.

This option does not install CloudBees Analytics; it only installs the required CloudBees CD/RO components to run CloudBees Analytics. To install CloudBees Analytics, refer to CloudBees Analytics installer.

  • SDA option with the built-in database option:

    • CloudBees recommends this option for local evaluation, development, and testing purposes with the build-in database. It should not be used for production environments, and cannot be used to cluster CloudBees Analytics.

    • This option installs the CloudBees CD/RO server, web server, built-in database, agent, and CloudBees Tools on one machine.

  • SDA option without the built-in database option:

    • CloudBees recommends this option for local evaluation, development, and testing purposes using your database. It should not be used for production environments. It may be used for testing clustered CloudBees Analytics environments.

    • This option installs the CloudBees CD/RO server, web server, agent, and CloudBees Tools on one machine.

      After installation, you must configure your own custom database, which requires a CloudBees CD/RO enterprise license. Refer to Configure an external database for more information.

Express Agent

CloudBees recommends using this option to install an agent on managed hosts where you want to run job steps. This option installs a single CloudBees CD/RO agent or trusted agent and CloudBees Tools.

To install agents on multiple machines, refer to Silent unattended installation.

Advanced

CloudBees recommends using this option for production environments and to install CloudBees CD/RO components on separate machines. Using this option allows you to install and configure individual components, directories, and ports.

For production environments, CloudBees recommends installing each CloudBees CD/RO component on separate machines. Additionally, there are specific agent security recommendation that can be found on Agent security recommendations.

This option allows you to install single components or any combination of the CloudBees CD/RO server, built-in/external database, web server, repository server, or agent on the machine. A local agent and CloudBees Tools are also automatically installed.

CloudBees Analytics installer

The standalone CloudBees Analytics installer for Linux platforms allows CLI-based installations of CloudBees Analytics. During installation, you can:

To download the latest CloudBees CD/RO installers, navigate to the CloudBees downloads page.

  • Configure custom setting for CloudBees Analytics, such as ports, installation and data directories, and other settings.

  • Configure local or remote CloudBees CD/RO servers to communicate with.

  • Configure clustering options for CloudBees Analytics.

    Clustering CloudBees Analytics requires a CloudBees CD/RO enterprise license.

For more information, refer to Install the CloudBees Analytics server with the interactive command-line installer.

For more information about clustering CloudBees Analytics, refer to Install the CloudBees Analytics server in cluster mode.

CloudBees CD/RO agent installer

The following CLI-based installations are possible using the standalone CloudBees CD/RO agent installer for Linux:

To download the latest CloudBees CD/RO installers, navigate to the CloudBees downloads page.

  • Express Agent: Install an agent to run jobs on a remote instance of CloudBees CD/RO using default configurations for ports, installation and data directories, and other settings. This method also includes an option to assign the agent as a Trusted agent, which ensures it only accepts jobs from the specific configured server. For more information, refer to Run an express GUI installation (agent-only installer).

  • Advanced Agent: Install an agent to run jobs on a remote instance of CloudBees CD/RO using custom configurations for ports, installation and data directories, and other settings. This method also includes an option to assign the agent as a Trusted agent, which ensures it only accepts jobs from the specific configured server. For more information, refer to Run an advanced GUI installation (agent-only installer).

There are specific agent security recommendation that can be found on Agent security recommendations. TIP: To install agents on multiple machines, refer to Silent unattended installation.

Silent unattended installation

CloudBees recommends this option for installing multiple remote agents, servers, or CloudBees Analytics servers using a non-interactive command-line. This installation also includes the ability to add CloudBees Analytics servers to a CloudBees Analytics cluster. Silent unattended installation are supported for:

For more information about silent unattended traditional installation, refer to Silent unattended traditional installation

Non-server platform agent interface (UNIX)

This is a command-line interface for installing the CloudBees CD/RO agent and tool software on supported non-server platforms.

The installations options are:

  • Command-line agent: Installs an agent from a UNIX command-line installer.

  • Silent agent: Runs unattended (silent) installations with the UNIX installer.

For more information on installing non-server UNIX agents Non-server installation for UNIX agents.
Installation user requirements
Default installation directories