Child pages
  • VCS Worker

Versions Compared

Key

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

The VCS Worker is an experimental feature currently not bundled with TeamCity. It is provided upon request if you wish to try it.

VCS Worker

Interaction with version control (VCS) servers is one of the resource-heavy parts of TeamCity. Until TeamCity 8.0, VCS operations could only be performed by TeamCity server itself. In version 8.0, we introduced an option to execute VCS operations in a separate process (VCS Worker service), which can run on a separate machine; moreover, you can use several VCS Workers running on multiple machines to offload the server.

...

Note

Before installing, make sure that the TeamCity server and the VCS Worker versions are the same. Unlike TeamCity build agents, VCS Worker currently does not support auto-upgrade, this means you need to upgrade it manually each time when you install new version of TeamCity.

  • Stop the TeamCity Server
  • Download the VCS Worker archive and save it to your <TeamCity Data Directory>/plugins folder.
  • Start the TeamCity Server
  • In the TeamCity Web UI, go to the Administration page, select VCS Worker in the Integrations section and download vcs-worker.zip.
  • Unpack the vcs-worker.zip on the target machine (The BUILD_<XXX> is the VCS Worker version. Make sure it is the same as the TeamCity server version you are running)
  • Open port 9888 in the firewall
  • Set the JAVA_HOME environment variable to point at the installed Java JVM 1.6+
  • Start the VCS Worker using{{<vcs-worker>/bin/vcs-server.bat start}} or <vcs-worker>/bin/vcs-server.sh start
  • Make sure you can open the VCS Worker URL from the TeamCity server using the ping command or a web browser (e.g. http://vcs-worker-host:9888)
  • Copy <TeamCity data directory>/config/vcs-worker.properties.dist to vcs-worker.properties
  • Open <TeamCity data directory>/config/vcs-worker.properties
  • Uncomment the worker.1.url line: (remove #) and specify the worker URL, e.g. http://vcs-worker-host:9888
  • The TeamCity server restart is not required. You should be able to see the information about a connected worker via http://your-teamcity-server/admin/admin.html?item=vcsWorkerTab.

...

TeamCity uses round-robin selection of VCS Workers if there are several VCS Workers available to serve an operation. Additional filters can be configured: see the <vcs-worker>/conf/vcs-worker.properties.dist file for all available options.

Binary package

VCS worker plugins for different versions of TeamCity: