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 CloudBees Analytics

8 minute readReferenceData analytics

This GUI installation method is supported by Windows platforms and Linux platforms running the X Window System. The following procedure includes instructions for adding a system to a CloudBees Analytics cluster during installation.

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.

Install with other CloudBees CD/RO components

For a production environment, CloudBees recommends that you install the CloudBees Analytics server on a system other than systems running other CloudBees CD/RO components (such as the CloudBees CD/RO server, web server, repository server, or agent). If you must install it on the same system (such as for testing or other non-production or trial-basis situations), refer to CloudBees Analytics server with other components for details.

Specify a temporary directory

CloudBees CD/RO includes the TEMP environment variable to enhance the installer’s functionality for all types of installations: common, agent-only, and CloudBees Analytics. As an alternative to the TEMP environment variable, CloudBees CD/RO also provides the --temp < directory > silent installation option to define a custom directory for storing temporary files, such as installer log files and runtime objects. This is particularly useful for addressing permission issues with the /tmp directory. For more information, refer to Silent installation arguments.

Installation instructions

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

    • Windows CloudBees Analytics installer: 2024.12.0.177508

    • Linux CloudBees Analytics installer: 2024.12.0.177508

      • A Linux graphical environment is required to run the GUI installer.

  2. Start the installer:

    • Windows:

      Start installer on 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:

      Start installer on Linux:

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

        Command
        Current version
        chmod +x CloudBeesSDAAnalyticsServer-x64-<version>
        ▼
        chmod +x CloudBeesSDAAnalyticsServer-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:

          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
          ./CloudBeesSDAAnalyticsServer-x64-<version> --nonRoot
          ▼
          ./CloudBeesSDAAnalyticsServer-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.

