elixircloud/protes

GA4GH TES 中间件注入代理服务

镜像概述和主要用途

该Docker镜像提供一个代理服务，专门用于在GA4GH TES（Task Execution Service）请求处理流程中注入中间件。GA4GH TES是一个标准化的任务执行服务接口，广泛应用于生物信息学等领域的分布式任务调度。本代理服务作为请求拦截层，允许用户通过中间件对TES请求/响应进行定制化处理，从而扩展或增强TES服务的功能，而无需修改底层TES服务实现。

核心功能和特性

核心功能

• 中间件注入：支持在TES请求生命周期的不同阶段（如请求接收、转发前、响应返回前）注入自定义中间件
• 请求转发：将处理后的请求透明转发至目标GA4GH TES服务，并将响应返回给客户端
• 兼容性：完全兼容GA4GH TES API规范（v1.0及以上版本）
• 请求/响应处理：支持对TES请求参数、响应数据进行修改、过滤或增强

主要特性

• 可配置中间件链：支持通过配置文件定义中间件执行顺序和参数
• 轻量级设计：基于高效代理框架构建，资源占用低，性能损耗小
• 灵活集成：可与任何符合GA4GH TES标准的服务端配合使用
• 无状态架构：支持水平扩展，适合分布式部署环境

使用场景和适用范围

典型使用场景

• 请求增强：在TES任务提交请求中自动添加元数据（如用户ID、项目标签）
• 访问控制：注入身份验证/授权中间件，验证请求者权限
• 日志与监控：添加请求日志、性能指标采集中间件，用于审计和监控
• 请求转换：将非标准请求格式转换为GA4GH TES标准格式
• 错误处理：自定义错误响应或重试逻辑

适用范围

• 生物信息学平台中基于GA4GH TES构建的任务执行系统
• 需要对TES请求进行定制化处理的科研或企业级应用
• TES服务提供商需要快速扩展功能而不修改核心代码的场景
• 多团队共享TES服务时的请求隔离与定制需求

使用方法和配置说明

前置条件

• 已部署的GA4GH TES服务实例（作为代理目标）
• Docker环境（19.03+版本）或Docker Compose环境

Docker部署示例

基础运行命令

bash
docker run -d \
  -p 8080:8080 \
  -e TARGET_TES_URL="http://tes-service:8000" \
  -v ./middleware-config.yaml:/app/config/middleware.yaml \
  --name tes-proxy \
  [镜像名称]:[标签]

Docker Compose配置示例

yaml
version: '3.8'
services:
  tes-proxy:
    image: [镜像名称]:[标签]
    ports:
      - "8080:8080"
    environment:
      - TARGET_TES_URL=http://tes-service:8000  # 目标GA4GH TES服务地址
      - LISTEN_PORT=8080                       # 代理服务监听端口
      - LOG_LEVEL=info                         # 日志级别：debug, info, warn, error
    volumes:
      - ./middleware-config.yaml:/app/config/middleware.yaml  # 中间件配置文件挂载
    depends_on:
      - tes-service  # 依赖的目标TES服务
  tes-service:
    image: [tes-service-image]:[tag]  # 目标GA4GH TES服务镜像
    # 目标TES服务的其他配置...

配置参数说明

环境变量

中间件配置文件格式（YAML）

配置文件定义中间件链及其参数，示例：

yaml
middleware:
  - name: "logging"          # 日志中间件
    config:
      log_request_body: true
      log_response_body: false
  - name: "auth"             # 身份验证中间件
    config:
      jwt_secret: "your-secret-key"
      required_claims: ["scope:tes:write"]
  - name: "metadata-inject"  # 元数据注入中间件
    config:
      inject_fields:
        - key: "x-project-id"
          value: "default-project"
        - key: "x-user-id"
          from_header: "X-Forwarded-User"  # 从请求头获取值

工作流程

1. 客户端向代理服务发送GA4GH TES请求（如任务创建、状态查询）
2. 代理服务按配置的中间件链顺序处理请求
3. 处理后的请求转发至TARGET_TES_URL指定的目标TES服务
4. 目标TES服务返回响应
5. 代理服务（可选）通过中间件处理响应
6. 最终响应返回给客户端

注意事项

• 确保中间件配置与目标TES服务的API版本兼容
• 复杂中间件可能增加请求处理延迟，建议在性能测试后部署到生产环境
• 敏感配置（如密钥）建议通过环境变量或安全的配置管理工具注入，避免硬编码在配置文件中