Cloud Settings
The Cloud Settings pages are opened automatically during the setup process after entering your cloud provider’s credentials, but you can also edit cloud settings in one of the following ways:
These settings differ slightly depending on your Cloud provider.
Note: If you are using AWS Marketplace and want to change these settings after configuring your environment, please contact support@incredibuild.com.
Coordinator Settings
This page is only visible when installing Incredibuild Cloud directly from AWS marketplace. You define the username and password that will be needed to access the Coordinator that will be created for you on the cloud.
Network Settings
This window has a few different settings depending on your cloud provider. The example shown below is for AWS.
Parameter | Description |
---|---|
Subscription |
[Azure only] Your Azure subscription name. |
Cloud Region |
The region (defined by your cloud provider) 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. |
Public/Private |
Select Private 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. To use this option, you must already have a private network on your cloud provider. This option can sometimes reduce data transfer speeds. Your Coordinator host should be connected to the private network as follows:
Proxy: For Linux users, you can configure your Cloud Helpers to communicate with Incredibuild Cloud via a proxy server. This also requires setting the following environment variables on your Incredibuild Coordinator machine: http_proxy, https_proxy. |
Let Incredibuild Create a Network for you |
Incredibuild creates cloud network resources to contain your cloud VMs. This option is only available when you specify a Public network. |
Resource Group Name |
[Azure only] 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, Incredibuild Cloud will use a default value, which includes your Coordinator ID. You can also manage VMs and Network in different resource groups, limiting Incredibuild Cloud Agents from accessing to the Resource Group used for your network |
VPC / Virtual Network |
The VPC that will contain your public or private cloud network. Called Virtual Network for azure and VPC for AWS. |
Subnets |
The subnet (range of IPs) in your VPC that will contain Incredibuild VMs. |
Coordinator Ports |
These settings are only visible when installing directly from AWS marketplace. They are the ports required to communicate with your Coordinator. |
Use your own Security Group |
Incredibuild's permissions and activities in your cloud account are limited to a Security Group. If you do not select this option, we create a Security Group for you and open the required ports. If you select this option, you can use your own Security Group, however you will need to manually open some ports to facilitate communication with items in the Security Group. For details, see Using your Own Security Group below. Note: In GCP, this setting is called a Firewall Rule, and no selection is required (just toggle on or off). |
Private Link |
You can configure an AWS Private Link to access Incredibuild's cloud service without allowing your cloud resources to access the internet. This must be done before onboarding to the cloud. This feature is only available to select customers upon request to support@incredibuild.com. |
Resource Management Settings
This window has a few different settings depending on your cloud provider. The example shown below is for AWS.
Parameter | Description |
---|---|
Coordinator |
|
Default Virtual Machine Type |
This setting is only visible when installing directly from AWS marketplace. It is the type of the VM that will serve as your Coordinator. We recommend leaving the default setting. If you need to change this machine after creating your environment, see Changing your Coordinator Machine. |
Helpers |
|
Use Smart Compatibility Layer |
This allows you to create Cloud Helpers on Linux machines. For details, see Smart Compatibility Layer. |
Use Spot Instances (called Preemptible for GCP) |
Enable Spot instances to get access to unused cloud compute at deep discounts. For details, see Enable Spot Instances. |
Default Virtual Machine Type |
The type of the VMs that will serve as Helper Agents. We recommend using machines with at least 8 or 16 cores. If you are using Unreal Engine, your VMs should have at least 100GB HDD with 70 GB dedicated for cache. |
Disk Type |
The disk type that will contain your virtual machines. |
Total Storage Size |
The storage size on each virtual machine. |
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. When deactivated, the VM will return to the pool if it is not full, otherwise it will be terminated. The default is 90 seconds. Values can be 60-43200. |
VM Role (AWS only) |
If your organization requires it, you can specify a custom VM role that will be attached to your cloud VMs. You also need to modify the JSON that provides Incredibuild with permissions to your AWS account. You can specify more than one role in the JSON for convenience, however you can only specify one role at a time that will attached to the VMs in this user interface. |
Pool Settings |
|
Max Number of Cores |
The maximum number of cores that can be used to run your builds. |
VM Pool Size |
Incredibuild maintains a pool of machines in a Sleep state to speed up the process of ramping up machines when they are needed. 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 cannot be higher than Max Number of Cores multiplied by the number of cores in your Default Machine Type. |
Fallback Machine Types This section is only for AWS and Azure. In GCP, fallbacks are managed on their side automatically. |
|
Allow fallback to On-Demand machines (AWS Only) |
If you are using Spot machines, you can also enable Incredibuild to use On-Demand (non-spot) machines if no Spot machines are available using this checkbox. |
Let Incredibuild Find Machines |
If your cloud provider runs out of the Default Machine Type, Incredibuild will use other machine types. We only try to find machines that are in the same family type as your Default Machine Type. Generally the prices of these machines are similiar to the price of your Default Machine type, however we cannot control the prices in your cloud provider. |
Define your Own Fallback Machine Types |
If your cloud provider runs out of the Default Machine Type, Incredibuild will use other machine types. You can limit the types of machines by specifying the machine types to use here. |
Fallback Machine Types |
You can specify additional types of VMs to act as fallbacks if your cloud provider runs out of the first type in your region. |
Advanced Settings
Parameter | Description |
---|---|
Add Tags |
[Optional] Custom tags that will be added automatically to the following resources, which that are created by Incredibuild on your cloud provider:
Notes:
|
Enable SSL Certificate |
When using Incredibuild 10, you can enable SSL for communication between your Incredibuild components. Upload an SSL certificate and key to place on your cloud agents. You will need to enable SSL on your Coordinator as well. This is not supported for AWS marketplace. |
Save Logs from Cloud Machines |
When using Linux, you can collect the logs from Cloud Helpers and other volatile machines in a single remote location to help you troubleshoot or understand your builds. For details, see Collecting Build Logs in the Linux Documentation. |
Notification Email |
This email will be used by Incredibuild for confirmations, notifications, and assistance. This email will not be used for promotions or marketing. |
Coordinator Port |
Used by the VMs that are running as Helpers on the cloud to communicate with the Coordinator. This must be the same as the Coordinator Service port in the Coordinator Settings. The default is 31105. Verify that this port is open for external traffic in your organization firewall. |
VM Port |
The first port of the port range that is assigned to the cores of a VM. Each participating core needs a port to connect to the Coordinator. Consecutive port numbers are assigned to additional VMs. When Incredibuild creates the VMs on the cloud, it automatically opens available ports in the range. Incredibuild Cloud does not check the availability of the ports. If the ports in your port range are already in use by your system, the VM cores will not be able to participate in the solution. |
Using your Own Security Group
Note: In GCP, this setting is called a Firewall Rule, and no selection is required (just toggle on or off).
Incredibuild's permissions and activities in your cloud account are limited to a Security Group. If you do not select this option, we create a Security Group for you and open the required ports. If you select this option, you can use your own Security Group, however you will need to manually open some ports to facilitate communication with items in the Security Group.
-
If you are using Incredibuild for Windows, you need to open the Coordinator Port and the VM Ports you specified in the Advanced tab of the Settings wizard. Additionally, you need to open subsequent VM Ports depending on the number of cores in your default machine type. So, if you default machine type has 32 cores, and your VM Port is 31106, you need to open ports 31106-31138 in addition to the Coordinator port (31105 by default).
-
If you are using Incredibuild for Linux, you only need to open the Coordinator and VM Ports you specified in the Advanced tab of the Settings wizard.
In all cases, your Cloud Helper VMs must be have outbound internet access to work with Incredibuild's cloud service.