The installation wizard welcome screen displays. Select Next to continue. The Directories screen appears.

  1. The Directories screen appears. Specify the installation and data directories:

    • Select Next to install CloudBees CD/RO using the default directories.

    • Select Browse to specify different directory locations.

      1. Select Next to continue. The Service account screen appears.

  2. On the Server service account screen, follow the platform-specific instructions below:

    • Windows:

      Configure Windows server service account:

      • Username: Enter the username of a host user to run CloudBees Analytics services.

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

      • Domain: Enter the domain name information for the user. For example, electric-cloud.com.

        Leave this field blank to run CloudBees Analytics as a local user.

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

      Select Next to continue. The Configure Services screen appears.

    • Linux:

      Configure Linux server service account:

      • Username: Enter the username of a host user to run CloudBees Analytics services.

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

      Select Next to continue. The Configure Services screen appears.

  3. On the Configure services screen, configure the following:

    CloudBees Analytics uses OpenSearch for queries. These configurations are applied to the OpenSearch configuration.
    Configure CloudBees Analytics services:

    • Network settings

      • Hostname or IP address: Host used to access the CloudBees Analytics server.

      • Publish host: Network address the CloudBees Analytics node advertises to connect with other nodes.

      • Server port: Port number to access CloudBees Analytics.

      • Node communication port: Port number used for internal communication between nodes within the CloudBees Analytics cluster.

    • Performance settings

      • Heap size: Allocate memory for storing objects during runtime. Adjust based on application load and available system memory.

        For Heap size, the default value may not be sufficient for all use cases. If your environment is large, consider increasing the heap size to meet the demand.

      • Number of primary shards in indices: Set the number of primary shards to divide your index data.

        For more information on OpenSearch shards, refer to the OpenSearch Search shard routing documentation.

    1. Select Next to continue. The Cluster settings screen appears.

  4. On the Cluster settings screen:

    • If you are not configuring a CloudBees Analytics server cluster, ensure the checkbox for Configure CloudBees Analytics Server for a clustered deployment is clear, and then select Next. The Security Settings screen appears.

    • If you are configuring a CloudBees Analytics server cluster:

      1. Select Configure CloudBees Analytics Server for a clustered deployment.

      2. Complete the following settings:

        CloudBees Analytics cluster settings:

        • Cluster name: Name of the cluster.

        • List of existing cluster nodes that are expected to be live and reachable: Additional CloudBees Analytics nodes that can join the cluster, entered as IP addresses or host names. These nodes can be master-eligible or not.

          This is optional for the first node, but mandatory for adding additional nodes to the cluster. CloudBees recommends that you specify all available master nodes in this list.

        • Node name: Unique name of this node in the cluster, used as its identifier.

        • This is the first node in the cluster: Check if this is the first node you are adding to the cluster.

        • Configure as master-eligible node: Select to make this node eligible for master elections and cluster state updates. A master-eligible node can also function as a data node. The first node added to a cluster is always master-eligible and a data node.

        • Configure as data node: Select to designate this node as a data node, which stores indexed data and performs data-related operations (CRUD, search, aggregations). A data node can also be master-eligible. The first node added to a cluster is always a data node and a master-eligible node.

          After completing the Cluster Settings, select Next to continue. The Security Settings screen appears.

  5. On the Security Settings screen, configure one of the following:

    • To allow unsecured access to the CloudBees Analytics server:

      Allow unsecured CloudBees Analytics access:

      1. Select the Allow unsecured access to CloudBees Analytics server checkbox.

        For security reasons, CloudBees strongly suggests not allowing unsecured access (selecting the checkbox) for production or long-lived development or testing environments.

      2. Select Next to continue. The Advanced Settings screen appears.

    • To use CloudBees Analytics server authentication:

      Configure CloudBees Analytics server authentication:

      1. Ensure the Allow unsecured access to CloudBees Analytics Server checkbox is cleared.

      2. (Optional, but recommended) In the Password field, provide a custom password for the reportuser user.

        The installer automatically creates the reportuser administrative user, which you can use to access CloudBees Analytics. If you do not specify a reportuser password, the installer generates a default password.

        Whether using a custom or generated password, CloudBees strongly recommends that you record this password. It is required for future use when accessing the CloudBees Analytics server. If you do not have it, future upgrades for CloudBees Analytics could also result in data loss.

      3. (Optional) Reenter your custom password in the Confirm password field.

      4. Select Next to continue. The Advanced Settings screen appears.

  6. On the Advanced Settings screen, configure the following:

    Configure advanced settings:

    • Use a different directory for data stored by the server: Select if you want to use a non-default directory for CloudBees Analytics index data.

      If selected, the Server data directory field appears to enter your custom directory. Otherwise, CloudBees Analytics data is stored in the default data directory.

      By default, this data is stored in the Data directory you configured on the Directories screen.

    • PKCS#12 file containing a CA-signed certificate for the CloudBees Analytics server: If you have a PKCS#12 file for trusted communication, provide the file location.

      Select Next to continue. The Configure CloudBees CD/RO server connection screen appears.

  7. On the Configure CloudBees CD/RO server connection screen, complete the following information:

    • To skip configuring a remote CloudBees CD/RO server:

      Skip configuring a remote CloudBees CD/RO server:

      1. Select the Skip CloudBees CD/RO server configuration checkbox.

        If you choose this option, you must manually configure this connection after installation. For more information on manually connecting CloudBees Analytics to a remote CloudBees CD/RO server, refer to Configuration.

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

    • To configure a remote CloudBees CD/RO server:

      Configure a remote CloudBees CD/RO server:

      1. Ensure the Skip CloudBees CD/RO server configuration checkbox is cleared.

      2. For Server host name, enter the host URL of the CloudBees CD/RO server to connect to this CloudBees Analytics server.

        If the remote server is using a non-default HTTPS port, you must enter <host>:<port>.

      3. For CloudBees CD/RO username, enter a CloudBees CD/RO username. This field defaults to the CloudBees CD/RO-supplied admin user.

        The user entered in CloudBees CD/RO username must have sufficient privileges to edit the CloudBees CD/RO server settings.

      4. For Password, enter the password for the user entered in CloudBees CD/RO username.

      5. 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. After verifying this information, select Begin Install to install CloudBees Analytics.

    • The installer displays a status bar to show the progress of the installation, which may take several minutes.

  3. When the installation is complete, the Installation complete screen appears. Select Finish to exit the installer.

