TeamCity supports upgrades from any of the previous versions to the later ones. All the settings and data are preserved unless noted in the Upgrade Notes.
It is recommended to plan for regular upgrades to run the latest TeamCity version at least after several bugfix updates are released. This way you run a fully with the latest fixes and security patches.
On this page:
|Table of Contents|
- For a major upgrade, review what you will be getting in What's New (follow the links at the bottom of What's New if you are upgrading not from the previous major release)
- Check your license keys unless you are upgrading within bugfix releases of the same major X.X version
- Download the new TeamCity version (extended download options)
- Carefully review the Upgrade Notes
- Consider probing the upgrade on a test server
- If you have non-bundled plugins installed, check plugin pages for compatibility with the new version and upgrade/uninstall the plugins if necessary
- Back up the current TeamCity data
- Perform the upgrade steps:
If you plan to upgrade a production TeamCity installation, it is recommended to install a test server and check its functioning in your environment before upgrading the main one.
Agents connected to the server are upgraded automatically.
Important note on TeamCity data structure upgrade
If you accidentally performed an inconsistent upgrade, check the recovery instructions.
Used in UI
Since TeamCity 2017.2 automatic update option is available. For that to function, TeamCity server should be able to contact https://www.jetbrains.com site.
When a new version of TeamCity is detected, the server displays the corresponding health item for system administrators.
Since TeamCity 2017.2, the health The item points to the server's Administration | Updates page, where all the versions available for the update are listed. The page contains notes about licenses compatibility, the new version description and controls to perform the automatic upgrade if you want to use that instead of performing the manual updating procedure.
- The TeamCity server is stopped.
- The update script is run to do the following:
- Create a backup of the current installation in the TeamCity home/.old directory.
- Update the stopped server to the new version.
- Next, the updated server starts.
The update progress is logged to the TeamCity home/logs/teamcity-update.log file.
In case of an automatic update failure, perform the following to restore your TeamCity to the state prior to the update:
Current automatic update limitations:
- some customizations, e.g. installations with changed server context, are not supported by automatic update
- only manual upgrade is possible if the server is deployed from a .war distribution, or runs under the official TeamCity Docker container, started with AWS CloudFormation template or Azure Azure Resource Manager template.
- the Windows uninstaller is not updated during the upgrade, so after several updates, old TeamCity version will still be noted in Windows lists. During the uninstallation, not all of the TeamCity installation files might be deleted.
- the bundled Java is not updated
- with several nodes installation, only the main TeamCity server can be auto-updated, the Running Builds node needs to be updated manually.
This section is applicable to TeamCity prior to 2017.2, as well as to the servers running under the official TeamCity docker container, started with AWS CloudFormation template or Azure Resource Manager template.
- Create a backup. When upgrading from TeamCity 6.0+ you will also have a chance to create a backup with the "basic" profile on the TeamCity Maintenance Mode page on the updated TeamCity start.
- Note the username used to run the TeamCity server. You will need it during the new version installation.
- If you have any of the Windows service settings customized, store them to repeat the customizations later.
- Note if you are using 64 bit Java to run the service (e.g. check for "64" in "Java VM info" on the server's Administration | Diagnostics or in a thread dump), consider backing up
- (optional as these will not be overwritten by the upgrade) If you have any customizations of the bundled Tomcat server (like port, https protocol, etc.), JRE, etc. Backup those to repeat the customizations later.
- Note if you have local agent installed (though, it is not recommended to have a local agent) so that you can select the same option in the installer.
Run the new installer and point it to the same place TeamCity is installed into ( the location used for installation is remembered automatically). Confirm uninstalling the previous installation. The TeamCity uninstaller ensures proper uninstallation, but you might want to make sure the TeamCity server installation directory does not contain any non-customized files after uninstallation finishes. If there are any, backup/remove them before proceeding with the installation.
The main server configuration file
<TeamCity Home Directory>/conf/server.xmlis updated automatically when there were no changes to it since the last installation. If modification were made, the installer will detect them and backup the old
server.xmlfile displaying a warning about the overwrite and the backup file location. Other files under
confcan be overwitten to their default content as well, so if you have made manual modifications in those, check them after the upgrade.
- When If prompted, specify the
<TeamCity data directory
>used by the previous installation.
- (Optional as these will not be overwritten by the upgrade) Make sure you have the external database driver installed (this applies only if you use an external database).
- Check and restore any customizations of Windows services and Tomcat configuration that you need. When upgrading from versions 7.1 and earlier, make sure to transfer the server memory setting to the environment variables.
- If you were using 64 bit Java to run the server restore the
<TeamCity home>\jredirectory previously backed up or repeat the 64 bit Java installation steps.
- If you use a customized Log4j configuration in the
conf\teamcity-server-log4j.xmlfile and want to preserve it (note, however, that customizing the file is actually not recommended, use logging presets instead), compare and merge
conf\teamcity-server-log4j.xml.backupcreated by the installer from the existing copy with the default file saved with the default name. Since TeamCity 2017.1 compare Compare the
conf\teamcity-*-log4j.xml.distfile with the corresponding
conf\teamcity-*-log4j.xmlfile and make sure that
.xmlfile contains all the
.distfile defaults. It is recommended to copy the
.distfile over to the corresponding
.xmlfile until you really need the changed logging configuration.
- Start up the TeamCity server (and agent, if it was installed together with the installer).
- Review the TeamCity Maintenance Mode page to make sure there are no problems encountered, and confirm the upgrade by clicking the corresponding button. Only after that all data will be converted to the newer format.
It is recommended for all users to regularly update their IDE plugins to the latest version compatible with the TeamCity server version in use. At least to the version available from the TeamCity server's Tools section on user profile.
Generally, versions of the IntelliJ IDEA TeamCity plugin, Eclipse TeamCity plugin, and Visual Studio TeamCity Addin have to be the same as the TeamCity server version. Users with non-matching plugin versions get a message on an attempt to log in to the TeamCity server with a non-matching version.
The only exception is TeamCity versions 9.0 - 9.1.x, which use a compatible protocol, and any plugin of these versions can be used with any server of these versions. Updating IDE plugins to the matching server version is still recommended.
Upgrading Build Agents
- Automatic Build Agent Upgrading
- Upgrading Build Agents Manually
On starting TeamCity server (and updating agent distribution or plugins on the server), TeamCity agents connected to the server and correctly installed are automatically updated to the version corresponding to the server. This occurs for both server upgrades and downgrades. If there is a running build on the agent, the build finishes. No new builds are started on the agent unless the agent is up to date with the server.
Since TeamCity 2018.2, before starting the agent upgrade, the agent is checked for free disk space, 3 gb by default. To modify the value required for the upgrade, configure the
teamcity.agent.upgrade.ensure.free.space agent property.
The agent update procedure is as follows: The agent (
agent.sh, or agent service) will download the current agent package 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 the agent is restarted). This process may take several minutes depending on the agent hardware and network bandwidth. Do not interrupt the upgrade process, as doing so may cause the upgrade to fail and you will need to manually reinstall the agent.
In the latter case, if you run the agent under Windows using a service, you may also need to upgrade the Windows service as described below.