folioci/mod-inventory-storage

FOLIO - mod-inventory-storage

镜像概述和主要用途

mod-inventory-storage是FOLIO项目的库存存储模块，主要用于处理库存数据的存储与管理。该模块支持数据库连接，集成Kafka消息队列处理消息交互，并提供S3存储服务配置选项，适用于FOLIO平台中库存数据的持久化存储与相关业务流程支持。代码仓库：https://github.com/folio-org/mod-inventory-storage

核心功能和特性

• 数据库连接支持：启用数据库连接功能，用于库存数据的持久化存储。
• Kafka集成：配置Kafka主机、端口、主题分区数、消息保留时间等参数，支持消息队列的生产与消费，处理库存相关消息。
• S3存储支持：提供S3存储服务配置选项，支持AWS S3或本地S3兼容存储，可配置URL、区域、桶名称、访问密钥等参数。
• 资源配置：模块端口为8081，容器内存限制为715827883字节（约683MB），JVM参数配置为-XX:MaxRAMPercentage=66.0，优化内存使用。

使用场景和适用范围

适用于FOLIO图书馆服务平台中需要管理库存数据的场景，如图书馆资源库存记录存储、库存变动消息处理、库存数据与外部存储（如S3）的同步等业务流程。

使用方法和配置说明

基础信息

• 模块端口：8081
• 容器内存：715827883字节（约683MB）
• 数据库连接：启用（true）
• JAVA_OPTIONS：-XX:MaxRAMPercentage=66.0

环境变量配置

以下环境变量需根据实际部署需求配置：

基础配置

• ENV：环境标识，默认值为folio
• ECS_TLR_FEATURE_ENABLED：是否启用ECS TLR功能，默认值为false

Kafka配置

• KAFKA_HOST：Kafka主机地址，默认值为kafka
• KAFKA_PORT：Kafka端口，默认值为9092
• REPLICATION_FACTOR：副本因子，默认值为1
• KAFKA_DOMAIN_TOPIC_NUM_PARTITIONS：domain主题分区数，默认值为50
• KAFKA_CLASSIFICATION_TYPE_TOPIC_NUM_PARTITIONS：classification-type主题分区数，默认值为1
• KAFKA_CALL_NUMBER_TYPE_TOPIC_NUM_PARTITIONS：call-number-type主题分区数，默认值为1
• KAFKA_LOCATION_TOPIC_NUM_PARTITIONS：location主题分区数，默认值为1
• KAFKA_LIBRARY_TOPIC_NUM_PARTITIONS：library主题分区数，默认值为1
• KAFKA_CAMPUS_TOPIC_NUM_PARTITIONS：campus主题分区数，默认值为1
• KAFKA_INSTITUTION_TOPIC_NUM_PARTITIONS：institution主题分区数，默认值为1
• KAFKA_SUBJECT_TYPE_TOPIC_NUM_PARTITIONS：subject-type主题分区数，默认值为1
• KAFKA_SUBJECT_SOURCE_TOPIC_NUM_PARTITIONS：subject-source主题分区数，默认值为1
• KAFKA_REINDEX_RECORDS_TOPIC_NUM_PARTITIONS：reindex-records主题分区数，默认值为16
• KAFKA_REINDEX_RECORDS_TOPIC_MESSAGE_RETENTION：reindex-records主题消息保留时间（毫秒），默认值为86400000
• KAFKA_REINDEX_RECORDS_TOPIC_MAX_MESSAGE_SIZE：reindex-records主题最大消息大小（字节），默认值为10485760
• KAFKA_REINDEX_PRODUCER_MAX_REQUEST_SIZE_BYTES：reindex生产者最大请求大小（字节），默认值为10485760

S3存储配置

• S3_URL：S3服务URL，默认值为https://s3.amazonaws.com
• S3_REGION：S3区域，默认值为us-west-2
• S3_BUCKET：S3桶名称（需自行配置）
• S3_ACCESS_KEY_ID：S3访问密钥ID（需自行配置）
• S3_SECRET_ACCESS_KEY：S3密钥（需自行配置）
• S3_IS_AWS：是否为AWS S3，默认值为true
• S3_LOCAL_SUB_PATH：本地S3存储子路径，默认值为mod-inventory-storage

部署示例

Docker Run命令示例

bash
docker run -d \
  -p 8081:8081 \
  -e "DB_HOST=your-db-host" \
  -e "DB_PORT=5432" \
  -e "DB_NAME=folio_inventory" \
  -e "DB_USER=folio_user" \
  -e "DB_PASSWORD=your-password" \
  -e "KAFKA_HOST=your-kafka-host" \
  -e "S3_BUCKET=your-s3-bucket" \
  -e "S3_ACCESS_KEY_ID=your-access-key" \
  -e "S3_SECRET_ACCESS_KEY=your-secret-key" \
  folio/mod-inventory-storage

Docker Compose配置示例

yaml
version: '3'
services:
  mod-inventory-storage:
    image: folio/mod-inventory-storage
    ports:
      - "8081:8081"
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio_inventory
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
      - KAFKA_HOST=kafka
      - KAFKA_PORT=9092
      - S3_BUCKET=folio-inventory-storage
      - S3_REGION=us-west-2
      - S3_ACCESS_KEY_ID=AKIAEXAMPLE
      - S3_SECRET_ACCESS_KEY=secret
    depends_on:
      - postgres
      - kafka

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_DB=folio_inventory
      - POSTGRES_USER=folio_user
      - POSTGRES_PASSWORD=folio_password

  kafka:
    image: confluentinc/cp-kafka:7.0.0
    environment:
      - KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092
      - KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR=1