Activating Your License

[For a license change only] Unloading Your Existing Incredibuild License

If you already have an active license, and you received a new license following a renewal or a change in the license terms, you need to unload your existing license before you can load and activate your new license.

To unload an existing license:

  1. On the Coordinator Monitor, open the Tools menu > Coordinator Settings option:

  2. On the Coordinator Settings dialog box, select the License option on the left:

  3. On the License page, click the Unload License button to unload your existing license.Your active license is unloaded. You can now load and activate your new license, as described in the next section.

Step 1 – Loading Your Incredibuild License File

To load your Incredibuild License file:

  1. Make sure that the machine running the Coordinator is connected to the internet.

  2. Double-click the license file from an Explorer window on the machine running the Coordinator.

Alternately, follow this process:

  1. On the Coordinator Monitor, open the Tools menu > Coordinator Settings option.

  2. On the Coordinator Settings dialog box, select the License option on the left.

  3. Click theLoad License file.... button. The Open file dialog box appears.

  4. Locate the license file in your file system.

  5. Click theOKbutton.

Step 2 - Subscribing the Agents that will Compose your Incredibuild Environment

Incredibuild incorporates a subscription mechanism to define which Agents can connect to the Coordinator. Agents that can connect to a Coordinator are consideredSubscribedto that Coordinator, while Agents that cannot areUnsubscribed.

In Incredibuild Environment, a license file defines the highest possible number of Agents that can be subscribed to the Coordinator at any given time. In order for an Agent to be able to initiate and participate in distributed executions, it must first be subscribed to the Coordinator.

By default, once an Agent establishes a connection with the Coordinator, and there are free licenses in the license file, the Agent is automatically subscribed by the Coordinator, and it can immediately start participating in distributed builds. This automatic subscription action is controlled by theAutomatically subscribe new agents option in the Coordinator Settings dialog box. This option is enabled by default, and can be disabled if required.

You can also manually subscribe or unsubscribe Agents.

> To manually subscribe and unsubscribe Agents:

  • In theCoordinatorMonitor, select one or more Agents. Then, right-click them or open theAgentmenu, and selectSubscribe/Unsubscribe.

Step 3–Allocating Extension Packages to Subscribed Agents

Incredibuild Extension packages add additional functionality to specific Agents. For example, The "Visual Studio C/C++" extension package allows initiation of distributed MS Visual Studio C/C++ builds. The "8 cores" package allows utilization of up to eight cores on machines with compatible hardware, while the"Dev Tool Acceleration"package enables general-purpose distribution using the Incredibuild Grid.

In order for an Agent to be able to use a registered extension package's functionality, the package must first be allocated to that Agent. When possible, the Coordinator will automatically allocate available packages to all subscribed Agents, saving you the stage of manually allocating the package to specific Agents.

Allocating Extension Packages

To manually allocate or deallocate registered packages, go to the Coordinator Monitor, select one or more Agents from the Agent list, right-click and use the and use the "Allocate Package" and "Deallocate Package" options.

Once all registered extension packages have been properly allocated, your Incredibuild environment is installed and ready for operation.

Note:

  • Agents that only have a core package (for example, a 4, 8, or 16 core package) and do not have other packages that enable doing initiation of tasks, are considered "Helper Agents". Helper Agents differ from regular Agents in their inability to initiate build or execution tasks (for example, Dev tools); they can only participate in distributed build and execution tasks initiated by other machines.

  • It is possible to configure multi-boot computers to use up a single extension package for all Agents installed on the different operating systems the computer is running. 

Configuring Incredibuild on Multi-Boot Computers

When installing an Incredibuild Agent on computers that have a selection of operating systems that they can boot with ("dual-boot" or "multi-boot" computers), it is possible to install Incredibuild on each of the installed operating systems while allocating only a singleExtension Packagefor that computer. If this procedure is not followed, every operating system installed on the computer will require a separate Extension Package.

To configure a Multi-Boot computer to use a single Extension Package:

  1. Make sure that an Incredibuild Agent is installed on each of the operating systems installed on the computer.

  2. Make sure that all Incredibuild Agents installed on the computer's operating systems have connected to the Coordinator at least once and are subscribed (this temporarily uses up an Extension Package for each operating system running an Incredibuild Agent).

  3. Open theCoordinator Monitoron the computer running the Coordinator service.

  4. Right-click one of the Agents installed on the multi-boot computer, and selectConfigure Multi-Boot....A list appears, showing other Agents that the Coordinator has identified as installed on the same computer.

  5. Select the Agents that are to share the selected Agent's license, and then clickOK.

Note: Agents configured as running on the same multi-boot computer should never be online at the same time or they will lose their allocated Extension Packages.

Multi-Core Packages

Incredibuild has multi-core packages that enable you to use all the cores on your computer (for example, packages for 4, 8, 16, 32, or more cores). In order to use all the logical cores on your computer, you have to allocate a multi-core package routine for the number of cores that you have on your hardware. Multi-core packages are relevant for both Helper and Initiator machines.

If you have eight cores on the local computer but you allocated a 4-core package, Incredibuild uses only four logical cores. On the other hand, if you have a local machine of eight cores and you allocated a 16-core package, Incredibuild will not use the extra eight cores in the package, and the Coordinator will indicate that there are eight extra cores.

The following is an example of a case where too large a package (16-core) has been assigned to a machine (four cores).  The Coordinator indicates that a 16-core package has been allocated, meaning that there are 12 extra cores that will not be in use.

Locating Your Coordinator License ID

  1. On your taskbar, right-click Incredibuild Agent icon. Then, select Help > About:

  2. On the About Incredibuild dialog box, click the Copy License ID button:

  3. Paste the Coordinator License ID in an available location for future use.