Single-Use Virtual Machine (SUVM) Licenses

Note: SUVM licenses are available in Incredibuild 0.96.71 and higher.

SUVM licenses are designed for Virtual Machines, which are launched for the sole purpose of providing additional cores to assist in the execution of a single build.

The VMs that use SUVM licenses need to be created from a special SUVM image that was prepared in advance. This image should include a Helper and/or an Initiator Agent, which was installed on it using a specific Incredibuild installation command. For details, see below.

When a VM that was launched based on the SUVM image connects to the Coordinator, the Coordinator automatically allocates available SUVM licenses. During the VM activity, it appears in the Coordinator Monitor. When SUVM licenses are allocated to a running VM, this allocation is indicated in the Coordinator Monitor with the  icon:

After the VM completes the build execution, it is terminated and no longer appears in the Coordinator Monitor. Its SUVM licenses are de-allocated by the Coordinator, and they return to the SUVM license pool for re-use.

If the VM was not terminated but stopped for over 30 seconds, it will also disappear from the Coordinator Monitor and its SUVM license will be deallocated. However, if this VM re-establishes a connection with the Coordinator, it will reappear in the Coordinator Monitor as Expired machine:

Creating VMs for SUVM Licenses

The VMs that use SUVM licenses need to be created from a special VM image that was prepared in advance. This image should include a Helper and/or an Initiator Agent, which was installed on it using a specific Incredibuild installation command.

1. Create or select a VM that will serve as the basis for the SUVM image.

2. Install an Agent (either Helper, initiator or both) on the selected VM as follows:

   sudo bash ./Incredibuild_installer.ubin install -S -R SUVM -O <Coordinator_Machine_IP_or_Hostname> -A <Path_To_Incredibuild_Data_Files>

   1. Where:

      install - General installation command.

      -S - Initiator Agent and Helper Agent installation. You can replace the -S command with the -H command to only install a Helper Agent.

      -R SUVM- SUVM installation command.

      -O - The IP address or hostname of the Coordinator that will communicate with the Agent. 

      -A - The storage directory, where Incredibuild DBs and file cache will be stored.

3. Save the VM with the installed Agent as an image. From this point on, if you want to launch VMs for a single use in Incredibuild Environment, use your SUVM image as the basis for these VMs.