TeamCity On-Premises 2021.1 Help

Configuring Agent Pools

To manage build agents efficiently, you can group them into multiple agent pools.

Required Permissions

To be able to add/remove pools and set maximum number of agents in the pool, you need to have the "Manage agent pools" permission granted to the System Administrator and Agent Manager roles in the default TeamCity per-project authorization mode.

Assigning and unassigning projects and agents to/from pools is restricted by the "Change agent pools associated with project" permission, which by default is a part of the Project Administrator role. Users can perform the operations on the pool only if they have the "Change agent pools associated with project" permission for all projects associated with all pools affected by the operation.

See also related agent management permissions.

Managing Agent Pools

The Agents | Pools tab allows managing pools in TeamCity.

To create a new agent pool, specify its name.

By default, a pool can contain an unlimited number of agents. You can set a maximum number of agents in the pool (not applicable for the Default pool). If the maximum number of agents is reached, TeamСity will not allow adding any new agents to this pool. This includes moving agents from other pools and automatic authorization of cloud agents. New cloud agents will not start if the target pool is full.

To populate a pool with agents, click Assign agents and select them from the list. Since an agent can belong to one pool only, assigning it to a pool will remove it from its previous pool. If this may cause compatibility problems, TeamCity will give you a warning. Removing an agent from a custom pool will return it to the Default pool. You can also assign cloud agents to a specific pool when adding an image to a cloud profile.

To assign a pool to a cloud agent, you need to configure it in the cloud image details of the agent cloud profile. Note that agents from all cloud profiles of the current project are automatically combined into a project pool.

When you have configured agent pools, you can:

Last modified: 25 May 2021