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

Run an express agent GUI installation

4 minute readReferenceExtensibility

The CloudBees CD/RO agent software must be installed on each agent machine you intend to use with CloudBees CD/RO. Review Before You Install CloudBees CD/RO before performing this procedure.

Install {PRODUCT agent software on Windows or Linux with this installation method. For macOS or other supported UNIX-only agent machines, see Non-Server Platform Agent Installation Method.

  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 Express Agent installation option, and then click Next to continue.

    The Remote CloudBees CD/RO server screen appears.

  4. Complete the following information on the Remote CloudBees CD/RO server screen.

    The screen examples in this procedure are from a Windows system. Different options will appear in some windows on a Linux system.

    • Server Host Name —Use this field to enter the name of the CloudBees CD/RO server that will communicate with this agent. If the remote server is using a non-default HTTPS port, you must specify the Server Host Name as <host>:<port>. If you do not specify a port, HTTPS port 8443 is assumed (the same as the CloudBees CD/RO server default port).

    • CloudBees CD/RO User Name —Use this field to enter the name of a CloudBees CD/RO user on the CloudBees CD/RO server who has sufficient privileges to create a resource. This field defaults to the CloudBees CD/RO-supplied admin user.

    • Password —Use this field to enter the password for the CloudBees CD/RO user. The default password for the admin user is changeme.

    • Discover the plugins directory —Select this check box if you want the agent machine to have access to the plugins directory. You should allow access to the plugins directory so agents have access to collections of features, third-party integrations, or third-party tools.

      The plugins directory on the CloudBees CD/RO server must be “shared” before the agent machine can use “discover” to find the directory. For more information, see Universal Access to the Plugins Directory.

    • Create a resource—Select this check box if you want to create a resource on the remote CloudBees CD/RO server for the agent you are installing.

    • Trusted —Select this check box to restrict this agent to one CloudBees CD/RO server. The agent will not respond to incoming communication from any other CloudBees CD/RO server. This is useful when you want to create a secure production environment, but generally not needed for test or development systems.

    • Resource Name —Use this field to enter the name of the resource you would like to use for the agent. This field is available for use when the Create a resource check box is selected.

    • Create in default zone —Select this check box if you want to create the agent in the default zone.

    • Agent Gateway URL —Use this field to enter the URL of the gateway used to communicate with the CloudBees CD/RO server. This field is available for use when the Create in default zone check box is cleared.

    • Zone Name —Use this field to enter the name of the zone used during remote agent and or remote repository creation. This field is available for use when the Create in default zone check box is cleared.

  5. Click Next to continue. The Agent service account screen appears.

  6. Select the appropriate steps for your platform and complete the following information on the screen.

    • Windows:

      • User Name —Use this field to 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 — Use this field to enter the password of the user who will run the CloudBees CD/RO agent service.

      • Domain —Use this field to 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 Windows local 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.

    • 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 who owns the CloudBees CD/RO agent process.

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

  8. Review this screen to verify your selections. Use the Back button to change any of your settings if necessary.

  9. Click Next to continue.

  10. CloudBees CD/RO installs the agent and tools components. This process can take a few minutes:

    When the install process is complete, the Install Wizard Complete screen appears.

  11. Click Finish to complete the installation.

Install a custom configuration
Run an express GUI installation (agent-only installer)