solace/solace-pubsub-connector-gcppubsub

Solace PubSub+ Connector for GCP Pub/Sub

Solace Corporation [***]

版本：2.7.12
版本日期：2025-07-11

目录

• 概述
• 快速开始
  • 前提条件
  • 使用方法
  • 连接主机服务
  • 配置健康检查
• 配置提供方式
• 端口
• 卷
  • 卷：Spring配置文件
  • 卷：库文件
  • 卷：类路径文件
  • 卷：输出文件
• 配置JVM
  • 支持
• 许可证

概述

Solace PubSub+ Connector for GCP Pub/Sub在Solace PubSub+ Event Broker与GCP Pub/Sub之间桥接数据，为GCP Pub/Sub应用数据与基于Solace的事件驱动架构及事件网格（Event Mesh）集成提供灵活高效的方式。该连接器可独立部署，或采用“主备”（active-standby）、“主主”（active-active）冗余模式部署，以实现数据传输的高可用性和水平扩展。每个连接器实例支持最多20个独立工作流（源到目标管道），减少需部署和管理的连接器实例数量。通过使用多种Spring框架技术，可轻松配置连接器、实现高级日志功能，并将实时指标数据导出到外部监控解决方案。

快速开始

发布说明

前提条件

• Docker 或 Podman
• PubSub+ Event Broker
• GCP Pub/Sub

使用方法

1. 创建名为config的目录

2. 在config目录中创建application.yml或application.properties文件，包含连接器所需的属性配置

   • 配置文件示例可参考连接器ZIP包中的文件，下载地址：<[***]>

3. 已通过gcloud cli设置应用默认凭据（ADC），且application_default_credentials.json位于默认位置

4. 在application.yml或application.properties中设置属性spring.cloud.gcp.credentials.location为/app/external/gcp/config/application_default_credentials.json

5. 使用最小配置运行容器：

   Docker

   bash
   docker run -d --name my-connector \
     -v `pwd`/libs/:/app/external/libs/:ro \
     -v `pwd`/config/:/app/external/spring/config/:ro \
     -v $HOME/.config/gcloud/application_default_credentials.json:/app/external/gcp/config/application_default_credentials.json:ro \
     solace/solace-pubsub-connector-gcppubsub:2.7.12
   

   Podman

   bash
   podman run -d --name my-connector \
     -v `pwd`/libs/:/app/external/libs/:ro \
     -v `pwd`/config/:/app/external/spring/config/:ro \
     -v $HOME/.config/gcloud/application_default_credentials.json:/app/external/gcp/config/application_default_credentials.json:ro \
     solace/solace-pubsub-connector-gcppubsub:2.7.12
   

注意
在Windows系统中，application_default_credentials.json的默认位置为%APPDATA%\gcloud\application_default_credentials.json，请相应调整卷挂载路径。
提示
假设Google Cloud application_default_credentials.json位于默认位置，后续所有docker/podman命令需根据环境添加卷挂载：
Linux/MacOS：
-v $HOME/.config/gcloud/application_default_credentials.json:/app/external/gcp/config/application_default_credentials.json:ro \
Windows：
-v %APPDATA%\gcloud\application_default_credentials.json:/app/external/gcp/config/application_default_credentials.json:ro \

连接主机服务

如果服务（如PubSub+ event broker）在本地主机暴露，可使用容器平台的特殊DNS名称通过SOLACE_JAVA_HOST引用，该名称解析为主机使用的内部IP地址。

Docker示例命令：

bash
docker run -d --name my-connector \
  -v `pwd`/libs/:/app/external/libs/:ro \
  -v `pwd`/config/:/app/external/spring/config/:ro \
  --env SOLACE_JAVA_HOST=host.docker.internal:55555 \
  solace/solace-pubsub-connector-gcppubsub:2.7.12

Podman示例命令：

bash
podman run -d --name my-connector \
  -v `pwd`/libs/:/app/external/libs/:ro \
  -v `pwd`/config/:/app/external/spring/config/:ro \
  --env SOLACE_JAVA_HOST=host.containers.internal:55555 \
  solace/solace-pubsub-connector-gcppubsub:2.7.12

配置健康检查

可配置健康检查执行以下任务：

