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 a default configuration

5 minute readReference

This section details how to install a default configuration, which includes the CloudBees CD/RO server, the web server, built-in database, agent (for running jobs), and CloudBees CD/RO tools. Review Before you install CloudBees CD/RO before performing this procedure.

The built-in database is not supported in a clustered CloudBees CD/RO configuration.

  1. If you have not already done so, download the full installer file. To download this version, select your required installer:

  2. Start the installer:

    • Windows:

      On Windows, an Administrator user is required to install CloudBees CD/RO. For more information about required user privileges, refer to Windows services user permissions.

      1. Navigate to the directory where you downloaded CloudBees CD/RO.

      2. Double-click the installer. This starts the installer in the GUI-based installation mode.

    • Linux:

      1. Enter the following command to make the installer file executable:

        Command
        Current version
        chmod +x CloudBeesFlow-x64-<version>
        ▼
        chmod +x CloudBeesFlow-x64-2024.09.0.176472
        ▼

      2. Start the installation:

        For more information about required user privileges, refer to Linux services user permissions.

        • For root or sudo installations:

          1. Navigate to the directory where you downloaded CloudBees CD/RO.

          2. Double-click the installer. This starts the installer in the GUI-based installation mode.

        • For non-root/non-sudo installations, from the terminal, run:

          Command
          Current version
          ./CloudBeesFlow-x64-<version> --nonRoot
          ▼
          ./CloudBeesFlow-x64-2024.09.0.176472 --nonRoot
          ▼

          A warning about automatic server start-up with non-root/non- sudo installations appears. Select Yes to dismiss the warning.

  3. Select the Install CloudBees CD/RO with built-in database and default configuration installation option, and then click Next to continue.

  4. Select the appropriate step for your platform and complete the information for the server service account.

    • Windows:

      • User Name —Enter the name of the user who will run the CloudBees CD/RO server, web server, and repository server services.

      • Password —Enter the password of the user who will run the CloudBees CD/RO server, web server, and repository server services.

      • Domain —Enter the domain name information for the user. For example, electric-cloud.com. Leave this field blank if this is a local user.

      • Use the local system account —Select this check box if you want the CloudBees CD/RO server, repository server, and web server services to run as the local Windows system account.

        The Windows local system account cannot access network resources such as shared file systems used for plugins or workspaces. Therefore, do not use this option for a clustered server deployment, which requires a shared file system for plugins. This option is typically used only for installing agents on numerous machines, which would otherwise require that you create a new account on each of those machines.

      • Use the same account for the agent service —Select this check box if you want the agent on the CloudBees CD/RO server machine to run as the same account.

        For security reasons in production environments, you should use a separate account for the agent service because the server account has permission to read the key file.

    • Linux: installation-directory/conf/passkey

    • Windows: installation-directory\conf\passkey The key file is used to decrypt passwords stored in CloudBees CD/RO. Using a different account for the agent service ensures that a process running on the agent cannot gain access to the key file.

    • Linux:

      • User Name —Enter the name of the user who owns the CloudBees CD/RO server, repository server, and web server processes.

      • Group Name —Enter the name of the group who owns the CloudBees CD/RO server, repository server, and web server processes.

      • Use the same account for the agent service —Select this check box if you want the same user and group to own the agent process on the CloudBees CD/RO server machine.

        For security reasons in production environments, you should use a separate user and group for the agent service because the server service has permission to read the key file

    • Linux: installation-directory/conf/passkey

    • Windows: installation-directory\conf\passkey The key file is used to decrypt passwords stored in CloudBees CD/RO. Using a different user and group for the agent service ensures that a process running on the agent cannot gain access to the key file.

      Click Next to continue. The Agent Service Account screen appears.

    If you selected the Use the same account for the agent service check box on the previous screen, you will not see this screen.

  5. Select the appropriate step for your platform and complete the information for the agent service account.

    • Windows:

      • User Name —Enter the name of the user who will run the CloudBees CD/RO agent service.

        The user that the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory.

      • Password —Enter the password of the user who will run the CloudBees CD/RO agent service.

      • Domain —Enter the domain name information for the user. For example, electric-cloud.com. Leave this field blank if this is a local user.

      • Use the local system account —Select this check box if you want the CloudBees CD/RO agent service to run as the local Windows system account.

        The local system account does not have access to network shares.

    • Linux:

      • User Name —Use this field to enter the name of the user who owns the CloudBees CD/RO agent process.

        The user/group that the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory. If you specify root, click Yes when the following confirmation appears:

      • Group Name —Use this field to enter the name of the group that owns the CloudBees CD/RO agent process.

    Click Next to continue. The Ready to Install screen appears.

  6. Review the default settings and your service account selections on the Ready to Install screen. Use the Back button to change your service account selections if necessary.

    • Review information about usage data. Uncheck the Send usage data checkbox if you do not wish to participate.

      CloudBees Software Delivery Automation server has the ability
to send information about its use, which helps to make CloudBees Software Delivery Automation
better and more intuitive. Telemetry collects anonymized aggregated information
and does not collect any identifying information like user names.
For privacy reasons, you can turn off the ability to send telemetry data to CloudBees.
      ▼
      The Send usage data option appears for new installations or upgrades from versions that didn’t have the ability to send usage data (v10.0 and earlier).

    • Click Next to continue.

      The installer displays a status bar to show the progress of the installation, which can take fifteen minutes. When the install process is complete, the Install Wizard Complete screen appears:

      The CloudBees CD/RO server automatically starts when the installation is complete.

  7. Select the Launch a web browser to login to CloudBees CD/RO check box if you want CloudBees CD/RO to open the sign-in screen when you exit the wizard.

  8. Click Finish to close the wizard.

  9. For non-root/non-sudo Linux installations, configure autostart for the CloudBees CD/RO services.

    For instructions, see Configuring services autostart for non-root/non-sudo Linux installations.

Introduction
Install a custom configuration