本文档的内容是由机器翻译的。请通过反馈微件提交您的反馈。
 

安装 TeamCity 代理

最后修改日期： 2025年 3月 21日

在安装 TeamCity 构建代理之前，请务必阅读 系统要求。

选择一个便捷的安装选项：

从 Windows 可执行文件安装

  1. 在 TeamCity 中打开 支持人员 页面。

  2. 单击 安装构建代理 并选择 Windows Installer 以下载安装程序。

  3. 在代理机器上，运行 agentInstaller.exe 并按照安装说明进行操作。

确保运行代理服务的用户帐户具有适当的 权限。

从 ZIP 文件安装

这个选项允许您下载可以复制到您的代理机器的代理文件的存档。

可用的代理分发版

您可以选择下载完整或最小的 agent 发行版。

  • 最小代理分发 是一个没有插件的常规构建代理。 最小代理程序在首次启动时将下载所有必需的插件。

  • 完整代理分发 包含当前在服务器上启用的所有插件的相关版本。 这使得完整的发行版存档变得更大，但显著减少了第一次代理运行所花费的时间。

如果您使用脚本创建代理映像（例如， 在云配置文件中 ），则全代理更为可取。 所有装有完整代理的云实例从启动的那一刻起就与服务器同步，并可以立即运行构建。

完整代理分发也以两种变体提供：

  • 不带 Java 开发工具包的常规代理分发。 如果您下载并安装了这个版本，请确保代理机器已经安装了所需的 JDK 版本（参见 支持的 Java 版本 ），并且 JRE_HOME 或 JAVA_HOME 环境变量指向了正确的安装路径。

  • 与操作系统特定 JDK 打包的分发版。 这些分发版使您可以一次性安装代理和所需的 JDK。 要下载这些分发版，请在 管理 | 代理 JDK 页面上添加所需的 JDK 版本，并等待 TeamCity 构建相关的代理分发版。

    添加 Agent JDK

    访问 支持的平台和环境 文档文章，以获取有关哪些 Java 版本受 TeamCity 代理支持的信息。

如何从 ZIP 文件中安装代理

  1. 在 TeamCity 中打开 支持人员 页面，并在侧边导航栏中选择 概述。

  2. 单击 安装代理 按钮并选择所需的 选项。

    代理 ZIP 分发下载选项

    如果选择 最小 ZIP 文件分发 选项，将开始下载最小的与操作系统无关的归档文件。

    如果选择 完整分发 选项，您将被重定向到 代理分发 页面，该页面将可用的代理归档分为两类：带有和不带有捆绑 JDK。

    完整代理分发页面

    未捆绑 JDK 的代理可作为常规存档和 Docker 镜像 提供。

  3. 提取已下载的存档。

  4. 打开 <installation path>\conf 目录并将 buildAgent.dist.properties 文件重命名为 buildAgent.properties。

  5. 编辑 buildAgent.properties 文件，指定 TeamCity 服务器 URL （建议使用 HTTPS，参见 这些说明 ）和 agent 的名称。 请参考 此文章 了解代理配置的详细信息。

    note

    您可以手动编辑 buildAgent.properties 文件或通过运行 configure 命令并带上所需参数来编辑。 请参阅此部分以获取更多信息： 配置命令。

在 Linux 上，您可能需要授予 bin/agent.sh Shell 脚本执行权限。

在 Windows 上，您可能希望 使用 Windows 服务运行构建代理 ，而不是使用手动启动代理。

通过 Agent Push 安装

TeamCity 提供了 Agent Push 功能，该功能允许将构建代理安装到远程主机。 支持的服务器主机平台和构建代理目标的组合：

  • 从基于 Unix 的 TeamCity 服务器，只能将构建代理安装到 Unix 主机（通过 SSH）。

  • 从基于 Windows 的 TeamCity 服务器，可以将构建代理安装到 Unix（通过 SSH）或 Windows（通过 psexec）主机上。

note

SSH 注意

确保在目标主机上根据您偏好的认证方法启用了 "Password" 或 "Public key" 认证。

远程主机要求

远程主机有几个要求：

平台

前提条件

Linux

  • 已安装 JDK 或 JRE（请参见 支持的 Java 版本）。 JVM 应该可以通过 JAVA_HOME 或 JRE_HOME 全局环境变量进行访问，或者位于全局路径（而不是例如在用户的 .bashrc 文件中指定）。

  • 该 unzip 工具。

  • 要么 wget ，要么 curl。

Windows

  • 已安装 JDK 或 JRE（请参见 支持的 Java 版本）。

  • Sysinternals psexec.exe 必须安装在 TeamCity 服务器上，并且可以在路径中访问。 您可以在 管理 | 工具 中安装它。 请注意， PsExec 对远程 Windows 主机提出了额外的要求。 确保满足以下前提条件：

    • Administrative share 在远程主机上已启用并且可以访问。

    • 远程服务工作（MMC 插件可以连接到机器）。

    • 远程注册表工作正常（regedit 可以通过 services.msc 连接到机器）。

    • 服务器和工作站服务正在运行（通过 services.msc 检查）。

    • 经典网络验证已启用。

您可以通过以下命令测试连接：

net use \\target\Admin$ /user:Administrator
dir \\target\Admin$

安装

请注意，要访问 Agent Push 页面，用户需要具有 管理构建代理机器 的权限。

  1. 在 TeamCity 界面中，打开 代理 | Agent Push 并单击 安装代理。
    如果您希望对多个目标主机使用相同的设置，可以使用这些设置 创建预设 ，并在每次将代理安装到另一个远程主机时使用它。

  2. 在 Install agent （安装代理）对话框中，选择已保存的预设或选择 "Use custom settings"（使用自定义设置），指定目标主机平台，然后配置相应的设置。 通过 SSH 将 Agent 推送到 Linux 系统支持自定义端口（默认为22），作为 SSH 端口 参数进行指定。 在主机名中（例如， hostname.domain:2222 ）可以覆盖预设中指定的端口，该操作在实际安装代理时进行。

  3. 您可能需要下载 Sysinternals psexec.exe ，在这种情况下，您将看到相应的警告以及一个链接，指向可以下载它的 管理 | 工具。

tip

您可以在 代理云配置文件 的设置中使用 Agent Push 预设，以自动将构建代理安装到启动的云实例中。