folioorg/mgr-tenant-entitlements

FOLIO - mgr-tenant-entitlements 镜像文档

镜像概述

mgr-tenant-entitlements 是 FOLIO（一个开源图书馆服务平台）的核心组件之一，主要负责租户的授权管理与权限配置。该组件通过提供标准化的接口和功能，确保FOLIO平台中不同租户能够根据其授权范围访问相应的资源和功能，是实现多租户权限隔离的关键模块。

代码仓库：https://github.com/folio-org/mgr-tenant-entitlements

核心功能与特性

• 租户授权管理：支持对FOLIO平台租户的授权信息进行创建、查询、更新和删除操作
• 权限配置：提供细粒度的权限控制机制，可配置租户对不同FOLIO服务和资源的访问权限
• 集成兼容性：与FOLIO生态系统中的其他服务（如用户管理、资源访问控制等）无缝集成
• API支持：通过RESTful API提供权限管理功能，便于与外部系统集成和自动化操作
• 可扩展性：支持根据业务需求扩展权限管理规则和策略

使用场景与适用范围

• 多租户图书馆系统：在FOLIO平台部署多租户环境时，用于隔离不同图书馆租户的权限范围
• 权限精细化管理：需要对租户访问的功能模块、数据资源进行精确控制的场景
• FOLIO平台管理员：供系统管理员配置和维护租户权限，确保资源访问的安全性和合规性
• 自动化运维：通过API集成到运维流程中，实现租户权限的自动化配置和更新

使用方法与配置说明

基本运行方式

使用以下命令启动mgr-tenant-entitlements容器：

bash
docker run -d \
  --name mgr-tenant-entitlements \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=production \
  -e DB_HOST=folio-db \
  -e DB_PORT=5432 \
  -e DB_NAME=folio \
  -e DB_USERNAME=folio_user \
  -e DB_PASSWORD=folio_password \
  folio/mgr-tenant-entitlements:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  mgr-tenant-entitlements:
    image: folio/mgr-tenant-entitlements:latest
    container_name: folio-mgr-tenant-entitlements
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=production
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio
      - DB_USERNAME=folio_user
      - DB_PASSWORD=folio_password
      - KAFKA_BOOTSTRAP_SERVERS=kafka:9092
    depends_on:
      - postgres
      - kafka
    restart: unless-stopped

主要环境变量说明

访问API

服务启动后，可通过以下地址访问API文档（需确保已启用相应配置）：

• API根路径：http://<container-ip>:8080/tenant-entitlements
• Swagger文档：http://<container-ip>:8080/tenant-entitlements/swagger-ui.html

注意事项

• 该组件需与FOLIO平台的其他核心服务（如Okapi网关、用户管理服务等）配合使用
• 数据库连接信息需与FOLIO平台的数据库配置保持一致
• 生产环境中建议通过环境变量或配置文件设置敏感信息（如数据库密码）
• 详细的API使用方法和权限管理规则请参考代码仓库中的官方文档