Install CloudBees Analytics

The 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.

For details about the overall steps for installing CloudBees Analytics on a group of servers to create a CloudBees Analytics server cluster, refer to Installing the CloudBees Analytics Server in Cluster Mode.

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

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.09.0.176472
- Linux CloudBees Analytics installer: 2024.09.0.176472
  - A Linux graphical environment is required to run the GUI installer.
For more details on installers, refer to Install CloudBees CD/RO on traditional platforms.

For legacy installer downloads, navigate to CloudBees CD/RO downloads.
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 CloudBeesSDAAnalyticsServer-x64-<version>
    ▼
    
    chmod +x CloudBeesSDAAnalyticsServer-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:
    
    Navigate to the directory where you downloaded CloudBees CD/RO.
    
    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.09.0.176472 --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. Click Next to continue. The Directories screen appears.
Review Install directory and Data directory default locations; select Browse to specify different directory locations. Click Next to continue. The Service account screen appears.
If you have a Windows system, complete the information on the Service Account screen as follows:
- User Name: Name of the user who will run the CloudBees Analytics server services.
- Password: Password of the user who will run the CloudBees Analytics server services.
- Domain: Domain name information for the user. Leave this field blank if this is a local user.
- Use the local system account: Select this check box if you want the CloudBees Analytics server to run as the local Windows system account.
If you have a Linux system, complete the information on the Service Account screen as follows:
- User Name—Name of the user who owns the CloudBees Analytics server processes.
- Group Name—Name of the group who owns the CloudBees Analytics server processes.
Click Next to continue. The Configure Services screen appears.
Review information on the Configure Services screen:
- Hostname or IP address: Name of the host that will be used to access the installed CloudBees Analytics server.
  
  IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
- Publish host: The network address that the CloudBees Analytics node advertises to other nodes in the cluster, so that those nodes can connect to it
- Server port: Port number to be used to access CloudBees Analytics.
- Node communication port: Port number used for internal communication between nodes within the CloudBees Analytics cluster.
- Heap size (MB): Heap size for CloudBees Analytics in megabytes.
- Number of primary shards in indices — Number of primary shards in the CloudBees Analytics index.
  
  Complete the information on the Configure Services screen, and click Next to continue. The Cluster Settings screen appears.
Check Configure CloudBees Analytics Server for a clustered deployment if you want to add this system to a CloudBees Analytics server cluster. If you do so, additional fields appear to let you enter the details about this node and the cluster. Otherwise, select Next to proceed to the next step.
- Cluster name: Name of the cluster.
- List of other nodes in the cluster that are likely to be live and reachable — Additional nodes that are running CloudBees Analytics and can become part of the cluster. These can be any nodes (whether they are master-eligible or not). You can enter any combination of IP addresses or host names.
  
  This is mandatory for additional nodes and optional for the first node. You should specify in this list all available master nodes.
- Node name: Name of this node in the cluster. This serves as a unique identifier and therefore must be a unique name in the cluster.
- This is the first node in the cluster: Check this checkbox if this is the first node that you are adding to the cluster.
- Configure as master-eligible node: Makes this node eligible to be elected as a master node. Master-eligible nodes participate in updating the cluster state as well as elections of the master node. A master-eligible node can also be a data node. The first node that you add to a cluster is always a master-eligible node (and also a data node).
- Configure as data node: Determines whether this node will be a data node. A data node stores data that is indexed into CloudBees Analytics and performs data-related operations such as CRUD, search, and aggregations. A data node can also be a master-eligible node. The first node that you add to a cluster is always a data node (and also a master-eligible node).
  
  After completing setting on the Cluster Settings, click Next to continue. The Security Settings screen appears.
  - Allow unsecured access to CloudBees Analytics Server: Check this field if you do not want to use a secure protocol and authentication when accessing the CloudBees Analytics server:
  - Otherwise, the Password and Confirm password fields let you enter the server password:
  - Password: Password to be used to access the server. The installer will automatically create a user with user name reportuser and the password that you specified. If you do not specify a password, the installer will generate a default password. (CloudBees recommends that you change this password.)
  - Confirm password: Confirm the password. Enter the same password in this field as in the previous field.
    
    Unsecured access is not recommended for use in a production environment.
- Configure as ingest node: Determines whether this node will be an ingest node. Ingest nodes are able to apply an ingest pipeline to a document in order to transform and enrich the document before indexing. With a heavy ingest load, it makes sense to use dedicated ingest nodes.
Complete the information on the Security Settings screen, and click Next to continue. The Advanced Settings screen appears.
Complete the information on the Advanced Settings screen.
- Use a different directory for data stored by the server: Check if you want to use a non-default directory for CloudBees Analytics index data. If you do so, the Server data directory field appears to enter that directory. Otherwise, CloudBees Analytics data is stored in the default data directory.
Click Next to continue. The Remote CloudBees Software Delivery Automation Server screen appears.
Complete the information as follows:
- Skip CloudBees CD/RO server configuration: Determines whether to skip the automatic configuration of the remote CloudBees CD/RO server with the services being installed. If you choose to skip this option, continue to the next step. Otherwise, fill in the fields in the screen as follows:
- Server host name: Name of the CloudBees CD/RO server that will communicate with this CloudBees Analytics server. If the remote server is using a non-default HTTPS port, you must enter <host>:<port>.
- CloudBees CD/RO User Name: Name of a CloudBees CD/RO user on the CloudBees CD/RO server who has sufficient privileges to edit server settings. This field defaults to the CloudBees CD/RO-supplied admin user.
- Password: Password for the CloudBees CD/RO user. The default password for the admin user is changeme.
Click Next to continue. The Ready to Install screen appears:
Review the Ready to Install screen to verify your selections. Use the Back button to change any of your settings if needed.

When ready, click Begin Install. The installer displays a status bar to show the progress of the installation, which can take a few minutes. When the installation is complete, the Install Wizard Complete screen appears.
On the Install Wizard Complete screen click Finish to start the installation.

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.

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>▼