If you configured the CloudBees Analytics connection for your CloudBees CD/RO server, log into your CloudBees CD/RO. The Analytics menu options are now available in the top and left menus. For more information on using CloudBees Analytics, refer to Monitoring with CloudBees Analytics.

After installation is complete, refer to the following references as needed:

Autostart for non-root/non-sudo Linux installations

For non-root/non-sudo Linux installations, you must configure autostart for the CloudBees Analytics services. For instructions, see Configuring Services Autostart for Non-Root/Non-sudo Linux Installations.

Configuration

If you chose to skip the option to configure the remote CloudBees CD/RO server during the installation or upgrade of the CloudBees Analytics server, you must do so afterward to ensure connectivity and authentication between the CloudBees Analytics server and the CloudBees CD/RO server. To do this, navigate to Administration  Configurations  Analytics server. For details, refer to Configuring the CloudBees Analytics server.

Checking the configuration

You can confirm the correct CloudBees Analytics server settings by entering the following ectool command on the CloudBees CD/RO server command line:

ectool getAnalyticsServerConfiguration
▼

Following is sample output:

<response requestId="1" nodeId="10.30.176.76">
    <analyticsServerConfiguration>
      <analyticsServerConfigurationId>fd48b25e-e74a-11ee-9cbf-02425ed14558</analyticsServerConfigurationId>
      <analyticsServerUrl>https://prodhost.internal:9201</analyticsServerUrl>
      <createTime>2024-03-21T06:19:35.801Z</createTime>
      <enabled>1</enabled>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2024-03-21T06:20:21.521Z</modifyTime>
      <owner>admin</owner>
      <userName>reportuser</userName>
    </analyticsServerConfiguration>
</response>
▼

For details about the getAnalyticsServerConfiguration options, enter

ectool getAnalyticsServerConfiguration --help
▼

Testing connectivity and authentication

After you enable connectivity and authentication between the CloudBees Analytics server and the CloudBees CD/RO server, you can perform a test by using one of the following methods:

  • Check the Test Connection option on the Administration  Configurations  Analytics server, then select Save.

  • Enter the following ectool command on the CloudBees CD/RO server command line:

    ectool setAnalyticsServerConfiguration --testConnection 1
    ▼

    For details about the setAnalyticsServerConfiguration options, enter

    ectool setAnalyticsServerConfiguration --help
    ▼

    For example, the following response appears if the user name or password is incorrect:

    ectool error [InvalidCredentials]: HTTP/1.1 401 Unauthorized: Access to 'https://prodserver.internal:9201' is denied due to invalid credentials.
    ▼

    Also, for example, the following response appears if you specify an invalid analyticsServerUrl:

    ectool error [ConnectException]: HTTP/1.1 404 Not Found: Failed to connect to server on 'https://localhost:9201'.
    ▼

    The following example shows the response when a valid analyticsServerUrl is used:

    ectool setAnalyticsServerConfiguration --analyticsServerUrl https://prodserver.internal:9201 --testConnection 1
<response requestId="1" nodeId="10.30.176.76">
    <analyticsServerConfiguration>
      <analyticsServerConfigurationId>fd48b25e-e74a-11ee-9cbf-02425ed14558</analyticsServerConfigurationId>
      <analyticsServerUrl>https://prodserver.internal:9201</analyticsServerUrl>
      <createTime>2024-03-21T06:19:35.801Z</createTime>
      <enabled>1</enabled>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2024-03-21T06:20:21.521Z</modifyTime>
      <owner>admin</owner>
      <userName>reportuser</userName>
    </analyticsServerConfiguration>
  </response>
    ▼
Install an advanced agent (agent installer)