signadot/route-sidecar

Signadot Sandbox Routing Sidecar 镜像文档

镜像概述

Signadot Sandbox Routing Sidecar是一款轻量级边车容器，专为Signadot沙箱环境设计，核心功能是处理沙箱实例的请求路由与流量管理。作为Sidecar部署于微服务架构中，它能够识别并转发针对特定沙箱的请求，确保测试流量精准路由至目标沙箱实例，同时与生产流量隔离，保障测试环境的独立性与稳定性。

核心功能与特性

核心功能

• 沙箱请求路由：自动识别携带沙箱标识的请求，将其路由至对应沙箱实例
• 流量隔离：严格隔离沙箱测试流量与生产流量，避免测试干扰主环境
• Signadot平台集成：无缝对接Signadot沙箱管理平台，实时同步沙箱配置信息
• 动态配置更新：支持通过Signadot平台动态调整路由规则，无需重启容器

特性

• 轻量级设计：镜像体积小，资源占用低，适合作为Sidecar与业务服务共存
• 低延迟转发：优化的请求处理逻辑，确保路由转发延迟低于10ms
• 多协议支持：兼容HTTP/HTTPS协议，满足主流微服务通信需求
• 健康检查：内置健康检查接口，支持容器编排平台的存活探针配置

使用场景与适用范围

典型使用场景

• 微服务并行测试：多团队同时开发同一服务不同版本时，通过沙箱路由实现各自测试流量隔离
• CI/CD流程集成：在持续集成/部署流程中，为每个PR或构建版本自动创建沙箱并路由测试流量
• 预发布验证：新功能发布前，通过沙箱路由将验证流量定向至预发布版本，进行线上验证
• 故障注入测试：在沙箱环境中模拟故障场景时，确保故障流量仅影响目标沙箱

适用范围

• 基于Kubernetes或Docker Compose部署的微服务架构
• 使用Signadot平台管理沙箱环境的开发/测试团队
• 需要对测试流量进行精细化管理的DevOps流程
• 微服务数量≥3的中大型应用系统

使用方法与配置说明

Docker Run 部署示例

bash
docker run -d \
  --name signadot-routing-sidecar \
  -p 8080:8080 \
  -e SIGNADOT_API_KEY="your-signadot-api-key" \
  -e SANDBOX_NAME="dev-sandbox-01" \
  -e TARGET_SERVICE_PORT="8080" \
  -e LOG_LEVEL="info" \
  docker.xuanyuan.run/signadot/sandbox-routing-sidecar:latest

Docker Compose 配置示例

yaml
version: '3.8'
services:
  business-service:
    image: docker.xuanyuan.run/your-business-service:latest
    ports:
      - "8080:8080"
    depends_on:
      - routing-sidecar
  
  routing-sidecar:
    image: docker.xuanyuan.run/signadot/sandbox-routing-sidecar:latest
    environment:
      - SIGNADOT_API_KEY="your-signadot-api-key"
      - SANDBOX_NAME="dev-sandbox-01"
      - TARGET_SERVICE_HOST="business-service"
      - TARGET_SERVICE_PORT="8080"
      - ROUTING_TIMEOUT="5s"
      - LOG_LEVEL="debug"
    ports:
      - "8081:8080"  # 路由服务端口

环境变量配置说明

路由规则说明

Sidecar通过以下方式识别沙箱请求：

1. HTTP Header识别：携带Signadot-Sandbox头（值为沙箱名称）的请求将被路由至对应沙箱
2. Cookie识别：客户端Cookie中包含signadot-sandbox=<沙箱名称>时触发沙箱路由
3. 查询参数识别：URL中包含signadot_sandbox=<沙箱名称>查询参数时触发沙箱路由

未匹配沙箱标识的请求将默认路由至基础服务实例（如生产环境服务）。

集成与扩展

与Kubernetes集成

在Kubernetes环境中，建议通过Sidecar模式注入至业务Pod，示例Deployment配置片段：

yaml
spec:
  template:
    spec:
      containers:
      - name: business-service
        image: docker.xuanyuan.run/your-business-service:latest
      - name: routing-sidecar
        image: docker.xuanyuan.run/signadot/sandbox-routing-sidecar:latest
        env:
        - name: SIGNADOT_API_KEY
          valueFrom:
            secretKeyRef:
              name: signadot-secrets
              key: api-key
        - name: SANDBOX_NAME
          valueFrom:
            fieldRef:
              fieldPath: metadata.labels['signadot.com/sandbox']
        ports:
        - containerPort: 8080

健康检查

Sidecar提供HTTP健康检查接口，可配置Kubernetes存活探针：

yaml
livenessProbe:
  httpGet:
    path: /health
    port: 8080
  initialDelaySeconds: 5
  periodSeconds: 10