dius/pact-broker

Docker化的Pact Broker

镜像概述和主要用途

本镜像提供Docker化的https://github.com/pact-foundation/pact_broker，可从https://hub.docker.com/r/dius/pact-broker/拉取`dius/pact-broker`镜像。Pact Broker是用于存储和管理Pact契约的工具，支持契约版本控制、验证结果跟踪及团队协作。

注意：Pact Foundation组织提供了更小的镜像pactfoundation/pact-broker（压缩后仅98MB），无需root权限运行，默认端口从80变更为9292，环境变量配置兼容，可直接替换使用。

标签格式变更：2018年5月12日起，Docker标签格式从M.m.p-RELEASE变更为M.m.p.RELEASE（M.m.p为Pact Broker包的语义化版本），以便Dependabot识别版本更新。

核心功能和特性

• 契约管理：集中存储和管理Pact契约文件
• 版本控制：跟踪契约版本历史及相关验证结果
• 多数据库支持：兼容PostgreSQL（推荐）、MySQL和SQLite
• 安全认证：支持基本认证，区分读写权限
• Webhook集成：配置Webhook触发外部流程（如CI/CD管道）
• 日志配置：可自定义日志级别和SQL查询性能监控
• 灵活部署：支持Docker Compose、Kubernetes等多种部署方式

使用场景和适用范围

• 微服务架构：跨服务契约测试的契约存储与共享
• CI/CD集成：在持续集成流程中自动验证契约兼容性
• 团队协作：多团队共享契约，确保服务间接口一致性
• 版本追踪：记录契约变更历史，支持回滚和审计

前提条件

• 运行中的PostgreSQL数据库（推荐）及连接权限（详见https://github.com/DiUS/pact_broker-docker/blob/master/POSTGRESQL.md）
• Mac环境需安装timeout或gtimeout，可通过brew install coreutils安装gtimeout

详细使用方法和配置说明

环境变量配置

数据库连接配置

可通过两种方式配置数据库连接：

1. 直接设置数据库URL

PACT_BROKER_DATABASE_URL=driver://username:password@host:port/database

示例：postgres://user1:pass1@myhost/mydb

2. 单独设置数据库参数

数据库高级配置

注意：SQLite仅推荐用于测试/临时环境，需将数据库文件挂载到外部文件系统以持久化数据。

基本认证配置

启用基本认证需设置以下环境变量：

• 若需允许公开读访问（仅写操作需认证），省略只读凭证并设置PACT_BROKER_ALLOW_PUBLIC_READ=true
• 建议开发者使用只读凭证，CI环境使用读写凭证

其他核心配置

Docker运行示例

基本运行（PostgreSQL）

bash
docker run -d \
  -p 80:80 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:pass@postgres-host:5432/pact_broker \
  --name pact-broker \
  docker.xuanyuan.run/dius/pact-broker

带基本认证

bash
docker run -d \
  -p 80:80 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:pass@postgres-host:5432/pact_broker \
  -e PACT_BROKER_BASIC_AUTH_USERNAME=admin \
  -e PACT_BROKER_BASIC_AUTH_PASSWORD=secret \
  -e PACT_BROKER_BASIC_AUTH_READ_ONLY_USERNAME=reader \
  -e PACT_BROKER_BASIC_AUTH_READ_ONLY_PASSWORD=readersecret \
  --name pact-broker \
  docker.xuanyuan.run/dius/pact-broker

Docker Compose示例

创建docker-compose.yml：

yaml
version: '3'

services:
  postgres:
    image: docker.xuanyuan.run/postgres:13
    environment:
      POSTGRES_USER: pact
      POSTGRES_PASSWORD: pact
      POSTGRES_DB: pact_broker
    volumes:
      - postgres_data:/var/lib/postgresql/data

  pact-broker:
    image: docker.xuanyuan.run/dius/pact-broker
    ports:
      - "80:80"
    environment:
      PACT_BROKER_DATABASE_URL: postgres://pact:pact@postgres:5432/pact_broker
      PACT_BROKER_BASIC_AUTH_USERNAME: admin
      PACT_BROKER_BASIC_AUTH_PASSWORD: secret
    depends_on:
      - postgres

volumes:
  postgres_data:

启动服务：

bash
docker-compose up -d

访问Broker：

bash
curl http://localhost  # 浏览器访问 http://localhost

注意事项

• 端口映射：使用-p 80:80，避免Rack中间件因端口问题返回404
• OSX环境：非Docker原生环境需通过docker-machine ip $(docker-machine active)获取访问IP
• 生产环境：需修改默认凭证，确保安全性
• 新镜像迁移：pactfoundation/pact-broker镜像默认端口为9292，环境变量兼容，可直接替换

故障排除

参见https://github.com/pact-foundation/pact-broker-docker/wiki/Troubleshooting

更多文档

Pact Broker应用文档：Pact Broker官方文档