buildbot/buildbot-master

Buildbot Master Docker 镜像文档

一、镜像概述和主要用途

Buildbot 是一个开源的持续集成（CI）框架，旨在自动化软件构建、测试和部署流程。本镜像为 Buildbot 框架的核心组件 Master 的 Docker 封装。Master 组件作为整个 Buildbot 系统的中枢，负责协调构建流程、管理 Worker 节点、处理构建请求、调度任务执行及生成构建报告，是实现 CI/CD 流程自动化的核心控制节点。

该镜像由 Buildbot 项目维护团队（Botherders）开发维护，项目主页：[***]

二、核心功能和特性

1. 多组件架构支持

Buildbot 采用模块化设计，Master 与 Worker、Web 界面（www/base、www/console_view、www/waterfall_view 等）等组件协同工作，实现完整的 CI/CD 流程闭环。

2. 灵活的构建流程管理

支持自定义构建触发器（如代码提交、定时任务）、多阶段构建流程配置，可适配复杂的项目构建需求。

3. 可视化 Web 界面

集成 Console View、Waterfall View 等 Web 界面组件，提供实时构建状态监控、历史记录查询和任务进度跟踪。

4. 可扩展性与兼容性

支持与主流版本控制系统（Git、SVN 等）、测试框架及部署工具集成，可通过插件扩展功能，适配多平台构建场景。

三、使用场景和适用范围

1. 持续集成/持续部署（CI/CD）

适用于软件开发流程中的自动化构建、测试和部署，减少人工干预，提升开发效率。

2. 多平台构建与测试

支持跨操作系统（如 Linux、Windows、macOS）及架构（x86、ARM）的构建任务调度，满足多平台兼容性测试需求。

3. 开源项目与企业开发

无论是小型开源项目还是大型企业级应用，均可通过 Buildbot Master 实现构建流程标准化和自动化。

4. 定时任务与事件触发

支持基于时间（如夜间构建）或事件（如代码合并）的构建任务触发，适配灵活的开发节奏。

四、使用方法和配置说明

1. 前置要求

• 已安装 Docker Engine（20.10+ 推荐）或 Docker Desktop；
• 如需持久化数据，建议准备本地目录用于挂载配置文件和数据卷。

2. 快速启动（docker run）

基本命令

bash
docker run -d \
  --name buildbot-master \
  -p 8010:8010 \  # Web 界面端口
  -v /path/to/local/config:/etc/buildbot \  # 挂载本地配置目录
  buildbot/master:latest

参数说明

• -p 8010:8010：映射 Master 的 Web 界面端口（默认 8010）；
• -v /path/to/local/config:/etc/buildbot：挂载本地配置目录，包含 master.cfg（构建流程配置）等核心文件；
• --name buildbot-master：指定容器名称，便于管理。

3. 高级配置（docker-compose）

推荐结合数据库（如 PostgreSQL）和 Worker 节点使用，以下为典型 docker-compose.yml 示例：

yaml
version: '3.8'

services:
  buildbot-master:
    image: buildbot/master:latest
    container_name: buildbot-master
    ports:
      - "8010:8010"  # Web 界面端口
    volumes:
      - ./master-config:/etc/buildbot  # 本地配置目录挂载
      - buildbot-data:/var/lib/buildbot  # 数据持久化卷
    environment:
      - BUILDBOT_DB_URL=postgresql://user:password@db:5432/buildbot  # 数据库连接 URL
      - BUILDBOT_WEB_URL=http://localhost:8010/  # Web 访问地址
      - BUILDBOT_ADMIN=admin@example.com  # 管理员邮箱
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:14
    container_name: buildbot-db
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=buildbot
    volumes:
      - postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  buildbot-data:
  postgres-data:

4. 核心配置参数

环境变量

配置文件

核心配置文件 master.cfg 需挂载至 /etc/buildbot/master.cfg，用于定义构建流程（如代码拉取、编译、测试步骤）、Worker 管理规则等。示例配置片段：

python
# master.cfg 示例（简化版）
from buildbot.plugins import *

c = BuildmasterConfig = {}

# 配置 Worker 认证
c['workers'] = [worker.Worker("worker-1", "worker-password")]

# 配置构建工厂（定义构建步骤）
f = util.BuildFactory()
f.addStep(steps.Git(repourl="https://github.com/example/project.git", mode="full"))
f.addStep(steps.ShellCommand(command=["make"]))
f.addStep(steps.ShellCommand(command=["make", "test"]))

# 配置构建器
c['builders'] = [
    builder.BuilderConfig(name="default", workernames=["worker-1"], factory=f)
]

# 配置 Web 界面
c['www'] = dict(port=8010, plugins=dict(waterfall_view={}, console_view={}))

5. 数据持久化

为避免容器重启后配置和构建数据丢失，需挂载以下目录：

• /etc/buildbot：存放 master.cfg 等配置文件；
• /var/lib/buildbot：存放构建历史、状态数据及临时文件（建议通过 Docker 卷挂载）。

五、相关资源

• 官方项目主页：[***]
• 源代码仓库：https://github.com/buildbot/buildbot
• 相关媒体资源：https://github.com/buildbot/buildbot-media
• Web 站点源码：https://github.com/buildbot/buildbot-website
• 官方文档：[***]