TeamCity Amazon EC2 integration allows you to configure TeamCity with your Amazon account and then start and stop images with TeamCity agents on-demand based on the queued builds.
On this page:
- General Description
- Required IAM permissions
- Preparing Image with Installed TeamCity Agent
- Configuring a cloud profile in TeamCity
- New instance types
- Proxy settings
- Custom script
- Estimating EC2 Costs
- Traffic Estimate
Once a cloud profile is configured in TeamCity with one or several images, TeamCity does a test start for all the new images to learn about the agents configured on them.
Once the agents are connected, TeamCity stores their parameters to be able to correctly process build configurations-to-agents compatibility.
For each queued build, TeamCity first tries to start it on one of the regular, non-cloud agents. If there are no usual agents available, TeamCity finds a matching cloud image with a compatible agent and starts a new instance for the image. TeamCity ensures that the running instances limit configured in the cloud profile is not exceeded.
Once an agent is connected from a cloud instance started by TeamCity, it is automatically authorized (provided there are available agent licenses). After that the agent is processed as a regular agent.
If running timeout is configured on the cloud profile and it is reached, the instance is terminated.
If an EBS-based instance id is specified in the images list, the instance is stopped instead.
On instance terminating/stopping, its disconnected agent is removed from authorized agents list and is deleted from the system.
Since TeamCity 9.1.4, Amazon EC2 Spot Instances are supported.
Understanding Amazon EC2 and ability to perform EC2 tasks is a prerequisite for configuring and using TeamCity Amazon EC2 integration.
Basic TeamCity EC2 setup involves:
- preparing an Amazon EC2 image (AMI) with an installed TeamCity agent
- configuring EC2 integration on TeamCity server
Please ensure that the server URL specified on Global Settings page in Administration area is correct since agents will use it to connect to the server.
If you need TeamCity to use proxy to access EC2 services, please read on a current workaround in the dedicated issue.
Required IAM permissions
TeamCity requires the following permissions for Amazon EC2 Resources:
To use spot instances, the following additional permissions are required:
To launch an instance with Iam Role (applicable to instances cloned from AMI-s only) the following additional permissions are required:
An example of custom IAM policy definition (allows all ec2 operations from a specified IP address):
See the section below for permissions to set IAM roles on an agent instance.
Preparing Image with Installed TeamCity Agent
Here are the requirements for an image that can be used for TeamCity cloud integration:
- TeamCity agent should be correctly installed.
- TeamCity agent should start on machine startup
buildAgent.propertiescan be left "as is". "
name" and "
authorizationToken" properties can be empty or set to any value, they are ignored when TeamCity starts the instance.
Provided these requirements are met, usual TeamCity agent installation and cloud-provider image bundling procedures are applicable.
If you need the connection between the server and the agent machine to be secure, you will need to setup the agent machine to establish a secure tunnel (e.g. VPN) to the server on boot so that TeamCity agent receives data via the secure channel.
Recommended image (e.g. Amazon AMI) preparation steps:
- Choose one of existing generic images.
- Start the image.
- Configure the running instance:
- Install and configure build agent:
- Configure server name and agent name in
conf/buildAgent.properties— this is optional, if the image will be started by TeamCity, but it is useful to test the agent is configured correctly.
- It usually makes sense to specify
conf/buildAgent.propertiesto use non-system drive (d: under Windows)
- Configure server name and agent name in
- Install any additional software necessary for the builds on the machine.
- Run the agent and check it is working OK and is compatible with all necessary build configurations, etc.
- Configure system so that agent it is started on machine boot (and make sure TeamCity server is accessible on machine boot).
For Amazon EC2 on Windows, you may need to add a dependency from the TeamCity Build Agent service on the EC2Config service (e.g. EC2Config mounts drives after the OS is started, and the agent or some of its folders may be present on these drives).
- Install and configure build agent:
- Test the setup by rebooting machine and checking that the agent connects normally to the server.
- Prepare the Image for bundling:
- Remove any temporary/history information in the system.
- Stop the agent (under Windows stop the service but leave it in Automatic startup type)
- Delete content
tempdirectories in agent home (optional)
- Delete "
<Agent Home>/conf/amazon-*" file (optional)
config/buildAgent.propertiesto remove properties:
serverUrlcan be removed for EC2 integration plugins. Other plugins might require that it is present and set to correct value.
Make a new image from the running instance (or just stop it for Amazon EBS images).
Configuring a cloud profile in TeamCity
Next configure Amazon EC2 Agent Cloud Profile in the Server Administration UI, on the Administration | Agent Cloud.
Since TeamCity 9.1.1 it is possible to use IAM profiles with build agents launched as Amazon EC2 instances, which requires the supplied AWS account to have the following permissions:
Amazon EC2 Spot Instances support
Since TeamCity 9.1.4 TeamCity supports Amazon EC2 Spot Instances and now you can place your bid on unused EC2 capacity and use it, as long as your suggested price exceeds the current "Spot price".
Enable spot instances on the TeamCity cloud profile page and enter your current bid level.
After the profile is saved, TeamCity creates a spot instance request (sir) and the availability of Amazon spot instances is checked. If the sir is not fulfilled after 10 min, it is killed by Amazon.
If there are still queued builds which can run on such an agent, the request is automatically recreated by TeamCity.
NOTE: It is not recommended to use spot instances for production-critical builds due to the possibility of an unexpected spot instance termination by Amazon.
Amazon EBS-Optimized Instances
Since TeamCity 10.0.3, the behavior of EBS-optimization, enabled by default in TeamCity 10.0, is changed similarly to what EC2 console offers. When configuring the image of the Amazon cloud profile, the optimization can be set using the corresponding box of the Instance Type. Note that
- EBS-optimization is turned on by default for
- EBS-optimization is turned off by default for any other instance types and can be turned on for instances that support it (such as
Tagging for TeamCity-launched instances
The following requirements must be met for tagging instances launched by TeamCity:
- you have the
- the maximum number of tags (50) for your Amazon EC2 resource is not reached.
In the absence of tagging permissions, TeamCity will still launch Amazon AMI and EBS images with no tags applied; Amazon EC2 Spot Instances will not be launched.
TeamCity enables users to get instance launch information by marking the created instances with
"teamcity:TeamcityData" tag containing
<server UUID>:-<cloud profile ID>:-<image reference>.
Since TeamCity 10.0, custom tags can be applied to EC2 cloud agent instances: when configuring Cloud profile settings, in the Add Image/ Edit Image dialog use the Instance tags: field to specify tags in the format of
<key1>=<value1>,<key2>=<value2>. Amazon tag restrictions need to be considered.
If you'd like to use equal(=) sign in the tag value, no escaping is needed. For instance, the string
extraParam=name=John will be parsed into
<key=extraParam> and value
<name=John> (Since 10.0.3).
Agent auto-upgrade Note
TeamCity agent auto-upgrades whenever distribution of agent plugins on the server changes (e.g. after TeamCity upgrade). If you want to cut agent startup time, you might want to re-bundle the agent AMI after agent plugins have been auto-updated
New instance types
Since Amazon doesn't provide a robust API method to retrieve all instance types, Amazon integration relies on periodical update of AWS SDK to make new instance types available.
However, there's a workaround if you are not willing to wait. To register new Instance Types, use the following internal property:
teamcity.ec2.instance.types property with new instance types separated by ","
If your TeamCity server instance is behind a proxy, configure the following internal properties to connect to Amazon AWS addresses.
teamcity.http.proxy.host.ec2 - proxy server host name
teamcity.http.proxy.port.ec2 - proxy server port
For proxy server authentication:
teamcity.http.proxy.user.ec2 - proxy access user name
teamcity.http.proxy.password.ec2 - proxy access user password
For NTML authentication:
teamcity.http.proxy.domain.ec2 - proxy user domain for NTLM authentication
teamcity.http.proxy.workstation.ec2 - proxy access workstation for NTLM authentication
Estimating EC2 Costs
Usual Amazon EC2 pricing applies. Please note that Amazon charges can depend on the specific configuration implemented to deploy TeamCity. We advice you to check your configuration and Amazon account data regularly in order to discover and prevent unexpected charges as early as possible.
Please note that traffic volumes and necessary server and agent machines characteristics depend a big deal on the TeamCity setup and nature of the builds run. See also How To...#Estimate Hardware Requirements for TeamCity.
Here are some points to help you estimate TeamCity-related traffic:
- If TeamCity server is not located within the same EC2 region or availability zone that is configured in TeamCity EC2 settings for agents, traffic between the server and agent is subject to usual Amazon EC2 external traffic charges.
- When estimating traffic please bear in mind that there are lots types of traffic related to TeamCity (see a non-complete list below).
External connections originated by server:
- VCS servers
- Email and Jabber servers
- Maven repositories
Internal connections originated by server:
- TeamCity agents (checking status, sending commands, retrieving information like thread dumps, etc.)
External connections originated by agent:
- VCS servers (in case of agent-side checkout)
- Maven repositories
- any connections performed from the build process itself
Internal connections originated by agent:
- TeamCity server (retrieving build sources in case of server-side checkout or personal builds, downloading artifacts, etc.)
Usual connections served by the server:
- web browsers
- IDE plugins
As Amazon rounds machine uptime to the nearest full hour, please adjust timeout setting on the EC2 image setting on TeamCity cloud integration settings according to your usual builds length.
It is also highly recommended to set execution timeout for all your builds so that a build hanging does not cause prolonged instance running with no payload.