Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The settings of your IncrediBuild Cloud solution are configured in the Settings page. Theses settings consist of the following sections:

...

Parameter

Description

Cloud Region

AWS region where the VMs will run. In this region, the pool and additional Helper VMs will be created. It is recommended to select the same region for the Initiating VMs and the pool and Helper VMs, in order to avoid network latency. 

Tags

[Optional] AWS custom tags that will be added automatically to the following resources, which that are created by IncrediBuild on AWS:

  • Virtual Machines

  • VPC

  • Subnet

  • Role

You can add up to 5 custom tags, by defining for each tag a name:value pair. For more information on resource tagging in AWS, see:
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html

To find Your Machine cost by using the Tags, you must enable the "cost allocation tags," and after the machine usage, navigate to the Cost Explorer, see:

https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html

Use Private Network

[Optional] This option enables you to use a Virtual Private Network on the cloud for launching and running Helper VMs, thus adding another layer of security for your transferred data.

Important! To use this option, you must already have a private network on AWS.

Your Coordinator host should be connected to the private network as follows:

  • If your Coordinator is not on the cloud, the Coordinator host must be connected to the cloud private network via VPN.

  • If your Coordinator is on the cloud, its host must have access to the selected subnet. 

Once you enable the Use Private Network option, in addition to the other parameters described above, you need to set the following:

  • VPC – select the VPC in which the VMs for acceleration will be launched. 

  • Subnet – select or create a subnet in the selected VPC. To create a new subnet, select from the drop-down list the Create new subnet option.

...

Parameter

Description

Tenant ID

Your Azure tenant ID.

Subscription

Your Azure subscription name.

Cloud Region

Azure region where the VMs will run. In this region, the pool and additional Helper VMs will be created. It is recommended to select the same region for the Initiating VMs and the pool and Helper VMs, in order to avoid network latency. 

Resource Group Name

[Optional] Customization of the name of the default resource group. All the resources that are created by IncrediBuild Cloud for build acceleration, belong to one resource group. You can change the default name of this resource group before activating the solution.

If you do not add a customized name for the resource group and leaves this field empty, IncrediBuild Cloud will use a default value, which includes your Coordinator ID.

Tags

[Optional] Azure custom tags that will be added automatically to the following resources that are created by IncrediBuild on Azure:

  • Virtual Machines

  • Disk Drives

  • Network Interfaces

  • Public IP Addresses

You can add up to 5 custom tags, by defining for each tag a name:value pair. For more information on resource tagging in Azure, see:
https://sharegate.com/blog/everything-you-need-to-know-about-resource-tagging-in-azure

Note: All Azure cloud resources that are created by IncrediBuild include "cloud" in their name.

Use Private Network

[Optional] This option enables you to use a Virtual Private Network on the cloud for launching and running Helper VMs, thus adding another layer of security for your transferred data.

Important! To use this option, you must already have a private network on Azure.

Your Coordinator host should be connected to the private network as follows:

  • If your Coordinator is not on the cloud, the Coordinator host must be connected to the cloud private network via VPN.

  • If your Coordinator is on the cloud, its host must have access to the selected subnet. 

Once you enable the Use Private Network option, in addition to the other parameters described above, you need to set the following:

  • Resource Group – select one of the existing resources groups in the selected Cloud Region.

  • Network - select the private network in which the VMs for acceleration will be launched.

  • Subnet - select or create a subnet in the selected private network. To create a new subnet, select from the drop-down list the Create new subnet option.

...

Parameter

Description

VM Type

The type of the VMs that will serve as Helper Agents. You can choose up to 3 types.

VM Idle Timeout (seconds)

The number of seconds that need to pass after a VM has finished executing a task, before it is automatically deactivated.

For example, if the value of the Time Out is 500 seconds, 500 seconds after a VM no longer participates in a task, it will be deactivated. Deactivation of a VM in this context means that a VM can either return to the pool in a Sleep state, or be terminated completely. The VM will return to the pool if the pool is not full at that moment. If the pool is full, the VM will be terminated.

  • The default value is 500 seconds.

  • The minimum value is 300 seconds (5 minutes).

  • The maximum value is 43200 seconds (720 minutes).

Total Cores Limit

The maximum number of cores on the cloud that can be allocated to the execution of tasks, following the requests of the Coordinator. For example, it the value of the Total Cores Limit is 50, and the Coordinator requests 60 cores for the execution of running tasks, only 50 cores will be allocated.

The value of the Total Cores Limit should be greater or equal to the value of the No. of VMs in Pool multipliedby thenumber of cores of one VM of your selected VM Type:  

Total Cores Limit value ≥ No. of VMs in Pool value X the number of cores of your selected VM Type.

For example, if the value of the No. of VMs in Pool is 10, and you selected a VM Type of 2 cores, the value of the Total Cores Limit must be at least 20.

By default, when the Coordinator receives a request from the Initiator for available cores, it determines how many cores are required for the optimal running of the specific task. Then, it tries to provide cores from Helper Agents that were manually installed using the Installation wizard and directly connected to the Coordinator port. If there are not enough available cores on these standard Helpers, and IncrediBuild Cloud is activated, the Coordinator automatically turns to the cloud in search for available cores. If the requests for cores exceed the value of the Total Cores Limit, the execution of the new tasks will be delayed until free cores will be available.  

No. of VMs in Pool

The number of VMs that will be created for IncrediBuild Cloud pool, and will be moved automatically into a Sleep state. After their creation, these VMs are not automatically used by the Coordinator, but they can start to work immediately as Helpers upon the Coordinator request.

The value of the No. of VMs in Pool cannot be higher than half the value of the Total Cores Limit.For example, if the value of the Total Cores Limit is 300, the value of the No. of VMs in Pool cannot be higher than 150.

Notes:

  • When setting the pool size you should take into consideration the costs involved in keeping VMs in a Sleep state – both for your cloud provider and IncrediBuild licenses.

  • If all the VMs in the pool are used for executing tasks, and additional requests for available cores are received, IncrediBuild Cloud will launch new VMs to accommodate the requests. However, the number of new launched VMs will be limited by the value of the Total Cores Limit you set, your cloud quota limit, and the number of IncrediBuild licenses you have.  

...