Introduction
Introduction
IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsScale build resources manually using a procedureConfigure 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 configurationInstall an express agent (full installer)Install an express agent (agent-only installer)Install an advanced agent (agent installer)Install CloudBees Analytics
IntroductionInstall a default configurationInstall a custom configurationInstall an express agent (full installer)Express agent command-line installation (agent-only installer)Advanced command-line installation (agent-only installer)Install CloudBees Analytics
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
IntroductionManage service catalogsManage service catalog itemsManage custom filters for catalogs and catalog items
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 an express agent (agent-only installer)

5 minute readReferenceExtensibility

This page covers how to install CloudBees CD/RO agents using the GUI-based Express Agent option of Windows and Linux agent installers.

To perform a GUI-based installation for Linux, you must have a graphical environment installed. If your Linux environment does not have a graphical environment installed, refer to the corresponding interactive Linux command-line option to continue installation.

The Express Agent option installs the following CloudBees CD/RO components on the host machine:

  • Agent

  • CloudBees CD/RO tools

Before you start

The following are important knowledge prerequisites to review before starting this procedure:

Perform an Express Agent installation

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

  2. Start the installer:

    • Windows:

      Windows installers
      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:

      Linux installers

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

        Command
        Current version
        chmod +x CloudBeesFlowAgent-x64-<version>
        ▼
        chmod +x CloudBeesFlowAgent-x64-2024.12.0.177508
        ▼

      2. Start the installation:

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

        • For root or sudo installations:

          Root or sudo procedures

          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:

          Non-root/non-sudo procedures
          Command
          Current version
          ./CloudBeesFlowAgent-x64-<version> --nonRoot
          ▼
          ./CloudBeesFlowAgent-x64-2024.12.0.177508 --nonRoot
          ▼

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

  3. Select the Express Agent installation option, and then select Next to continue. The Remote CloudBees CD/RO server screen appears.

  4. On the Remote CloudBees CD/RO server screen, configure the following:

    Configure the remote CloudBees CD/RO server:

    • Server host name: Enter the name of the remote CloudBees CD/RO server that will communicate with this web server.

      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 Username: Enter the name of a CloudBees CD/RO server user with sufficient privileges to create a resource. This field defaults to the CloudBees CD/RO-supplied admin user.

    • Password: Enter the password for the user entered in CloudBees CD/RO Username.

    • Discover the plugins directory: Select this checkbox to allow the web server to have access to the shared plugins directory. For web server agents to access the plugins directory, which includes collections of features, third-party integrations, and third-party tools, you must select this option.

      The plugins directory on the CloudBees CD/RO server must be shared before the web server machine can discover it. For more information, refer to Configure universal access to the plugins directory.

    • Create a resource: Select this checkbox if you want to create a resource on the remote CloudBees CD/RO server for the web server you are installing.

    • Trusted: Select this checkbox to restrict this web server to one CloudBees CD/RO server.

      If Trusted is selected, the web server 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: Enter the name of the resource to use.

    • Workspace Name: Enter the name of the workspace you would like to use for the web server.

    • Create a repository: Select to create an artifact repository on this machine.

    • Repository name: Enter the name of the artifact repository to create.

    • Create in default zone: Select this checkbox to create the agent in the default zone.

    • Agent Gateway URL: Enter the URL of the gateway used to communicate with the CloudBees CD/RO server.

      This field is only available for use when the Create in default zone checkbox is cleared.

    • Zone Name: Enter the name of the zone used during remote agent and/or remote repository creation.

      This field is only available for use when the Create in default zone checkbox is cleared.

    1. Select Next to continue. The Agent service account screen appears.

  5. On the Agent service account screen, follow the platform-specific instructions below:

    • Windows:

      Configure Windows agent service account:

      • Username: Enter the username of a host user to run the CloudBees CD/RO server, web server, and repository server services.

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

      • Password: Enter the password of the user entered in Username.

      • Domain: Enter the user’s domain name, such as electric-cloud.com. Leave this field blank if this is a local user.

      • Use the local system account: Select this checkbox if you want the CloudBees CD/RO agent service 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 normally requires creating a new account on each machine.

      Select Next to continue. The Ready to install screen appears.

    • Linux:

      Configure Linux agent service account:

      • Username: Enter the username of a host user to run CloudBees CD/RO agent processes.

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

        • If you specify root, select Yes when the confirmation appears.

      • Group name: Enter the system group name for the user entered in Username.

      Select Next to continue. The Ready to install screen appears.

  1. On the Ready to install screen, review the settings and your service account configurations.

    • If any information is incorrect, use the Back button to navigate back through the configurations.

  2. Select Next to install the CloudBees CD/RO agent.

    The installer displays a status bar to show the progress of the installation. When the installation completes, the Installation complete screen appears.

  3. Select Finish to complete the installation.

Configure autostart for non-root environments

For installations performed as a Windows Administrator or with Linux root or sudo privileges, CloudBees CD/RO components start automatically upon completing the installation and during system boot. However, for non-root/non-sudo Linux installations CloudBees CD/RO components do not have the permissions to start automatically.

To configure autostart for non-root or non-sudo Linux installations of CloudBees CD/RO components, refer to Configure autostart for non-root/non-sudo Linux installations.

Install an express agent (full installer)
Install an advanced agent (agent installer)