digicatapult/sqnc-identity-service

Sequence身份管理NodeJS API服务镜像

镜像概述

本镜像提供基于NodeJS构建的身份管理API服务，专为Sequence系统设计，用于处理用户身份相关的核心操作，包括身份验证、授权管理、用户信息维护等功能。服务遵循RESTful API规范，可无缝集成到Sequence微服务架构中，也可作为独立身份服务部署。

核心功能和特性

核心功能

• 用户身份验证（支持JWT、OAuth2.0等认证机制）
• 用户信息CRUD操作（创建、查询、更新、删除用户数据）
• 权限管理（基于角色的访问控制RBAC）
• 身份凭证管理（密码重置、令牌刷新）
• 审计日志（记录身份相关操作日志）

主要特性

• 轻量级架构，基于NodeJS异步I/O模型，支持高并发请求
• 可配置化认证策略，支持多租户场景
• 内置数据校验和安全防护（防SQL注入、XSS***）
• 健康检查接口，便于容器编排平台监控
• 支持Docker Compose、Kubernetes等容器编排工具

使用场景和适用范围

适用场景

• Sequence系统微服务架构中的身份服务组件
• 需要独立身份管理API的企业级应用
• 快速搭建用户认证基础设施的开发/测试环境
• 多系统集成时的统一身份认证网关

适用范围

• 开发环境：本地功能验证、API调试
• 测试环境：自动化测试、性能测试
• 生产环境：企业级应用身份管理服务，支持日均百万级请求

使用方法和配置说明

快速启动

使用docker run命令直接启动服务：

bash
docker run -d \
  --name sequence-identity-api \
  -p 3000:3000 \
  -e NODE_ENV=production \
  -e DB_HOST=mysql-host \
  -e DB_PORT=3306 \
  -e DB_USER=identity_user \
  -e DB_PASSWORD=secure_password \
  -e JWT_SECRET=your_jwt_signing_key \
  sequence/identity-api:latest

Docker Compose配置

以下是与MySQL数据库联动的docker-compose.yml示例：

yaml
version: '3.8'
services:
  identity-api:
    image: sequence/identity-api:latest
    ports:
      - "3000:3000"
    environment:
      - NODE_ENV=production
      - PORT=3000
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_USER=root
      - DB_PASSWORD=root_password
      - DB_NAME=sequence_identity
      - JWT_SECRET=your_jwt_signing_key
      - JWT_EXPIRES_IN=8h
      - LOG_LEVEL=info
    depends_on:
      - mysql
    restart: unless-stopped

  mysql:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=root_password
      - MYSQL_DATABASE=sequence_identity
    volumes:
      - mysql-data:/var/lib/mysql
    ports:
      - "3306:3306"

volumes:
  mysql-data:

环境变量配置

持久化配置

如需持久化日志或配置文件，可通过挂载卷实现：

bash
docker run -d \
  --name sequence-identity-api \
  -p 3000:3000 \
  -v ./logs:/app/logs \
  -v ./config:/app/config \
  -e NODE_ENV=production \
  -e DB_HOST=mysql-host \
  -e DB_USER=identity_user \
  -e DB_PASSWORD=secure_password \
  -e JWT_SECRET=your_jwt_signing_key \
  sequence/identity-api:latest

健康检查

服务内置健康检查接口，可通过GET /health端点获取状态：

bash
curl http://localhost:3000/health
# 预期响应：{"status":"ok","timestamp":"2024-05-20T10:30:00Z","version":"1.2.0"}

API文档

服务启动后，可通过访问http://localhost:3000/api-docs查看Swagger API文档，包含所有可用接口的详细说明和请求示例。