pactfoundation/pact-broker

Docker化的Pact Broker

镜像概述和主要用途

pactfoundation/pact-broker镜像是https://github.com/pact-foundation/pact_broker的Docker化版本，可从https://hub.docker.com/r/pactfoundation/pact-broker/获取。该镜像提供了一个集中式服务，用于存储和管理消费者驱动契约测试中的Pact文件，支持服务之间的契约共享、版本控制和集成验证。

注意：2018年5月12日，Docker标签格式从M.m.p-RELEASE更改为M.m.p.RELEASE（其中M.m.p是基础Pact Broker包的语义化版本），以便Dependabot能够识别版本增量。

核心功能和特性

• 轻量级：基于Alpine Linux和Puma，比基于Phusion Passenger的镜像更小
• 无需root权限运行，提高安全性
• 支持PostgreSQL和MySQL数据库
• 自动数据库迁移
• 基本认证支持
• 可配置的Webhook白名单
• 灵活的环境变量配置
• 支持自定义端口和数据库URL环境变量名称
• 内置健康检查端点

使用场景和适用范围

适用环境

• 容器化部署环境（如Docker、Kubernetes、ECS等）
• 需要集中管理Pact契约的微服务架构
• CI/CD流水线中集成契约测试

与dius/pact-broker的选择指南

• pactfoundation/pact-broker：适用于具有外部监控和高可用性管理的容器编排环境（如Kubernetes、ECS），需要较小镜像体积和非root运行的场景
• dius/pact-broker：适用于独立运行的场景，Passenger会自动重启崩溃的进程，适合没有外部监控的环境

详细的使用方法和配置说明

前提条件

• 运行中的PostgreSQL数据库及连接权限（详见https://github.com/pact-foundation/pact-broker-docker/blob/master/POSTGRESQL.md）

安装与启动

Docker快速启动

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  --name pact-broker \
  pactfoundation/pact-broker

使用Docker Compose

1. 获取示例docker-compose.yml文件：

bash
curl -O https://raw.githubusercontent.com/pact-foundation/pact-broker-docker/master/docker-compose.yml

2. 根据需要修改配置

3. 启动服务：

bash
docker-compose up -d

4. 访问Pact Broker：

bash
curl -v http://localhost  # HTTP端点
curl -v -k https://localhost:8443  # HTTPS端点

数据库配置

使用数据库URL

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  pactfoundation/pact-broker

分参数配置

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_ADAPTER=postgres \
  -e PACT_BROKER_DATABASE_USERNAME=user \
  -e PACT_BROKER_DATABASE_PASSWORD=password \
  -e PACT_BROKER_DATABASE_HOST=host \
  -e PACT_BROKER_DATABASE_NAME=database \
  -e PACT_BROKER_DATABASE_PORT=5432 \
  pactfoundation/pact-broker

数据库连接参数

• PACT_BROKER_DATABASE_ADAPTER：数据库适配器，可选值为'postgres'(推荐)或'mysql2'，默认'postgres'
• PACT_BROKER_DATABASE_USERNAME：数据库用户名
• PACT_BROKER_DATABASE_PASSWORD：数据库密码
• PACT_BROKER_DATABASE_HOST：数据库主机
• PACT_BROKER_DATABASE_NAME：数据库名称
• PACT_BROKER_DATABASE_PORT：数据库端口，默认使用适配器默认端口
• PACT_BROKER_DATABASE_SSLMODE：SSL模式，可选值：'disable', 'allow', 'prefer', 'require', 'verify-ca', 'verify-full'（仅PostgreSQL适用）
• PACT_BROKER_DATABASE_MAX_CONNECTIONS：连接池最大连接数，默认4
• PACT_BROKER_DATABASE_POOL_TIMEOUT：连接池超时时间（秒），默认5

安全配置

基本认证

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  -e PACT_BROKER_BASIC_AUTH_USERNAME=admin \
  -e PACT_BROKER_BASIC_AUTH_PASSWORD=securepassword \
  -e PACT_BROKER_BASIC_AUTH_READ_ONLY_USERNAME=reader \
  -e PACT_BROKER_BASIC_AUTH_READ_ONLY_PASSWORD=readpassword \
  pactfoundation/pact-broker

公共只读访问

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  -e PACT_BROKER_BASIC_AUTH_USERNAME=admin \
  -e PACT_BROKER_BASIC_AUTH_PASSWORD=securepassword \
  -e PACT_BROKER_ALLOW_PUBLIC_READ=true \
  pactfoundation/pact-broker

高级配置

日志级别设置

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  -e PACT_BROKER_LOG_LEVEL=INFO \
  pactfoundation/pact-broker

日志级别可选值：DEBUG, INFO, WARN, ERROR, FATAL

Webhook白名单

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  -e PACT_BROKER_WEBHOOK_HOST_WHITELIST="github.com travis.org /.*\\.foo\\.com$/" \
  -e PACT_BROKER_WEBHOOK_SCHEME_WHITELIST="https" \
  pactfoundation/pact-broker

自定义端口环境变量

bash
docker run -d \
  -p 5000:5000 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  -e PACT_BROKER_PORT_ENVIRONMENT_VARIABLE_NAME=APP_PORT \
  -e APP_PORT=5000 \
  pactfoundation/pact-broker

自定义数据库URL环境变量

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL_ENVIRONMENT_VARIABLE_NAME=DATABASE_URL \
  -e DATABASE_URL=postgres://user:password@host:port/database \
  pactfoundation/pact-broker

启用公共心跳URL

bash
docker run -d \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=postgres://user:password@host:port/database \
  -e PACT_BROKER_PUBLIC_HEARTBEAT=true \
  pactfoundation/pact-broker

访问心跳URL：http://localhost:9292/diagnostic/status/heartbeat

环境变量参考

核心配置

安全配置

高级配置

数据库迁移

Pact Broker在启动时会自动执行数据库迁移。如需回滚迁移，请执行：

bash
# 进入容器
docker exec -it pact-broker sh

# 运行迁移回滚命令（示例回滚到20191101版本）
bundle exec rake pact_broker:db:migrate[20191101]

# 确认当前版本
bundle exec rake pact_broker:db:version

故障排除

有关常见问题和解决方案，请参见https://github.com/pact-foundation/pact-broker-docker/wiki/Troubleshooting页面。