|You are viewing documentation of TeamCity 5.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.|
In this section
Upgrading Build Agents:
If you are planning your upgrade and consider test-driving the newer TeamCity version as a separate install, you may find How To...#Test-drive newer TeamCity version before upgrade section useful.
TeamCity supports upgrading from any version to any later version. Downgrades are not possible.
Before upgrading please check that maintenance period of your licenses is not yet elapsed. The licenses are valid only for the versions of TeamCity released within the maintenance period.
Please note that TeamCity versions 5.0 and above use new licensing policy comparing to that of previous TeamCity versions. Please review Licensing Policy section and the Licensing and Upgrade section on the official site.
If you are evaluating the newer version, you can get an evaluation license on the download page. Please note that TeamCity can be evaluated only one time. For an extension of the evaluation period, please contact JetBrains sales department.
TeamCity stores its data in the database and in TeamCity Data Directory on the file system. Different TeamCity versions use different data structure of the database and data directory. Upon starting newer version of TeamCity, the data is automatically updated to a newer format. There are several important issues with data format upgrade:
All the configuration data and database scheme will by updated by our converters upon the first startup after the upgrade.
On starting newer TeamCity server, TeamCity agents connected to the server are updated automatically. The agent (agent.bat, agent.sh, or agent service) will download the latest agent upgrade from the TeamCity server. When the download is complete and the agent is idle, it will start the upgrade process (the agent is stopped, the agent files are updated, and agent is restarted). This process may take several minutes depending on the agent hardware and network bandwidth. It is important not to interrupt the upgrade process, as doing so may cause the upgrade to fail and the agent will need to be manually reinstalled.
If you see that an agent is identified as "Agent disconnected (Will upgrade)" in the TeamCity web UI, do not close the agent console or restart the agent process, but wait for several minutes.
Various console windows can open and close during the agent upgrade. Please be patient and do not interrupt the process until the agent upgrade is finished.
All connected agents upgrade automatically, provided they are correctly installed, so no manual upgrade is necessary.
If you still need to upgrade agent automatically, you can follow the steps below:
As TeamCity agent does not hold any unique information, the easiest way to upgrade an agent if to
If you need to preserve all the agent data (e.g. to eliminate clean checkouts after the upgrade), you can:
In the latter case if you run agent under Windows using service, you can also need to upgrade Windows service as described below.
Version 2.0 of TeamCity migrated to new way of managing Windows service (service wrapper) for the build agent: Java Service Wrapper library.
One of advantages of using new service wrapper is ability to change any JVM parameters of the build agent process.
1.x versions installed Windows service under name agentd, while 2.x versions use TeamCity Build Agent Service <build number> name.
The service wrapper will not be migrated to new version automatically. You do not need to use the new service wrapper, unless you need its functionality (like changing agent JVM parameters).
To use new service wrapper you should uninstall old version of the agent (with Control Panel | Add/Remove Programs) and then install a new one.
If you customized the user under which the service is started, do not forget to customize it in the newly installed service.
If the service wrapper needs an update, the new version is downloaded into the <agent>/launcher.latest folder, however the changes are not applied automatically.
To upgrade the service wrapper manually, do the following: