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

CloudBees Tools installation

3 minute readReference

Starting with release 2023.03.0 for Linux and 2023.04.0 for Windows and macOS, CloudBees CD/RO releases include a CloudBees Tools archive you can add to your installation. This archive includes the CloudBees CD/RO client binaries used to interact with CloudBees CD/RO server and serves as a lightweight option compared to installing the tools separately using multiple installers.

CloudBees CD/RO is normally backward compatible with older versions of CloudBees Tools as long as you are using the latest API version. However, to assure you have the latest CloudBees Tool features and API support, you must update the CloudBees Tools client binaries to the latest version as they are released.

For information on upgrading the CloudBees Tools archive to the latest version, refer to Updating CloudBees Tools.

The following tool commands are included in the CloudBees Tools archive:

Install CloudBees CD/RO Tools

Use the information in this section to complete the installation of the CloudBees CD/RO tools.

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

  2. Extract the archive files into a CloudBeesFlowTools-<version> directory within the current directory.

    • Linux, Linux ARM, and macOS:

      • Run the command below in the directory containing the archive file.

        Command
        Current version
        tar -xf CloudBeesFlowTools-<version>.tar.gz
        ▼
        tar -xf CloudBeesFlowTools-2024.09.0.176472.tar.gz
        ▼

    • Windows 10 and later:

      • Right-click on the archive file. Then select Extract all.

  3. Add CloudBees CD/RO tools to system path.

    • Linux and macOS:

      Command
      Current version
      export PATH=/path/you/installed/CloudBeesFlowTools-<version>/bin:$PATH
      ▼
      export PATH=/path/you/installed/CloudBeesFlowTools-2024.09.0.176472/bin:$PATH
      ▼

    • Windows 10 and later:

      • Add the following to the PATH environmental variable using your chosen method:

        Command
        Current version
        path\you\installed\CloudBeesFlowTools-<version>\bin
        ▼
        path\you\installed\CloudBeesFlowTools-2024.09.0.176472\bin
        ▼

Verify access to CloudBees CD/RO Tools

After installing CloudBees CD/RO tools test access to them using the --help for each tool.

  • Access cb-perl command help:

    View access details

    • Linux and macOS

      • Access via archive folder.

        cb-perl --help
        ▼

      • Access using a relative path

        bin/cb-perl --help
        ▼

      • Access using the full path.

        Command
        Current version
        /path/you/installed/CloudBeesFlowTools-<version>/bin/cb-perl  --help
        ▼
        /path/you/installed/CloudBeesFlowTools-2024.09.0.176472/bin/cb-perl  --help
        ▼

    • Windows

      Access the *.exe from the CloudBeesFlowTools-<version>/bin.

      Command
      Current version
      \path\you\installed\CloudBeesFlowTools-<version>\bin\ectool.exe --help
      ▼
      \path\you\installed\CloudBeesFlowTools-2024.09.0.176472\bin\ectool.exe --help
      ▼

  • Access dslsync command help:

    View access details

    • Linux and macOS

      • Access via archive folder.

        dslsync --help
        ▼

      • Access using a relative path

        bin/dslsync --help
        ▼

      • Access using the full path.

        Command
        Current version
        /path/you/installed/CloudBeesFlowTools-<version>/bin/dslsync --help
        ▼
        /path/you/installed/CloudBeesFlowTools-2024.09.0.176472/bin/dslsync --help
        ▼

    • Windows

      Access the *.exe from the CloudBeesFlowTools-<version>/bin.

      Command
      Current version
      \path\you\installed\CloudBeesFlowTools-<version>\bin\dslsync.exe --help
      ▼
      \path\you\installed\CloudBeesFlowTools-2024.09.0.176472\bin\dslsync.exe --help
      ▼

  • Access ectool command help:

    View access details

    • Linux and macOS

      • Access via archive folder.

        ectool --help
        ▼

      • Access using a relative path

        bin/ectool --help
        ▼

      • Access using the full path.

        Command
        Current version
        /path/you/installed/CloudBeesFlowTools-<version>/bin/ectool --help
        ▼
        /path/you/installed/CloudBeesFlowTools-2024.09.0.176472/bin/ectool --help
        ▼

    • Windows

      Access the *.exe from the CloudBeesFlowTools-<version>/bin.

      Command
      Current version
      \path\you\installed\CloudBeesFlowTools-<version>\bin\ectool.exe --help
      ▼
      \path\you\installed\CloudBeesFlowTools-2024.09.0.176472\bin\ectool.exe --help
      ▼

  • Access ec-groovy command help:

    View access details

    1. Execute export commands

      export COMMANDER_HOME=/path/you/installed/CloudBeesFlowTools
      ▼
      export COMMANDER_DATA=/path/you/installed/CloudBeesFlowTools
      ▼

    2. Access ec-groovy help.

      ec-groovy --help
      ▼

Updating CloudBees Tools

CloudBees CD/RO is normally backward compatible with older versions of CloudBees Tools as long as you are using the latest API version. However, to assure you have the latest CloudBees Tool features and API support, you must update the CloudBees Tools client binaries to the latest version as they are released. To get the latest tool versions:

  1. Navigate to CloudBees CD/RO downloads.

  2. Select the latest release for CloudBees CD/RO.

  3. Download the CloudBees Tools archive file for your distribution.

    1. Linux, Linux ARM, and macOS: CloudBeesFlowTools-<version>.tar.gz

    2. Windows: CloudBeesFlowTools-<version>.zip

  4. Extract the archive in the same location as your current version.

    For specific instructions on extracting the archive, refer to Install CloudBees CD/RO Tools.

  5. If prompted to override existing files, you may answer Yes to All.

Uninstall CloudBees Tools

To uninstall the tools, remove them from your $PATH (if added) and delete all source files.