magentaaps/os2mo-os2sync-export

OS2MO to OS2SYNC Integration 镜像文档

镜像概述

本镜像提供OS2MO与OS2SYNC系统间的集成服务，旨在实现两个系统间的数据自动同步，确保用户信息、组织结构等关键数据在OS2MO与OS2SYNC之间保持一致，简化系统间数据流转流程，减少手动操作成本。

核心功能与特性

• 数据同步：支持OS2MO中的用户账户、组织架构、职位信息等核心数据向OS2SYNC系统同步
• 配置灵活：通过环境变量或配置文件自定义同步规则、频率及数据字段映射关系
• 错误处理：内置同步失败重试机制及异常捕获，保障数据同步可靠性
• 日志记录：提供详细的同步过程日志，支持多级别日志输出，便于问题排查
• 容器化部署：轻量级容器设计，支持快速集成至现有Docker或Kubernetes环境

使用场景与适用范围

适用于已部署OS2MO和OS2SYNC系统的组织，需在以下场景中保持数据一致性：

• 企业IT环境中管理员工信息并同步至目录服务
• ***机构或公共部门使用OS2MO进行组织管理，需同步数据至OS2SYNC服务
• 任何需要在OS2MO与OS2SYNC间实现用户、组织数据自动化流转的业务场景

使用方法与配置说明

基本使用（Docker Run）

通过以下命令快速启动集成服务：

bash
docker run -d \
  --name os2mo-os2sync-integration \
  -e OS2MO_URL="https://os2mo.example.com/api" \
  -e OS2SYNC_URL="https://os2sync.example.com/sync" \
  -e OS2MO_API_KEY="your-os2mo-api-key" \
  -e OS2SYNC_USER="sync-service-account" \
  -e OS2SYNC_PASSWORD="secure-password" \
  -e SYNC_INTERVAL="3600" \  # 同步间隔（秒）
  -e LOG_LEVEL="INFO" \  # 日志级别：DEBUG/INFO/WARNING/ERROR
  your-registry/os2mo-os2sync-integration:latest

Docker Compose 配置

创建docker-compose.yml文件实现持久化部署：

yaml
version: '3.8'
services:
  os2mo-os2sync-integration:
    image: docker.xuanyuan.run/your-registry/os2mo-os2sync-integration:latest
    container_name: os2mo-os2sync-integration
    environment:
      - OS2MO_URL=https://os2mo.example.com/api
      - OS2SYNC_URL=https://os2sync.example.com/sync
      - OS2MO_API_KEY=your-os2mo-api-key
      - OS2SYNC_USER=sync-service-account
      - OS2SYNC_PASSWORD=secure-password
      - SYNC_INTERVAL=3600
      - LOG_LEVEL=INFO
      - ERROR_RETRY_COUNT=3
    restart: unless-stopped
    volumes:
      - ./logs:/app/logs  # 挂载日志目录
      - ./config:/app/config  # 挂载配置文件目录（可选）

启动服务：

bash
docker-compose up -d

环境变量配置说明

高级配置（配置文件）

如需自定义数据映射规则，可创建config.yaml配置文件并挂载至容器/app/config/config.yaml：

yaml
sync:
  entities:
    - users
    - organizations
    - positions
  filters:
    users:
      active_only: true  # 仅同步活跃用户
  field_mappings:
    user:
      os2mo_email: os2sync_mail
      os2mo_username: os2sync_sAMAccountName

启动命令（挂载配置文件）：

bash
docker run -d \
  --name os2mo-os2sync-integration \
  -e OS2MO_URL="https://os2mo.example.com/api" \
  -e OS2MO_API_KEY="your-os2mo-api-key" \
  -e OS2SYNC_URL="https://os2sync.example.com/sync" \
  -e OS2SYNC_USER="sync-service-account" \
  -e OS2SYNC_PASSWORD="secure-password" \
  -v ./config.yaml:/app/config/config.yaml \
  docker.xuanyuan.run/your-registry/os2mo-os2sync-integration:latest

日志与监控

• 实时日志查看：docker logs -f os2mo-os2sync-integration
• 日志持久化：通过挂载/app/logs目录保存日志文件
• 监控指标：支持通过/metrics端点暴露同步成功率、同步时长等Prometheus指标（需设置ENABLE_METRICS=true）

注意事项

• 确保OS2MO与OS2SYNC服务网络互通，集成服务需有权限访问两者API端口
• 敏感信息（如API密钥、密码）建议通过环境变量注入或使用Docker Secrets管理
• 首次部署后应执行手动同步测试（docker exec -it os2mo-os2sync-integration ./sync-now）验证数据映射正确性