Before You Install CloudBees Accelerator

You can install the software using a GUI, a "silent" installer, or (on Linux) an interactive command-line interface. Not all instructions are the same for each platform. Follow the instructions carefully for your platform. Read the procedures thoroughly before attempting to install, configure, or uninstall any component.

Supported Deployment Models for CloudBees Accelerator Components

Not all combinations of the Cluster Manager, agents, and eMake components can be installed on the hosts in your cluster. Following are the supported combinations:

Cluster Manager, agents, and eMake on a single host

You can install all Accelerator components (eMake, agents, and the Cluster Manager) on the same machine (such as for testing or other nonproduction or trial-basis situations). Note that one benefit of this type of installation is that the installer automatically sets the Cluster Manager hostname to localhost. This means that you need not use the --emake-cm=<host>:<port> eMake option when invoking a build on a machine that has all components.
Cluster Manager and eMake on one host, and agents on other hosts
Cluster Manager on one host, and eMake and agents on other hosts
Cluster Manager and agents on one host with eMake on a separate host

Cluster Manager and Agent Installation Location Limitations

CloudBees does not support installation of the Cluster Manager or agents on the following:

NFS
CIFS
Samba shares

Installation Directories

Executable Installation Directory

Executables are installed in a subdirectory of <InstallDir>/<arch>64/bin.

For example, on Linux, if you install in /opt/ecloud, the executables are installed in /opt/ecloud/i686_Linux/64/bin. The installer creates a link from this directory to /opt/ecloud/i686_Linux/bin.
For example, on Windows, if you install in C:\ECloud, the executables are installed in C:\ECloud\i686_win32\64\bin. The installer creates a link from this directory to C:\ECloud\i686_win32\bin.

Library Installation Directory

Libraries are installed in a subdirectory of <InstallDir>/<arch>64/lib.

For example, on Linux, if you install in /opt/ecloud, the executables are installed in /opt/ecloud/i686_Linux/64/lib. The installer creates a link from this directory to /opt/ecloud/i686_Linux/lib.
For example, on Windows, if you install in C:\ECloud, the executables are installed in C:\ECloud\i686_win32\64\lib. The installer creates a link from this directory to C:\ECloud\i686_win32\lib.

Downloading the Accelerator Software

You can download an Accelerator installer file using the following methods.

cloudbees.com Website

Go to https://www.cloudbees.com/products/accelerator/trial, then fill in the form with your contact information, and then click Submit.

CloudBees downloads website

Visit https://downloads.cloudbees.com/cloudbees-build-acceleration/, then navigate to the desired version. Available downloads are organized by major and minor version number, and then subdivided into maintenance releases.

Express Mode Installation Defaults

You can perform an Express-mode installation for the three main Accelerator components: the Cluster Manager, agents, and eMake. The following tables list the default values for this mode.

Table 1. Cluster Manager
Parameter	Default value
Cluster Manager host IP address	localhost
Install Electric Runner service	Y
Apache port (Cluster Manager HTTP port)	80
Apache SSL port (Cluster Manager HTTPS port)	443
Cluster Manager server port	8080
Cluster Manager secure server port	8081
Service user	(Windows) "" (Linux) eacmuser
Database type	MariaDB
Cluster Manager admin name	admin
Cluster Manager admin password	changeme
Database port	3306
Database host	localhost
Database name	ecloud
Database user	root
Database password	ecloud
Install directory	(Windows) `C:\ECloud` (Linux) `/opt/ecloud`
(Linux) Cluster Manager group name	nobody

Table 2. Agent
Parameter	Default value
Cluster Manager host IP address	localhost
Install Electric Runner service	Y
Cluster Manager Accelerator server port	8030
Electric Runner server port	2411
Install directory	(Windows) `C:\ECloud` (Linux) `/opt/ecloud`
Cluster Manager name	localhost (but can be changed in Express mode)
Cluster Manager port	8030
Agent secure console port	N
Agent is on-demand host	N
Remove logs	N
Reboot if needed	N
Agent temporary directory	(Windows) `C:\Windows\temp` (Linux) `/tmp`
Install Electric Runner server	Y
Electric Runner port	2411
Remove logs	N

In the interactive command line and GUI installation modes, when you choose the Express installation type and select an Agent installation (or a Full installation, which includes agents), the installer displays how many agents that it will configure. For example: Configured 2 agent(s).

Table 3. eMake
Parameter	Default value
Install directory	(Windows) `C:\ECloud` (Linux) `/opt/ecloud`
Install Electric Runner client apps	Y
Allow multiple eMake installations in separate directories	N

Installation Log File and Installer Error Messages

The installation log file ( install_$timestamp.log ) is in the installation directory’s root by default. For example, /opt/ecloud/install_20190701_1502.log on Linux or C:\ECloud\install_20190701_1502.log on Windows.

Installer error messages appear in this file. For detailed information about the most common error messages for the Installer component of CloudBees Accelerator, see Installer Error Messages. The range for Installer error codes is 6000–6999.