Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. 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)
  2. Check your license keys unless you are upgrading within bugfix releases of the same major X.X version
  3. Download the new TeamCity version (extended download options)
  4. Carefully review the Upgrade Notes
  5. Consider probing the upgrade on a test server
  6. If you have non-bundled plugins installed, check plugin pages for compatibility with the new version and upgrade/uninstall the plugins if necessary

...

  1. Back up the current TeamCity data
  2. 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.

...

On upgrade, all the TeamCity configuration settings and other data are preserved unless noted in Upgrade Notes. If you have customized TeamCity installation (like Tomcat server settings change), you will need to repeat the customization after the upgrade.

General approach to upgrade is to remove all the files of the previous installation in the TeamCity server home and place the new files at the same location. Make sure to preserve TeamCity Data Directory and the database intact (making a backup beforehand), backing up and restoring necessary settings from the ...\conf\server.xml settings file is also necessary. ...\logs directory can be left with the old installation files.

Agents connected to the server are upgraded automatically.

Info

Important note on TeamCity data structure upgrade
TeamCity server 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 kept in the old format until you confirm the upgrade and data conversion on the Maintenance page in the web UI. Until you do so, you can back up the old data; however, once the upgrade is complete, the data is updated to a newer format.
Once the data is converted, downgrade to the previous TeamCity versions which uses different data format is not possible!
There are several important issues with data format upgrade:

  • Data structure downgrade is not possible. Once newer TeamCity version changes the data format of database and data directory, you cannot use this data to run an older TeamCity version. Please ensure you backup the data before upgrading TeamCity.
  • Both the database and the data directory should be upgraded simultaneously. Ensure that during the first start of the newer server it uses the correct TeamCity Data Directory that in its turn has the correct database configured in the <TeamCity Data Directory>\config\database.properties file. Also make sure the data directory is complete (e.g. all the build logs, artifacts, etc. are in place), no data directory content supports copying from the data directory of the older server versions.

...

Generally, versions of IntelliJ IDEA TeamCity plugin, Eclipse TeamCity plugin and Visual Studio TeamCity Addin should be the same as the TeamCity server version. Users with not matching plugin versions get a message on attempt to login to TeamCity server with not matching version.
The only exception is that TeamCity versions 9.0 - 9.1.x use compatible protocol and any plugin of these versions can be used with any server of these verions. Updating IDE plugin to the matching server version is still recommended.

Upgrading Build Agents

Anchor
AutoAgentUpgrading
AutoAgentUpgrading

...

In the latter case if you run agent under Windows using service, you can also need to upgrade Windows service as described below.

Anchor
upgradingBuildAgentsServiceWrapper
upgradingBuildAgentsServiceWrapper

...