jalispran/pubsub-emulator-docker

Google Cloud Pub/Sub 模拟器

一个Google Cloud Pub/Sub 模拟器容器镜像。该镜像用于创建独立的测试模拟器，兼容Apple Silicon芯片。

镜像概述和主要用途

本镜像提供了本地运行的Google Cloud Pub/Sub模拟器环境，使开发和测试过程无需连接生产环境的Cloud Pub/Sub服务。主要用于在开发阶段验证应用程序与Pub/Sub服务的交互逻辑，确保功能正确性。

核心功能和特性

• 提供独立的Pub/Sub服务模拟环境
• 兼容Apple Silicon芯片架构
• 支持通过环境变量灵活配置
• 可通过Docker Compose快速部署
• 支持数据持久化以保持状态

使用场景和适用范围

• 应用程序开发阶段的本地测试
• CI/CD流水线中的集成测试
• 需要验证Pub/Sub消息发布、订阅逻辑的场景
• 不希望依赖生产环境Pub/Sub服务的开发工作流

环境变量配置

以下环境变量必须设置：

• PUBSUB_LISTEN_ADDRESS: 模拟器监听地址，格式为HOST:PORT（例如0.0.0.0:8432）。0.0.0.0可用于监听所有网络接口。容器必须暴露该端口。
• PUBSUB_PROJECT_ID: 模拟器使用的Google Cloud项目ID。

应用连接模拟器

应用程序需要设置以下环境变量以连接到模拟器（而非生产环境）：

• PUBSUB_EMULATOR_HOST: 模拟器的监听地址（与PUBSUB_LISTEN_ADDRESS值相同）
• PUBSUB_PROJECT_ID: 模拟器使用的项目ID（与PUBSUB_PROJECT_ID值相同）

自定义命令

镜像包含名为start-pubsub的脚本（已加入PATH），用于初始化Pub/Sub模拟器。

启动模拟器

默认情况下，容器启动时执行以下命令：

sh
start-pubsub

Docker部署示例

使用Docker Compose部署

使用Docker Compose是部署此模拟器的最简单方式。以下是docker-compose.yml配置示例：

yaml
version: "2"

services:
  pubsub:
    image: singularities/pubsub-emulator
    environment:
      - PUBSUB_PROJECT_ID=project-test
      - PUBSUB_LISTEN_ADDRESS=0.0.0.0:8432
    ports:
      - "8432:8432"

数据持久化

镜像已在/opt/data目录挂载卷。为了在容器重启之间保持状态，需挂载该目录的外部卷：

yaml
version: "2"

services:
  pubsub:
    image: singularities/pubsub-emulator
    environment:
      - PUBSUB_PROJECT_ID=project-test
      - PUBSUB_LISTEN_ADDRESS=0.0.0.0:8432
    ports:
      - "8432:8432"
    volumes:
      - ./pubsub-data:/opt/data  # 将本地目录挂载到容器的数据目录