folioci/mod-consortia-keycloak

FOLIO - mod-consortia-keycloak 镜像文档

镜像概述和主要用途

本镜像为FOLIO图书馆服务平台的mod-consortia-keycloak模块提供容器化部署，主要用于集成Keycloak实现联盟（consortia）相关功能。该模块支持与FOLIO数据库交互、Kafka消息传递，并通过环境变量灵活配置运行参数，默认暴露8081端口提供服务。

核心功能和特性

• Keycloak集成：实现联盟场景下的身份验证与授权功能
• 数据库支持：提供FOLIO数据库连接能力，支持连接池和查询超时配置
• Kafka集成：支持与Kafka消息系统通信，可配置安全协议及SSL参数
• 灵活配置：通过环境变量自定义JVM参数、数据库连接、Kafka连接及OKAPI服务地址
• 标准化部署：默认暴露8081/tcp端口，符合FOLIO模块部署规范

使用场景和适用范围

适用于FOLIO平台部署环境，特别针对需要实现图书馆联盟管理功能的场景，可作为联盟服务的核心组件，处理联盟成员的身份验证、权限管理及相关业务逻辑。

详细使用方法和配置说明

基本部署示例

Docker Run命令

bash
docker run -d -p 8081:8081 \
  -e DB_HOST=folio-db \
  -e DB_PORT=5432 \
  -e DB_DATABASE=folio_mod_consortia \
  -e DB_USERNAME=folio_user \
  -e DB_PASSWORD=secure_password \
  -e KAFKA_HOST=kafka-broker \
  -e OKAPI_URL=http://okapi:9130 \
  folio/mod-consortia-keycloak

环境变量配置说明

JVM参数

• JAVA_OPTIONS
  JVM运行参数，默认值：-XX:MaxRAMPercentage=66.0
  用于配置JVM内存分配等参数

数据库连接配置

• DB_DATABASE（必填）
  数据库名称，用于指定模块连接的数据库实例
• DB_HOST（必填）
  数据库主机地址
• DB_PORT（必填）
  数据库端口号
• DB_USERNAME（必填）
  数据库访问用户名
• DB_PASSWORD（必填）
  数据库访问密码
• DB_CHARSET
  数据库字符集配置
• DB_MAXPOOLSIZE
  数据库连接池最大连接数，默认值：5
• DB_QUERYTIMEOUT
  数据库查询超时时间（毫秒），默认值：60000

Kafka配置

• KAFKA_HOST
  Kafka broker主机地址，默认值：10.0.2.15
• KAFKA_PORT
  Kafka broker端口，默认值：9092
• KAFKA_SECURITY_PROTOCOL
  Kafka安全协议，默认值：PLAINTEXT，支持SSL等协议
• KAFKA_SSL_KEYSTORE_LOCATION
  SSL密钥库文件路径（当安全协议为SSL时需配置）
• KAFKA_SSL_KEYSTORE_PASSWORD
  SSL密钥库密码（当安全协议为SSL时需配置）
• KAFKA_SSL_TRUSTSTORE_LOCATION
  SSL信任库文件路径（当安全协议为SSL时需配置）
• KAFKA_SSL_TRUSTSTORE_PASSWORD
  SSL信任库密码（当安全协议为SSL时需配置）

其他配置

• ENV
  环境标识，默认值：folio，用于区分不同部署环境
• OKAPI_URL
  FOLIO OKAPI服务地址，默认值：http://okapi:9130，模块通过该地址与OKAPI交互

资源需求

• 内存需求：容器默认内存限制约为702MB（702293850字节），可通过JAVA_OPTIONS调整JVM内存参数适配实际环境