microsoft/azure-pipelines-vsts-agent

Azure Pipelines Agent 镜像文档

镜像概述和主要用途

本仓库包含Visual Studio Team Services (VSTS)代理的镜像，该代理作为构建或发布流程的一部分运行任务。

VSTS代理镜像根据基础操作系统、可选的Team Foundation Server (TFS)版本以及已安装的工具进行标记。

与VSTS一起使用时，代理版本会在容器启动时根据代理连接的账户自动确定并下载。与TFS一起使用时，应选择与已安装TFS版本匹配的镜像。

核心功能和特性

• 容器化部署：以Docker容器形式运行VSTS代理，简化部署和环境一致性管理
• 版本适配：支持自动适配VSTS账户版本，或手动选择匹配TFS版本的特定镜像
• 灵活配置：通过环境变量自定义代理名称、代理池、工作目录等关键参数
• Docker集成：可重用主机Docker实例（非Docker-in-Docker），通过挂载主机Docker socket实现容器内Docker操作

使用场景和适用范围

• Azure Pipelines的构建和发布任务执行
• 需要隔离构建/发布环境的场景
• 与Team Foundation Server (TFS)集成的本地部署环境
• 需要自定义代理配置（如特定工具版本、工作目录）的CI/CD流程

使用方法和配置说明

环境变量

VSTS代理必须使用账户连接信息启动，通过以下环境变量提供：

用于VSTS的环境变量

• VSTS_ACCOUNT：Visual Studio账户的名称
• VSTS_TOKEN：Visual Studio账户的个人访问令牌(PAT)，需至少拥有代理池(读取、管理) 权限范围

用于TFS的环境变量

• TFS_HOST：Team Foundation Server的主机名（此时TFS URL将设为https://$TFS_HOST/tfs）
• TFS_URL：Team Foundation Server的完整URL（若提供此变量，TFS_HOST将被忽略）
• VSTS_TOKEN：Team Foundation Server账户的个人访问令牌(PAT)，需至少拥有代理池(读取、管理) 权限范围

通用配置环境变量

• VSTS_AGENT：代理名称（默认："$(hostname)"，支持shell扩展）
• VSTS_POOL：代理池名称（默认："Default"）
• VSTS_WORK：代理工作目录（默认："_work"，支持引用已扩展的VSTS_AGENT值）

运行示例

基本VSTS代理运行

为特定Visual Studio账户运行默认VSTS代理镜像：

bash
docker run \
  -e VSTS_ACCOUNT=<账户名称> \
  -e VSTS_TOKEN=<个人访问令牌> \
  -it mcr.microsoft.com/azure-pipelines/vsts-agent

TFS代理运行

为TFS 2018运行指定版本的VSTS代理镜像（服务器URL为https://mytfs/tfs）：

bash
docker run \
  -e TFS_HOST=mytfs \
  -e VSTS_TOKEN=<个人访问令牌> \
  -it mcr.microsoft.com/azure-pipelines/vsts-agent:ubuntu-16.04-tfs-2018

安全传递令牌

通过挂载包含令牌的文件传递个人访问令牌（更安全的方式）：

bash
docker run \
  -v /path/to/my/token:/vsts-token \
  -e VSTS_ACCOUNT=<账户名称> \
  -e VSTS_TOKEN_FILE=/vsts-token \
  -it mcr.microsoft.com/azure-pipelines/vsts-agent

自定义配置运行

在Ubuntu 16.04上运行具有自定义代理名称、代理池和工作目录的VSTS代理：

bash
docker run \
  -e VSTS_ACCOUNT=<账户名称> \
  -e VSTS_TOKEN=<个人访问令牌> \
  -e VSTS_AGENT='$(hostname)-agent' \
  -e VSTS_POOL=mypool \
  -e VSTS_WORK='/var/vsts/$VSTS_AGENT' \
  -v /var/vsts:/var/vsts \
  -it mcr.microsoft.com/azure-pipelines/vsts-agent:ubuntu-16.04

集成Docker

重用主机Docker实例（挂载Docker socket）：

bash
docker run \
  -e VSTS_ACCOUNT=<账户名称> \
  -e VSTS_TOKEN=<个人访问令牌> \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -it mcr.microsoft.com/azure-pipelines/vsts-agent:ubuntu-16.04-docker-17.12.0-ce

完整标签列表

Linux镜像

可访问 [***] 获取azure-pipelines/vsts-agent的所有可用标签列表。

支持

如需支持或一般问题，请访问https://github.com/Microsoft/vsts-agent-docker/issues%E3%80%82

反馈

请将所有反馈发送至https://github.com/Microsoft/vsts-agent-docker/issues%E3%80%82

许可

• ***声明：容器许可信息

MICROSOFT SOFTWARE SUPPLEMENTAL LICENSE TERMS CONTAINER OS IMAGE Microsoft Corporation（或根据您的居住地，其关联公司之一）（简称“我们”或“Microsoft”）向您授予本容器操作系统镜像补充件（“补充件”）的许可。您被许可将本补充件与基础主机操作系统软件（“主机软件”）一起使用，仅用于协助运行主机软件中的容器功能。主机软件许可条款适用于您对补充件的使用。如您没有主机软件的许可，则不得使用本补充件。您可将本补充件与每份有效许可的主机软件副本一起使用。

附加许可要求和/或使用权利 您按照前述段落规定使用补充件可能会创建或修改包含某些补充件组件的容器镜像（“容器镜像”）。为明确起见，容器镜像与虚拟机或虚拟设备镜像是分开且不同的。根据这些许可条款，我们授予您有限的权利，在以下条件下重新分发此类补充件组件： (i) 您仅可将补充件组件作为容器镜像的一部分使用， (ii) 您可在容器镜像中使用此类补充件组件，但前提是您的容器镜像中具有与补充件显著分离且不同的重要主要功能；并且 (iii) 您同意在容器镜像中包含这些许可条款（或我们或托管方要求的类似条款），以适当许可您的最终用户对补充件组件的可能使用。 我们保留本协议未明确授予的所有其他权利。

使用本补充件即表示您接受这些条款。如不接受，请不要使用本补充件。

作为Windows容器的本容器操作系统镜像补充许可条款的一部分，您还需遵守基础Windows Server