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

SSH 执行

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

SSH Exec 使 TeamCity 能够使用 SSH 执行任意远程命令。

所有运行器的通用设置在 这里 描述。 此文章详述了 SSH Exec 运行器的设置。

以下字段支持 参数引用 ：任何在百分号之间的文本（% ）都被 TeamCity 视为对属性的引用。 为了防止 TeamCity 将百分号内的文本视为属性的引用，使用两个百分号来转义它们：例如，如果您想要将 %Y%m%d%H%M%S 传递到构建中，请将其改为 %＼%Y％＼%m％＼%d％＼%H％＼%M％＼%S。

tip

观看我们的 视频指南 ，了解如何在构建过程中 使用 SSH。

warning

当服务器需要强大的加密技术时，构建代理需要在 JRE 上安装 Java Cryptography Extension (JCE) 无限强度管辖策略。

选项

描述

步骤名称

Optional 在 TeamCity 用户界面中显示的构建步骤的名称。

步骤 ID

此构建步骤的 ID，必须在此配置的所有步骤中唯一。 用于URLs、REST API、DSL、向服务器的HTTP请求，以及TeamCity数据目录中的配置设置。

执行步骤

使您能够修改默认的构建条件，并可选择性地添加更多的 构建条件。

部署目标

目标

SSH 服务器的主机名或 IP 地址。

端口

可选 端口。 默认端口为22。

使用 pty

Optional 请指定伪终端（pty）的类型。 例如， vt100。

如果为空，那么 pty 不会被分配（默认）。

部署凭据

认证方法

选择一种身份验证方法：

  • 已上传密钥 — 使用上传到项目的密钥。 参见 SSH 密钥管理 了解详细信息。

  • 默认私钥 — 使用 ~/.ssh/config 设置进行私钥认证，或者如果不存在设置文件，则使用 ~/.ssh/id_rsa 私钥文件进行认证。

  • 自定义私钥 — 使用指定的私钥文件和密码短语进行私钥认证。

  • 密码 — 使用简单密码认证。

  • SSH-Agent — 使用 SSH agent 进行认证，此时必须启用 SSH-Agent 构建功能。

note

当前的安全连接实现接受远程主机提供的 任何证书。 不执行任何信任检查！

SSH 命令

命令

在远程 shell 中指定一个新的、以换行符分隔的命令集来执行。 远程 shell 在经过认证的用户的主目录中启动。 Shell 输出将在 TeamCity 构建日志中可用。

note

SSH Exec 以非交互模式运行 shell，从而施加相应的限制。

tip

Linux 用户提示

要在此运行器中使用 bash 别名，将以下 shell 选项添加到您的脚本中：

shopt -s expand_aliases
source /home/user/.bash_profile

示例

例如，考虑如何创建一个构建步骤，为网站构建静态内容。 在将静态内容上传到网页服务器后，您需要执行一个 deploy.sh 脚本以刷新网站。 假设您在 SSH 服务器上使用 jdoe 帐户，其主目录为 /jdoe ，并且 SSH 服务器已配置为使用 SSH 密钥进行身份验证。

  1. 按照 Generated SSH Keys 中的步骤在您的项目中生成一对新的 SSH 密钥。 调用密钥对 WebServerKey。

  2. 从 WebServerKey 密钥对中复制公钥。

  3. 登录到您的 SSH 服务器上的 jdoe 帐户，并按照您的 SSH 服务器提供商的指导将 WebServerKey 公钥添加到此帐户。

  4. 在项目的构建配置中，转到 构建步骤 页面并单击 添加构建步骤。

  5. 在 新建构建步骤 页面上，选择 SSH 执行 运行器。

  6. 在 新构建步骤：SSH Exec 页面上，按如下填写字段：

    • 步骤名称 — 输入 RunDeployScript。

    • 目标 — 输入 ssh.example.com。

    • 认证方法 — 选择 已上传密钥。

    • 用户名 — 输入 jdoe （SSH 服务器账户的用户名）。

    • 选择密钥 — 从下拉列表中选择 WebServerKey。

    • 命令 — 输入以下 shell 命令：

      echo 'running deploy.sh ...'
/home/jdoe/scripts/deploy.sh

  7. 单击 保存 以创建构建步骤。