buildbot/buildbot-worker Docker镜像文档

1. 镜像概述和主要用途

1.1 概述

buildbot/buildbot-worker 是 Buildbot 持续集成系统的官方 worker 容器镜像。该镜像仅包含 Buildbot worker 实现，用于连接 Buildbot 主节点（Buildmaster），执行自动化构建、测试任务，是分布式构建/测试架构中的核心执行组件。

1.2 主要用途

作为 Buildbot 分布式架构的 Worker 节点，负责接收主节点（Buildmaster）分配的构建/测试任务，执行具体流程（如代码拉取、编译、单元测试等），并将执行结果反馈给主节点，实现持续集成/持续部署（CI/CD）流程的自动化。

2. 核心功能和特性

• 易于部署与高度可定制：支持快速部署，同时允许通过配置适配任意构建流程，不局限于特定语言或工具链（如 autotools、ant 等）。
• 跨平台构建测试：支持在多种操作系统和硬件平台上执行构建/测试任务，帮助开发者在提交代码后快速发现跨平台兼容性问题。
• 低依赖要求：Worker 节点仅需 Python 环境（通过 virtualenv 管理），降低部署门槛。
• NAT 穿透支持：Worker 可部署在 NAT 防火墙后方，通过反向连接与主节点通信，适应复杂网络环境。
• 多渠道状态报告：配合 Buildmaster 提供的多种状态报告工具（如日志、通知等），及时向开发者反馈构建/测试结果。

3. 使用场景和适用范围

3.1 适用场景

• 分布式构建/测试：需要在多节点并行执行构建或测试任务的开发团队。
• 跨平台项目：需在 Windows、Linux、macOS 等多平台验证代码兼容性的项目。
• 持续集成流程：希望自动化代码提交后的构建、测试、反馈流程的场景。

3.2 适用范围

• 中小型开发团队的 CI/CD 基础设施搭建。
• 开源项目的自动化构建与测试流程。
• 对构建环境一致性要求高的企业级应用开发。

4. 使用方法和配置说明

4.1 环境变量配置

镜像通过环境变量进行配置，以下为必填及可选参数说明：

4.2 Docker 部署示例

4.2.1 基本运行命令（docker run）

通过以下命令启动 Worker 容器，连接到指定的 Buildmaster：

docker run -d \
  --name buildbot-worker \
  -e BUILDMASTER=buildmaster.example.com \
  -e BUILDMASTER_PORT=9989 \
  -e BUILDMASTER_PROTOCOL=pb \
  -e WORKERNAME=worker-linux-x64 \
  -e WORKERPASS=my_secure_password \
  -e WORKER_ENVIRONMENT_BLACKLIST=WORKERPASS,DB_PASSWORD \
  buildbot/buildbot-worker

4.2.2 Docker Compose 配置示例

创建 docker-compose.yml 文件，定义 Worker 服务：

version: '3'
services:
  buildbot-worker:
    image: buildbot/buildbot-worker
    container_name: buildbot-worker
    environment:
      - BUILDMASTER=buildmaster.example.com
      - BUILDMASTER_PORT=9989
      - BUILDMASTER_PROTOCOL=pb
      - WORKERNAME=worker-linux-x64
      - WORKERPASS=my_secure_password
      - WORKER_ENVIRONMENT_BLACKLIST=WORKERPASS,SECRET_TOKEN
    restart: unless-stopped

启动服务：

docker-compose up -d

4.3 注意事项

• 敏感信息保护：WORKERPASS 等敏感环境变量需通过 WORKER_ENVIRONMENT_BLACKLIST 移除，避免在构建日志中泄露。
• 网络连通性：确保 Worker 容器能访问 BUILDMASTER 和 BUILDMASTER_PORT，NAT 环境下需配置端口映射或反向代理。
• 协议兼容性：msgpack_experimental_v7 为实验性协议，生产环境建议使用默认的 pb 协议。

5. 参考链接

• Buildbot 官方文档：[***]
• Buildbot Worker 配置指南：参见 Buildbot 官方文档中 Worker 章节。