Installing the Cluster Manager on Linux

The Cluster Manager is a web server and can be installed on any networked machine with access to eMake and the cluster hosts or on the main build machine where eMake is installed.

Install only one copy of the Cluster Manager, regardless of the number of hosts in the cluster or the number of machines with eMake installed. eMake is installed with the Cluster Manager by default.

If you are upgrading a previously-installed CloudBees Accelerator version, follow the upgrade instructions before installing the new version.

CloudBees does not bundle MySQL as the default local database for CloudBees Accelerator. CloudBees bundles MariaDB and installs it as the default local database on the Cluster Manager. When you perform a Cluster Manager upgrade, MariaDB replaces the local MySQL database (if applicable) and migrates all information from it.

MariaDB is an open-source database that is fully compatible with MySQL. As open-source software, it has no enterprise license support model. If using an open-source database is of concern to your organization, you can use any of the following databases as a replacement: MySQL, Oracle, or SQL Server. See the online help topic “Database Configuration” for information about configuring Accelerator to use an external database.

You can install the Cluster Manager, eMake, and agents at the same time on the same machine. The Cluster Manager is 64-bit only and thus requires installation on a 64-bit machine.

Using the GUI to Install the Cluster Manager

  1. Sign in as root.

  2. Double-click the CloudBeesAccelerator-<version>-<platform>-Install installer file.

The installation packages might need a few minutes to extract.

  1. When the Welcome screen appears, click Next.

  2. On the Setup Type screen, select Cluster Manager (eMake also installs automatically with the Cluster Manager) and click Next.

  3. On the Choose Destination Location screen, accept the default installation directory or browse to select an alternative directory.

    • Avoid selecting an alternative directory that includes spaces in the name. Spaces can create problems when configuring connections with other command-line-based components.

    • If you plan to install eMake in a non-default location, use the same location on all agent hosts and on the Cluster Manager host.

Click Next.

  1. On the Base Setup screen, modify the following settings as needed, and then click Next :

    • (Optional) Unselect Install Electric Runner client applications to decline installation of the tools to manage and administer an Accelerator host cluster (this is selected by default).

      For a description of these tools, see Using Cluster Manager Administration Tools.

    • (Optional) Unselect Install Visual Studio Plugin to decline installation of the CloudBees Accelerator Visual Studio Integration (this is selected by default).

    • (Optional) Select Initialize Visual Studio for ECloudInternalUsers to initialize Visual Studio automatically for these users on your agent hosts (this is unselected by default).

      For details, see Initializing Visual Studio.

      Using this checkbox can add up to 30 minutes to the installation time (depending on the number of agents and the number of installed Visual Studio versions).
  2. On the Cluster Manager screen, enter Cluster Manager configuration options:

    • Accept the default ports or type in alternative port numbers if the defaults are already in use.

      You must access the Cluster Manager web UI via HTTPS; keep this in mind when specifying an alternative port number.
    • Accept the default to keep old log files or select the checkbox to remove old log files.

    • Accept the default (checked checkbox) to leave web server log rotation turned on or clear the checkbox to turn off log rotation.

      Log rotation might affect Cluster Manager performance.
    • Select the type of database to use.

      If you do not use MariaDB, the database must already exist and you must be able to connect to it. The installer does not validate database connections.

Then click Next.

  1. On the next Cluster Manager screen, continue to enter Cluster Manager configuration options:

    • You can change the Cluster Manager admin password or accept the default password ( changeme ).

    • You do not need to migrate the existing database or back up the local database if this is your first Cluster Manager installation.

    • Fill in the user name or choose a user that the Cluster Manager service should run as or leave blank. Choose a password for the Cluster Manager service user or leave blank.

Click Next.

  1. On the Cluster Manager Database screen, type in the Cluster Manager database port number. For MS SQL, use port 1433.

If you did not select MariaDB as your database type, the following additional fields are available:

  • Database Host/IP Address

  • Database User

  • Database Password

  • Database Name

    Do not use a . (period) in the database name. A period in the name will prevent the Cluster Manager from starting.

Click Next.

  1. When the Start Copying Files screen appears, review your settings and click Next.

  2. The Installing screen displays while the installation proceeds. When installation is finished, the Complete screen displays. Click Finish.

Installation is complete. The installation log file is in the install directory’s root by default.

If Apache fails to start properly after the Cluster Manager installs, reboot the system.

Using the Interactive Command Line to Install the Cluster Manager

  1. Sign in as root.

  2. Run chmod +x ` on the `CloudBeesAccelerator-<version>-<platform>-Install installer file to ensure it is executable.

  3. Run ./<installer filename> --mode console to start the installation.

The installer displays:

This will install CloudBees Accelerator version <version> on your computer.

For information about software configuration and licensing, see the CloudBees Accelerator Installation and Configuration Guide.Enter y to continue or n to exit the installer. [n/Y]
  1. Continue the installation by entering y.

The installer displays:

Welcome to the CloudBees Accelerator installer <version>
  Build: <version>
==========================================================
This installer can install the following packages:

1 - Electric Agent/EFS
          Installs Electric Agent/EFS and Electric Make.
2 - Electric Make
          Installs Electric Make.
3 - Cluster Manager
          Installs Cluster Manager and Electric Make.
4 - Cluster Manager and Electric Agent
          Installs Cluster Manager, Electric Make and Electric Agent/EFS on same host.
Select a package to install by entering the corresponding number:  [2]
  1. Enter 3 to select the Cluster Manager package and press Enter.

Provide the following Cluster Manager configuration information. You can accept the defaults or type in alternatives.

Where do you want to install CloudBees Accelerator ? [opt/ecloud]
Setup was unable to locate a PDF reader. To view the included documentation enter the path to a PDF reader []Install Electric Runner client apps? [n/Y]
Cluster Manager HTTP port: [80] Cluster Manager HTTPS port: [443]
Cluster Manager Accelerator Server port: [8030]Cluster Manager Secure Accelerator Server port: [8031]Remove Cluster Manager old logs [y/N]Rotate Cluster Manager logs [y/N]Database Type: [MariaDB]Cluster Manager Service User: [eacmuser]Cluster Manager Admin Password: [changeme]Migrate existing database [n/Y]Back up local MariaDB database [y/N]Database Port: [3306]Database Host/IP address: [localhost]Database User: [ecloud]Database Password: [ecloud]Database Name: [ecloud]
Turning on log rotation might affect Cluster Manager performance.
Do not use a . (period) in the database name. A period in the name will prevent the Cluster Manager from starting.

The installer installs Cluster Manager using the configuration details you entered, followed by Installation complete when the install completes.

The installation log file is in the install directory’s root, /opt/ecloud by default.

Linux operating systems contain a 1024 default file descriptor limit for each process. However, this does not mean 1024 builds can be run concurrently. Depending on the size of your builds, you might be able to run only 300–400 builds concurrently because of other file descriptor activity and the collection activity between eMake and the Cluster Manager. If you must run more than 300–400 builds simultaneously, increase the default file descriptor limit.

If Apache fails to start properly after a fresh Cluster Manager install, reboot the system.