fydeinc/fyde-connector

Fyde Enterprise 用户目录连接器镜像文档

一、镜像概述

Fyde Enterprise 用户目录连接器（以下简称“连接器”）是一款用于身份数据同步的Docker镜像，主要功能为从多个身份数据源（如LDAP、Active Directory、云身份服务等）检索用户与组信息，并自动同步至Fyde Enterprise租户，实现企业身份数据的集中化管理与一致性维护。

二、核心功能与特性

2.1 多源数据集成

支持从多种主流身份数据源获取用户与组信息，包括但不限于：

• LDAP协议数据源（如OpenLDAP）
• Microsoft Active Directory
• Azure Active Directory
• Okta、Ping Identity等云身份服务
• 自定义REST API数据源（通过配置扩展）

2.2 全面同步能力

• 用户属性同步：支持同步用户基础属性（用户名、***、姓名等）及自定义属性（如部门、职位）
• 组同步：同步用户所属组及组层级关系，维持组结构一致性
• 增量同步：支持基于时间戳或变更日志的增量同步，减少资源消耗
• 全量同步：支持按需触发全量数据同步，用于初始化或数据修复场景

2.3 可靠性与可管理性

• 配置驱动：通过环境变量或配置文件灵活定义同步规则与数据源参数
• 日志与监控：输出标准化日志（JSON格式可选），支持集成至ELK、Prometheus等监控系统
• 错误重试：网络异常或数据源临时不可用时自动重试同步任务
• 数据过滤：支持通过规则过滤无需同步的用户/组（如基于OU、组属性等）

三、使用场景与适用范围

3.1 典型使用场景

• 企业身份集成：将现有身份系统（如Active Directory）与Fyde Enterprise租户打通，避免重复维护用户数据
• 多源身份统一：企业存在多个独立身份源（如本地AD+云端Azure AD）时，通过连接器聚合同步至Fyde平台
• 自动化用户生命周期管理：当用户在源系统中创建/更新/删除时，自动同步至Fyde Enterprise，减少人工操作
• 合规审计：通过同步日志追踪用户数据变更，满足企业合规性要求

3.2 适用范围

• 企业规模：中大型企业（用户数100+）
• 环境要求：已部署Fyde Enterprise租户，且需集成1个或多个外部身份数据源
• 技术场景：需自动化用户/组管理、跨系统身份一致性维护、减少手动操作错误的场景

四、使用方法与配置说明

4.1 前置条件

1. Fyde Enterprise租户：需拥有Fyde Enterprise租户管理员权限，获取租户API访问凭证（API URL、API密钥）
2. 数据源访问权限：需具备目标数据源的只读访问权限（如LDAP绑定账户、Azure AD应用权限等）
3. 网络环境：Docker容器需同时连通Fyde Enterprise API端点（通常为https://<tenant-id>.fyde.com/api）及目标数据源网络

4.2 安装与运行

4.2.1 获取镜像

从Docker Registry拉取镜像（假设镜像名为fyde/enterprise-user-directory-connector）：

bash
docker pull fyde/enterprise-user-directory-connector:latest

4.2.2 基本运行命令（Docker Run）

通过环境变量配置同步参数，基础示例：

bash
docker run -d \
  --name fyde-connector \
  -e FYDE_API_URL="https://your-tenant-id.fyde.com/api" \
  -e FYDE_API_KEY="your-fyde-api-key" \
  -e DATA_SOURCE_TYPE="ldap" \
  -e DATA_SOURCE_URL="ldap://ldap-server:389" \
  -e DATA_SOURCE_BASE_DN="dc=example,dc=com" \
  -e DATA_SOURCE_BIND_DN="cn=admin,dc=example,dc=com" \
  -e DATA_SOURCE_BIND_PASSWORD="ldap-admin-password" \
  -e SYNC_INTERVAL="3600" \  # 同步间隔（秒），默认3600秒（1小时）
  fyde/enterprise-user-directory-connector:latest

4.2.3 Docker Compose配置示例

创建docker-compose.yml实现持久化日志与配置管理：

yaml
version: '3.8'
services:
  fyde-connector:
    image: fyde/enterprise-user-directory-connector:latest
    container_name: fyde-connector
    restart: unless-stopped
    environment:
      - FYDE_API_URL="https://your-tenant-id.fyde.com/api"
      - FYDE_API_KEY="your-fyde-api-key"
      - DATA_SOURCE_TYPE="azuread"  # 示例：Azure AD数据源
      - DATA_SOURCE_TENANT_ID="your-azure-tenant-id"
      - DATA_SOURCE_CLIENT_ID="azure-ad-app-client-id"
      - DATA_SOURCE_CLIENT_SECRET="azure-ad-app-client-secret"
      - SYNC_INTERVAL="1800"  # 30分钟同步一次
      - LOG_LEVEL="info"  # 日志级别：debug/info/warn/error
    volumes:
      - ./logs:/app/logs  # 持久化日志
    networks:
      - identity-network  # 自定义网络确保与数据源连通

networks:
  identity-network:
    driver: bridge

4.3 配置参数详解

4.3.1 Fyde Enterprise 连接配置

4.3.2 数据源配置（以LDAP为例）

4.3.3 同步策略配置

4.4 日志与监控

容器日志默认输出至标准输出（stdout），包含同步状态、错误信息等，格式示例：

json
{"timestamp":"2024-05-20T10:30:00Z","level":"info","message":"Sync started","source":"ldap","tenant_id":"tenant-1234","sync_mode":"incremental"}

可通过LOG_LEVEL环境变量调整日志详细程度（debug/info/warn/error），并结合docker logs或日志收集工具（如Fluentd）进行监控。

五、注意事项

1. 安全性：API密钥、数据源凭据等敏感信息需通过环境变量或安全配置管理工具注入，避免硬编码在容器配置中。
2. 网络隔离：建议通过Docker网络策略限制容器网络访问范围，仅允许连接Fyde API与目标数据源。
3. 数据一致性：首次同步建议使用SYNC_MODE=full初始化数据，后续使用增量同步减少资源消耗。
4. 版本更新：定期拉取最新镜像以获取功能更新与安全补丁，可通过watchtower等工具实现自动更新。

六、参考文档

官方完整文档：CloudGen Access User Directory Connector