Installing Components

Incredibuild is installed in the /opt/incredibuild directory, however, the data files are stored in the data directory you specify in the installation commands.

Installation Prerequisites

  1. Verify that your machines meet all operating system and hardware requirements.

  2. Verify that Security-Enhanced Linux (SELinux) is disabled. For details, see Disabling SELinux.

  3. If your linux distribution does not have the following packages, you will need to add them manually: lbzip2, bzip2.

  4. Incredibuild requires the following ports: 2088, 2089, 8080, 8081, 9952, and 9953. If they are not available, use the G ,N, and L flags when running the installation commands below to modify the ports.

  5. Get the installer file by registering on our website. If you are already a registered customer but you need the installer file, contact sales@Incredibuild.com.

  6. Copy the installer file to any machine you want to install Incredibuild on.

  7. Running the installer must be done by a user with root user permissions.

Installation Examples

Modify the examples below depending on the exact name and version of your installation file:

Install Primary Coordinator with Initiator and Helper Agents

sudo bash ./incredibuild_<version>.ubin install -C -S -A <Path_to_Incredibuild_Installation_Directory> -P

Install Initiator and Helper Agent Only

sudo bash ./incredibuild_<version>.ubin install -S -O <Primary_Coordinator_Machine_IP_or_Hostname> -A <Path_to_Incredibuild_Installation_Directory>

Install Secondary Coordinator

sudo bash ./incredibuild_<version>.ubin install -E -O <Primary_Coordinator_Machine_IP_or_Hostname> -A <Path_to_Incredibuild_Installation_Directory>

Install Build Cache Service

sudo bash ./incredibuild_<version>.ubin install -Y -O <Primary_Coordinator_Machine_IP_or_Hostname> -A <Path_to_Incredibuild_Installation_Directory> -Q <size of cache>

Full Installation Command List

There are many more parameters that can be used to modify the installation. To display Incredibuild Linux help, use the install command without any parameters.

ibuser@incredibuild:~$ ./incredibuild_3.17.0.ubin install

Parameter Description Notes
-A <Path>

The path to the storage directory, where Incredibuild DBs and file cache will be stored.

This parameter must be included in the installation of all components. Incredibuild will automatically create a link to this path.

By default, the allocated file size is 11GB, but this size can be configured using the -Z parameter (see below).

The storage directory cannot be under: /opt/incredibuild
-C Primary Coordinator installation.  

-E

Secondary Coordinator installation.

This should always be used in addition to the -O flag.

 
-H Helper Agent installation.
-I Initiator Agent installation.
-S  Initiator Agent and Helper Agent installation.
-Y Build Cache Service installation. Required for using shared Build Cache. The Build Cache Service must be installed on a dedicated machine, so this flag cannot be used when installing an Agent or a Coordinator.
-Q <size in GB> When installing the Build Cache Service, the size of the cache. This parameter is optional. If the parameter is not included, the default size is 100GB.
-B <size in GB> When installing an Initiator, the size of the local Build Cache. This parameter is optional. If the parameter is not included, the default size is 100GB.

-O <Coordinator
Machine>

The IP address or hostname of the Primary Coordinator machine. 
  • Required for the installation of an Initiator, Helper, or Secondary Coordinator on a remote machine. It establishes the communication with the Primary Coordinator.
  • When an Agent is installed with the Coordinator on the same machine, this parameter is not needed.
  • Must use a static identifier - either a static IP address or a hostname.
-R SUVM A supplementary Agent installation command, for installing Initiator and/or Helper Agent on an image of VMs that will receive SUVM licenses. For more information on this command, see Creating a VM Image for the SUVM License.
-6 For the Coordinator installation - specifies that the communication between the Coordinator and the Agents will be done using IPv6, instead of IPv4.
  • By default, the communication between the Coordinator and the Agents is done using IPv4.
  • After the installation, this parameter can be changed in the Coordinator Management Console > Coordinator Settings dialog box. The last entered value will take effect.
-D For an Agent installation - skips the automatic Agent-Coordinator connectivity test.
  • By default, once a Helper/Initiator Agent is installed on a remote machine, its connection to the Coordinator is tested automatically. If you do not want to test this connection at the Agent installation stage, add this parameter to the installation command.
  • The connectivity test is important for verifying that the Coordinator-Agent communication works properly. Therefore, use this parameter carefully, and remember to test the Coordinator-Agent connectivity at a later stage.
-G <port> For all components - specifies the port for accessing the Web Management Console using HTTP.
  • The default value is 8080.
-L <port> For all components - specifies the port for accessing the Web Management Console using HTTPS.
  • The default value is 8081.
ib_console -v For all components - shows the version no. of the installed component. For more information, see Checking the Version No. of the Installed Incredibuild Components.  
-N <port> For all components - specifies the Coordinator Utility Port.
  • The default value is 9953.
-Z <size> For all components – specifies the size of the allocated file cache in GB.
  • String.
  • The default value is 11 GB.
  • It is not recommended to allocate less than 5 GB.

-p, --profile <profile_file>

Adds an additional profile file. For details, see ib_profile.

 

-P

Pre-approves the end user license agreement (EULA). If this is not done, you will be asked to approve the agreement during installation in the command line.

 

-T

Opt-out of sending product usage data to Incredibuild.

 

Installing Older Versions

In general, we recommend using the latest version of Incredibuild. The installation commands were updated in version 3.11, but if you need to install an earlier version you can use the following procedure. Note that in earlier versions, the -i flag is required for installation, and .bin is used instead of .ubin. Make sure that all of the Installation Prerequisites above have been met before installing.

  1. Install Incredibuild on a high availability machine that will act as your Coordinator. Copy the installer file to the machine and run the following:

    sudo bash ./incredibuild__<version no.>.bin -i -C -A <Path_to_Incredibuild_Installation_Directory>

    You can also install an Agent on the same machine by adding the -S flag.

  2. Install Incredibuild on all other machines that you want to initiate from or help with workloads. The -S flag installs an Agent that can act as an Initiator and Helper. Replace it with -H to install an Agent that can only act as a Helper.

    sudo bash ./incredibuild_<version no.>.bin install -i -S -O <Primary_Coordinator_Machine_IP_or_Hostname> -A <Path_to_Incredibuild_Installation_Directory>