openiam-metadata 社区版容器文档

镜像概述

openiam-metadata 社区版容器是 openiam 身份和访问管理（IAM）生态的一部分，专为元数据管理设计。该镜像提供元数据的集中式存储、查询、更新及维护能力，作为 IAM 系统的基础组件，支撑用户、角色、权限等核心实体的元数据生命周期管理。社区版免费开源，适合开发、测试及中小型部署场景。

核心功能与特性

核心功能

• 元数据存储：支持结构化元数据（如用户属性定义、角色权限模板、资源类型等）的持久化存储
• 查询接口：提供 REST API 接口，支持元数据的精确查询、模糊搜索及批量获取
• 维护操作：支持元数据的添加、修改、删除及版本控制，确保元数据一致性
• 集成兼容：与 openiam 系列其他组件（如认证服务、授权引擎）无缝集成

社区版特性

• 开源免费，基于 Apache 许可证分发
• 简化部署流程，支持容器化快速启动
• 社区驱动更新，定期修复漏洞并优化性能
• 提供基础监控指标，支持日志输出到标准流

使用场景与适用范围

适用场景

• 企业内部 IAM 系统搭建：作为元数据管理层，支撑用户身份、权限策略的定义与维护
• 开发测试环境：快速部署元数据服务，验证 IAM 流程中的元数据依赖逻辑
• 中小型组织部署：满足基础元数据管理需求，降低 IAM 系统构建成本

适用范围

• 开发团队：用于 IAM 相关功能的开发与调试
• 运维团队：作为基础组件集成到 IAM 系统架构中
• 中小型企业：无需商业许可即可部署的元数据管理解决方案

使用方法与配置说明

环境要求

• Docker 19.03+ 或 Kubernetes 1.16+
• 至少 512MB 内存，1GB 磁盘空间
• 依赖关系型数据库（如 PostgreSQL、MySQL）用于元数据持久化

快速启动（Docker Run）

bash
docker run -d \
  --name openiam-metadata \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=community \
  -e DB_HOST=metadata-db \
  -e DB_PORT=5432 \
  -e DB_NAME=openiam_metadata \
  -e DB_USER=metadata_user \
  -e DB_PASSWORD=metadata_pass \
  openiam/metadata:community-latest

Docker Compose 配置示例

yaml
version: '3'
services:
  metadata:
    image: openiam/metadata:community-latest
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=community
      - DB_HOST=db
      - DB_PORT=5432
      - DB_NAME=openiam_metadata
      - DB_USER=metadata_user
      - DB_PASSWORD=metadata_pass
      - SERVER_PORT=8080
    depends_on:
      - db
  db:
    image: postgres:13
    environment:
      - POSTGRES_DB=openiam_metadata
      - POSTGRES_USER=metadata_user
      - POSTGRES_PASSWORD=metadata_pass
    volumes:
      - db-data:/var/lib/postgresql/data

volumes:
  db-data:

核心配置参数（环境变量）

数据持久化

元数据默认存储于外部数据库，需通过上述 DB_* 环境变量配置数据库连接。为避免数据丢失，建议：

• 使用持久化数据库（如独立部署的 PostgreSQL/MySQL）
• 定期备份数据库数据
• 生产环境中启用数据库主从复制

健康检查

服务启动后，可通过访问 http://<容器IP>:<PORT>/actuator/health 验证健康状态，返回 {"status":"UP"} 表示服务正常运行。