folioci/mod-search Docker Image Overview

folioci/mod-search

FOLIO mod-search是FOLIO图书馆服务平台的搜索模块，负责处理Kafka事件、管理Elasticsearch索引及提供搜索查询服务，支持inventory和authorities数据的索引与检索。

0 次下载

🚀 生产环境还在裸拉官方镜像？一次故障=一次通宵

中文简介版本下载

🚀 生产环境还在裸拉官方镜像？一次故障=一次通宵

FOLIO - mod-search

镜像概述

mod-search是FOLIO图书馆服务平台的核心搜索模块，提供数据索引和搜索查询功能。该模块通过Kafka消费inventory（实例、holdings记录、项目等）和authorities数据事件，将数据索引至Elasticsearch，并响应搜索查询请求。代码仓库：[***]

核心功能与特性

核心功能

Kafka事件处理：消费inventory（instance、holdings-record、item等）和authorities主题事件，实现数据变更同步
Elasticsearch索引管理：将消费的事件数据构建为搜索索引，支持索引重建、延迟索引和批量处理
搜索查询服务：处理搜索请求，支持主题、贡献者、分类和索书号等多维度浏览与检索
多源数据整合：整合inventory和authorities数据，提供统一的搜索入口

关键特性

支持Kafka事件并发消费，可配置消费线程数和拉取参数
提供Elasticsearch索引压缩、数据格式优化等性能调优选项
支持全字段搜索与定向字段搜索，可配置浏览功能开关
内置索引重建机制，支持范围索引和记录级重建

使用场景

适用于FOLIO图书馆服务平台中各类资源的搜索场景，包括：

图书馆馆藏资源（实例、holdings、item）检索
规范数据（authorities）查询
主题、贡献者、分类及索书号等维度的资源浏览
大规模馆藏数据的增量索引与实时搜索

核心配置参数

基础配置

参数	描述	值
MODULE_PORT	服务端口	8081
Container memory	容器内存限制	***字节（1GB）
Database connection	是否需要数据库连接	true
JAVA_OPTIONS	Java运行参数	-XX:MaxRAMPercentage=85.0
ENV	环境标识	folio

Kafka配置

连接与安全配置

参数	描述	默认值
KAFKA_HOST	Kafka服务地址	kafka
KAFKA_PORT	Kafka服务端口	9092
KAFKA_SECURITY_PROTOCOL	安全协议	PLAINTEXT
KAFKA_SSL_KEYSTORE_LOCATION	SSL密钥库路径	（空）
KAFKA_SSL_TRUSTSTORE_LOCATION	SSL信任库路径	（空）

事件消费配置

参数	描述	默认值
KAFKA_EVENTS_CONSUMER_PATTERN	inventory事件主题匹配模式	(folio.)(.*.)inventory.(instance\|holdings-record\|item\|bound-with)
KAFKA_EVENTS_CONCURRENCY	inventory事件消费并发数	2
KAFKA_AUTHORITIES_CONSUMER_PATTERN	authorities事件主题匹配模式	(folio.)(.*.)authorities.authority
KAFKA_AUTHORITIES_CONCURRENCY	authorities事件消费并发数	1

性能调优配置

参数	描述	默认值
KAFKA_CONSUMER_EVENTS_MAX_POLL_RECORDS	事件消费者单次拉取最大记录数	200
KAFKA_CONSUMER_EVENTS_MAX_POLL_INTERVAL_MS	事件消费者最大拉取间隔（毫秒）	600000
KAFKA_RETRY_INTERVAL_MS	重试间隔（毫秒）	2000
KAFKA_RETRY_DELIVERY_ATTEMPTS	重试次数	6

Elasticsearch配置

参数	描述	默认值
ELASTICSEARCH_URL	服务地址	[***]
ELASTICSEARCH_USERNAME	访问用户名	elastic
ELASTICSEARCH_PASSWORD	访问密码	s3cret
ELASTICSEARCH_COMPRESSION_ENABLED	是否启用压缩	true
INDEXING_DATA_FORMAT	索引数据格式	smile

索引与搜索配置

参数	描述	默认值
INSTANCE_CHILDREN_INDEX_ENABLED	是否启用实例子项索引	true
INSTANCE_CHILDREN_INDEX_DELAY_MS	实例子项索引延迟（毫秒）	60000
SEARCH_BY_ALL_FIELDS_ENABLED	是否启用全字段搜索	false
BROWSE_SUBJECTS_ENABLED	是否启用主题浏览	true
SEARCH_QUERY_TIMEOUT	搜索查询超时时间	25s

使用方法

Docker Run部署示例

bash
docker run -d \
  --name mod-search \
  -p 8081:8081 \
  -e MODULE_PORT=8081 \
  -e KAFKA_HOST=kafka \
  -e KAFKA_PORT=9092 \
  -e ELASTICSEARCH_URL=[***] \
  -e ELASTICSEARCH_USERNAME=elastic \
  -e ELASTICSEARCH_PASSWORD=your_es_password \
  -e DB_HOST=postgres \
  -e DB_PORT=5432 \
  -e DB_NAME=folio \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=folio_password \
  folio/mod-search

Docker Compose配置示例

yaml
version: '3'
services:
  mod-search:
    image: folio/mod-search
    ports:
      - "8081:8081"
    environment:
      - MODULE_PORT=8081
      - Container memory=***
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=85.0
      - ENV=folio
      - KAFKA_HOST=kafka
      - KAFKA_PORT=9092
      - KAFKA_SECURITY_PROTOCOL=PLAINTEXT
      - ELASTICSEARCH_URL=[***]
      - ELASTICSEARCH_USERNAME=elastic
      - ELASTICSEARCH_PASSWORD=your_es_password
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
    depends_on:
      - kafka
      - elasticsearch
      - postgres