solace/solace-pubsub-connector-cdc-postgres

Solace PubSub+ CDC Postgres 连接器

概述

Solace PubSub+ CDC Postgres连接器用于在Solace PubSub+ Broker与Postgres CDC（变更数据捕获）系统之间传输数据，实现事件驱动架构中的实时数据同步。本镜像提供灵活的配置方式、健康检查机制及JVM调优选项，适用于需要跨系统数据集成的场景。

核心功能与特性

• 实现Solace PubSub+ Broker与Postgres CDC系统间的数据传输
• 支持通过环境变量或Spring配置文件进行灵活配置
• 提供健康检查机制，可监控连接器运行状态
• 支持多种卷挂载，包括配置文件、库文件、类路径文件及输出文件
• 允许通过环境变量自定义JVM参数，优化运行性能

使用场景与适用范围

适用于事件驱动架构中需将Postgres数据库变更数据实时同步至Solace PubSub+ Broker的场景，如实时数据分析、微服务间数据通信、跨系统数据集成及业务事件流处理等。

详细使用方法与配置说明

前提条件

• Docker 或 Podman
• Solace PubSub+ Event Broker
• PostgreSQL数据库

基本使用

连接主机服务

若服务（如PubSub+事件代理）在本地主机暴露，可使用容器平台的特殊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-cdc-postgres:1.0.0

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-cdc-postgres:1.0.0

配置健康检查

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

• 创建名为healthcheck的只读用户（通过SOLACE_CONNECTOR_SECURITY_USERS_0_NAME和SOLACE_CONNECTOR_SECURITY_USERS_0_PASSWORD设置用户名和密码）
• 使用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-cdc-postgres:1.0.0

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-cdc-postgres:1.0.0

配置提供方式

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

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

端口

容器需要以下端口：

卷

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

卷：Spring配置文件

用于添加Spring配置文件（如application.yml等），需挂载只读卷或绑定至/app/external/spring/config/。该目录遵循Spring默认config/目录的语义，连接器启动时会自动从以下位置加载配置文件：

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

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

• 推荐配置：
  • /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文件。