buildbot/metabbotcfg

metabuildbot Docker镜像技术文档

1. 镜像概述和主要用途

metabuildbot Docker镜像是Buildbot CI系统（buildbot.buildbot.net）的专用配置镜像，用于部署和运行Buildbot官方CI系统的worker节点。该镜像包含构建和管理worker节点所需的核心配置文件，需集成到Buildbot master节点的基础目录（basedir）中，实现CI流程的自动化执行。

2. 核心功能和特性

• 配置集成能力：提供master.cfg、workers.py等核心配置文件，需部署为master basedir的子目录，并通过符号链接（basedir/master.cfg -> metabbotcfg/master.cfg）与master节点集成。
• 安全密码管理：worker节点密码通过本地*.pass文件存储（而非硬编码），由MyWorker类自动读取，提升配置安全性。
• 官方CI适配：针对buildbot.buildbot.net的CI流程优化，确保与官方CI系统的兼容性和稳定性。

3. 使用场景和适用范围

3.1 适用场景

• Buildbot官方CI系统（buildbot.buildbot.net）的worker节点部署与管理。
• 需要通过符号链接集成到master basedir的worker配置场景。

3.2 适用范围

注意：本镜像为Buildbot官方CI系统的专用配置，不建议作为通用Buildbot配置示例。其配置逻辑仅针对buildbot.buildbot.net的特定需求设计，其他环境直接使用可能需要大量定制调整。

4. 使用方法和配置说明

4.1 部署环境要求

• Docker引擎（20.10+）或Docker Compose（2.0+）。
• 本地存在Buildbot master节点的基础目录（basedir）。
• 本地需准备*.pass文件（存储worker密码），且路径可被容器访问。

4.2 目录结构准备

需在master basedir中创建metabbotcfg子目录，并按以下结构组织文件：

basedir/
├── master.cfg -> metabbotcfg/master.cfg  # 符号链接：关联master配置
└── metabbotcfg/
    ├── master.cfg  # 核心配置文件
    ├── workers.py  # worker节点定义
    └── ...  # 其他辅助配置文件

4.3 配置参数说明

4.4 环境变量说明

4.5 Docker部署示例

4.5.1 使用docker run部署

bash
docker run -d \
  --name metabuildbot-worker \
  -v /var/buildbot/master:/basedir \          # 挂载master basedir
  -v /var/buildbot/passfiles:/passfiles \     # 挂载密码文件目录（只读）
  -e MASTER_BASEDIR=/basedir \
  -e PASS_FILES_DIR=/passfiles \
  buildbot/metabuildbot:latest

4.5.2 使用docker-compose部署

创建docker-compose.yml：

yaml
version: '3.8'
services:
  metabuildbot:
    image: docker.xuanyuan.run/buildbot/metabuildbot:latest
    container_name: metabuildbot-worker
    volumes:
      - /var/buildbot/master:/basedir:ro       # 只读挂载master basedir
      - /var/buildbot/passfiles:/passfiles:ro  # 只读挂载密码文件目录
    environment:
      - MASTER_BASEDIR=/basedir
      - METABBOTCFG_PATH=/basedir/metabbotcfg
      - PASS_FILES_DIR=/passfiles
    restart: unless-stopped  # 异常退出后自动重启

启动服务：

bash
docker-compose up -d

4.6 配置验证

部署后，通过以下命令验证配置是否生效：

bash
# 检查容器日志，确认worker启动状态
docker logs -f metabuildbot-worker

# 验证符号链接是否正确
docker exec metabuildbot-worker ls -l /basedir/master.cfg

5. 注意事项

• 密码文件安全：*.pass文件包含敏感信息，需设置权限限制（如chmod 600），并以只读方式（:ro）挂载到容器。
• 版本兼容性：本镜像配置与Buildbot官方CI系统版本强绑定，升级master节点时需同步更新镜像版本。
• 非通用配置：镜像配置逻辑仅适用于buildbot.buildbot.net，其他环境使用需基于此配置进行二次开发。