solace/solace-pubsub-connector-database

pubsubplus-connector-database-sql

Solace Corporation [***]

版本：1.0.2
版本日期：2025-04-22

目录

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

前言

Solace数据库连接器

快速开始

发行说明

前提条件

• Docker 或 Podman
• PubSub+事件代理
• SolaceDBConnector

使用方法

连接主机上的服务

如果服务（例如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-database:1.0.2

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-database:1.0.2

配置健康检查

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

• 使用SOLACE_CONNECTOR_SECURITY_USERS_0_NAME和SOLACE_CONNECTOR_SECURITY_USERS_0_PASSWORD创建名为healthcheck的常规只读用户及其密码。
• 在容器的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-database:1.0.2

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-database:1.0.2

提供配置

可通过以下方式向容器提供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。

许可证

本项目采用Apache License 2.0许可证。详情请参见容器/licenses目录下的LICENSE文件。