• 使用SOLACE_CONNECTOR_SECURITY_USERS_0_NAME和SOLACE_CONNECTOR_SECURITY_USERS_0_PASSWORD创建名为healthcheck的只读用户及密码
• 使用healthcheck用户轮询容器的管理健康端点，若连接器不健康则检查失败

容器健康检查配置示例命令：

Docker示例：

bash
docker run -d --name my-connector \
  -v `pwd`/libs/:/app/external/libs/:ro \
  -v `pwd`/application.yml:/app/external/spring/config/application.yml:ro \
  --env SOLACE_CONNECTOR_SECURITY_USERS_0_NAME=healthcheck \
  --env SOLACE_CONNECTOR_SECURITY_USERS_0_PASSWORD=healthcheck \
  --healthcheck-command="curl -X GET -u healthcheck:healthcheck --fail localhost:8090/actuator/health" \
  solace/solace-pubsub-connector-gcppubsub:2.7.12

Podman示例：

bash
podman run -d --name my-connector \
  -v `pwd`/libs/:/app/external/libs/:ro \
  -v `pwd`/application.yml:/app/external/spring/config/application.yml:ro \
  --env SOLACE_CONNECTOR_SECURITY_USERS_0_NAME=healthcheck \
  --env SOLACE_CONNECTOR_SECURITY_USERS_0_PASSWORD=healthcheck \
  --healthcheck-command="curl -X GET -u healthcheck:healthcheck --fail localhost:8090/actuator/health" \
  solace/solace-pubsub-connector-gcppubsub:2.7.12

配置提供方式

可通过以下方式向容器提供Spring配置属性：

1. 使用环境变量
2. 使用包含Spring配置文件的卷（及其他卷）

端口

容器需要以下端口：

卷

以下是支持创建卷和绑定挂载的目录：

卷：Spring配置文件

Spring配置文件卷用于添加Spring配置文件（如application.yml等），需添加只读卷或绑定挂载到/app/external/spring/config/。

该目录遵循Spring默认config/目录的语义，连接器启动时会自动从以下位置查找并加载Spring配置文件：

1. /app/external/spring/config/的根目录
2. /app/external/spring/config/的直接子目录

提示
若需在同一config目录中为不同环境（如开发、生产）配置多个连接器的配置文件，建议使用Spring Boot配置文件而非子目录。例如：

• 推荐配置：
  • /app/external/spring/config/application-prod.yml
  • /app/external/spring/config/application-dev.yml
• 不推荐配置：
  • /app/external/spring/config/prod/application.yml
  • /app/external/spring/config/dev/application.yml
    子目录用于合并多个配置源的配置属性。有关何时可能需要使用多个子目录组合应用配置的示例，详见Spring Boot文档。

卷：库文件

库文件卷用于添加额外库，需添加只读卷或绑定挂载到/app/external/libs/。

该目录用于存放仅在使用连接器特定功能时所需的Java库依赖（外部JAR文件），例如使用连接器配置中的Prometheus指标导出功能时所需的Prometheus库。

详见ZIP包中连接器libs目录下的文档。

卷：类路径文件

类路径文件卷用于添加任意文件（非JAR库或Spring Boot配置文件），需添加只读卷或绑定挂载到/app/external/classpath/。

注意
该目录不得包含库JAR文件或Spring Boot配置文件，否则可能导致库无法在连接器部署时被正确加载，或覆盖连接器内部配置。

卷：输出文件

输出文件卷用于支持写入输出文件的功能（如文件日志），需添加读写卷或绑定挂载到/app/external/output/目录。

重要
使用生成文件的功能时，必须将功能配置为将文件生成到/app/external/output/目录。生成文件到其他目录不受支持。

配置JVM

可通过在容器上设置JDK_JAVA_OPTIONS环境变量配置Java虚拟机（JVM）。

详见JDK文档。

提示
本容器作为示例提供，已通过以下配置测试：

• 两个活动处理器（使用-XX:ActiveProcessorCount=2指定）
• 最大堆内存2 GB（使用-Xmx2048m指定）

支持

通过Solace开发者社区提供尽力支持。

提供高级支持选项，详情请联系Solace。

许可证

本项目采用Solace社区许可证1.0版。详见容器/licenses目录下的LICENSE文件。