folioci/mod-entities-links

FOLIO - mod-entities-links

镜像概述与主要用途

mod-entities-links是FOLIO图书馆服务平台的核心模块之一，主要用于管理系统中各类实体（如图书、用户、资源等）之间的链接关系。该模块支持数据库存储实体链接数据，通过Kafka实现消息的生产与消费以同步实体关系变更，并集成S3兼容存储服务处理相关文件存储需求。模块默认端口为8081，容器内存需求为1GB（***字节）。

核心功能与特性

• 实体链接管理：处理系统中各实体间的关联关系，维护实体链接数据的创建、更新与查询
• 数据库集成：支持数据库连接，用于持久化存储实体链接相关数据
• Kafka消息处理：配置Kafka主题分区、消费者并发度等参数，实现实体关系变更消息的生产与消费，确保分布式环境下的数据一致性
• S3存储集成：支持与S3兼容的对象存储服务交互，配置存储URL、区域、访问密钥等参数，处理实体链接相关文件的存储与访问
• 资源配置优化：通过JAVA_OPTIONS设置JVM内存使用（默认-XX:MaxRAMPercentage=85.0），优化容器内存资源利用

使用场景与适用范围

适用于基于FOLIO平台构建的图书馆管理系统，用于管理图书、用户、借阅记录、馆藏资源等实体间的链接关系。尤其适合需要处理大量实体关联数据、要求高可用性和数据一致性的图书馆服务场景，如高校图书馆、公共图书馆的资源管理系统。

使用方法与配置说明

环境变量配置

以下为模块运行所需的关键环境变量配置说明：

基础配置

• ENV：运行环境标识，默认值为folio
• OKAPI_URL：FOLIO Okapi服务地址，默认值为okapi
• JAVA_OPTIONS：JVM参数，默认值为-XX:MaxRAMPercentage=85.0

Kafka配置

• KAFKA_HOST：Kafka服务主机地址，默认值为kafka
• KAFKA_PORT：Kafka服务端口，默认值为9092
• KAFKA_SECURITY_PROTOCOL：Kafka安全协议，默认值为PLAINTEXT
• KAFKA_CONSUMER_MAX_POLL_RECORDS：Kafka消费者单次拉取最大记录数，默认值为50
• KAFKA_AUTHORITY_SOURCE_FILE_TOPIC_PARTITIONS：权威源文件主题分区数，默认值为1
• KAFKA_INSTANCE_AUTHORITY_TOPIC_PARTITIONS：实例权威主题分区数，默认值为10
• KAFKA_AUTHORITIES_CONSUMER_CONCURRENCY：权威消费者并发度，默认值为1
• KAFKA_INSTANCE_AUTHORITY_CHANGE_PARTITIONS：实例权威变更主题分区数，默认值为100

S3存储配置

• S3_URL：S3兼容存储服务URL，默认值为https://s3.amazonaws.com
• S3_REGION：S3存储区域，默认值为us-west-2
• S3_BUCKET：S3存储桶名称（需用户自定义）
• S3_ACCESS_KEY_ID：S3访问密钥ID（需用户自定义，若使用AWS S3且配置IAM角色可省略）
• S3_SECRET_ACCESS_KEY：S3密钥（需用户自定义，同上）
• S3_IS_AWS：是否为AWS S3服务，默认值为true

其他配置

• INSTANCE_STORAGE_QUERY_BATCH_SIZE：实例存储查询批量大小，默认值为50
• AUTHORITY_ARCHIVES_EXPIRATION_PERIOD：权威档案过期周期（天），默认值为7

Docker运行示例

bash
docker run -d \
  --name mod-entities-links \
  -p 8081:8081 \
  -e OKAPI_URL=http://okapi:9130 \
  -e KAFKA_HOST=kafka-service \
  -e KAFKA_PORT=9092 \
  -e S3_BUCKET=folio-entities-links \
  -e S3_ACCESS_KEY_ID=your-access-key \
  -e S3_SECRET_ACCESS_KEY=your-secret-key \
  folioorg/mod-entities-links

Docker Compose配置示例

yaml
version: '3.8'
services:
  mod-entities-links:
    image: folioorg/mod-entities-links
    container_name: mod-entities-links
    ports:
      - "8081:8081"
    environment:
      - ENV=folio
      - OKAPI_URL=http://okapi:9130
      - KAFKA_HOST=kafka
      - KAFKA_PORT=9092
      - KAFKA_SECURITY_PROTOCOL=PLAINTEXT
      - S3_URL=https://s3.amazonaws.com
      - S3_REGION=us-west-2
      - S3_BUCKET=folio-entities-links
      - S3_ACCESS_KEY_ID=your-access-key
      - S3_SECRET_ACCESS_KEY=your-secret-key
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=85.0
    depends_on:
      - kafka
      - postgres
    networks:
      - folio-network

  kafka:
    image: confluentinc/cp-kafka:latest
    environment:
      - KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092
      - KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR=1
    networks:
      - folio-network

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_DB=folio
      - POSTGRES_USER=folio
      - POSTGRES_PASSWORD=folio
    networks:
      - folio-network

networks:
  folio-network:

代码仓库

https://github.com/folio-org/mod-entities-links