testkubeenterprise/testkube-enterprise-api

Testkube Enterprise API Docker镜像文档

1. 镜像概述和主要用途

Testkube Enterprise API 镜像提供 Testkube 企业版的核心 API 服务，作为企业级测试自动化平台的控制中心。该镜像封装了用于管理测试资源、执行测试工作流、集成外部系统及提供数据分析的 RESTful API 服务，支持企业级测试生命周期管理、多团队协作及复杂测试场景的自动化需求。

2. 核心功能和特性

2.1 测试生命周期管理

• 全面支持测试用例、测试套件、测试环境的创建、更新、删除及查询
• 自动化测试执行调度，支持定时任务、事件触发（如代码提交）及手动触发
• 测试结果持久化存储与多维度分析（通过率、执行时间、失败原因分类）

2.2 企业级架构支持

• 多租户隔离：基于命名空间或租户ID实现资源隔离，支持独立配置与权限控制
• 高可用性设计：无状态服务架构，支持水平扩展以应对高并发测试请求
• 分布式执行：支持跨集群测试任务分发，适配混合云/多云环境

2.3 高级安全特性

• 基于 RBAC 的细粒度权限控制，支持用户/团队/角色三级权限模型
• 敏感信息加密：测试配置中的密钥（如 API 令牌、数据库凭证）自动加密存储
• 审计日志：记录所有 API 操作（创建/修改/删除资源、执行测试），支持合规审计

2.4 集成与扩展能力

• 原生支持 CI/CD 工具链集成（Jenkins、GitLab CI、GitHub Actions、ArgoCD）
• 监控与告警：暴露 Prometheus 指标（API 响应时间、测试执行队列长度、失败率），支持 Grafana 可视化
• 外部系统对接：提供 Webhook 通知（测试完成、失败告警）及自定义插件接口（如第三方测试报告系统）

3. 使用场景和适用范围

3.1 企业级测试自动化平台

适用于需要统一管理多团队测试资源的大型企业，支持 Web 应用、API、数据库、Kubernetes 等多类型测试场景的自动化执行与结果跟踪。

3.2 复杂测试工作流管理

满足包含前置条件校验（如环境就绪性检查）、多阶段测试（单元测试→集成测试→E2E测试）、依赖任务（如测试失败后自动回滚环境）的复杂工作流编排需求。

3.3 多团队协作测试

支持跨团队共享测试资源（如公共测试环境），同时通过租户隔离保护敏感数据，适配大型研发组织内多团队并行测试的协作模式。

3.4 合规与审计需求

针对***、***等强合规行业，提供测试过程全链路审计日志、测试结果不可篡改存储及合规报告生成能力，满足 SOX、HIPAA 等合规要求。

4. 使用方法和配置说明

4.1 前提条件

• 运行环境：Docker Engine 20.10+ 或 Kubernetes 1.21+ 集群
• 依赖服务：
  • 关系型数据库（PostgreSQL 13+，用于存储测试元数据与结果）
  • 缓存服务（Redis 6+，用于任务队列与会话管理）
• 授权：Testkube Enterprise 有效 License 密钥（联系 Testkube 官方获取）

4.2 基本使用方法

4.2.1 Docker 容器部署

通过 docker run 直接启动 API 服务（单节点模式，适用于测试环境）：

bash
docker run -d \
  --name testkube-enterprise-api \
  -p 8080:8080 \  # API 服务端口
  -p 9090:9090 \  # 监控指标端口
  -e API_PORT=8080 \
  -e METRICS_PORT=9090 \
  -e DB_HOST=postgres-host \
  -e DB_PORT=5432 \
  -e DB_USER=testkube \
  -e DB_PASSWORD=secure-password \
  -e DB_NAME=testkube_enterprise \
  -e REDIS_HOST=redis-host \
  -e REDIS_PORT=6379 \
  -e LICENSE_KEY=your-enterprise-license-key \
  -e LOG_LEVEL=info \
  testkube/enterprise-api:latest

4.2.2 Docker Compose 部署

适用于本地开发或小规模测试环境，集成依赖服务（PostgreSQL、Redis）：

yaml
# docker-compose.yml
version: "3.8"

services:
  api:
    image: testkube/enterprise-api:latest
    ports:
      - "8080:8080"
      - "9090:9090"
    environment:
      - API_PORT=8080
      - METRICS_PORT=9090
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_USER=testkube
      - DB_PASSWORD=testkube-pass
      - DB_NAME=testkube_enterprise
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      - REDIS_DB=0
      - LICENSE_KEY=${LICENSE_KEY}
      - LOG_LEVEL=info
      - CORS_ALLOWED_ORIGINS=https://testkube-ui.example.com
    depends_on:
      - postgres
      - redis

  postgres:
    image: postgres:14-alpine
    environment:
      - POSTGRES_USER=testkube
      - POSTGRES_PASSWORD=testkube-pass
      - POSTGRES_DB=testkube_enterprise
    volumes:
      - postgres-data:/var/lib/postgresql/data

  redis:
    image: redis:7-alpine
    volumes:
      - redis-data:/data

volumes:
  postgres-data:
  redis-data:

启动命令：

bash
LICENSE_KEY=your-license-key docker-compose up -d

4.3 配置参数说明

4.3.1 核心服务配置

4.3.2 数据库配置（PostgreSQL）

4.3.3 缓存与任务队列配置（Redis）

4.3.4 安全配置

5. 典型部署方案

5.1 企业生产环境部署（Kubernetes + Helm）

Testkube Enterprise 推荐在 Kubernetes 集群通过 Helm Chart 部署，API 服务以 Deployment 形式运行，配合 Service、Ingress 及配置 ConfigMap/Secret 管理：

yaml
# 示例 Helm values.yaml 片段（API 服务配置）
api:
  replicaCount: 3  # 多副本保证高可用
  image:
    repository: testkube/enterprise-api
    tag: 1.14.0
  env:
    LICENSE_KEY: "${ENTERPRISE_LICENSE}"
    DB_HOST: "postgres-service.testkube.svc.cluster.local"
    DB_USER: "${DB_USER}"
    DB_PASSWORD: "${DB_PASSWORD}"
    REDIS_HOST: "redis-service.testkube.svc.cluster.local"
    TENANT_MODE: "namespace"  # 按 Kubernetes 命名空间隔离租户
    RBAC_ENABLED: "true"
  resources:
    requests:
      cpu: 500m
      memory: 1Gi
    limits:
      cpu: 1000m
      memory: 2Gi
  service:
    type: ClusterIP
    port: 8080
  ingress:
    enabled: true
    hosts:
      - host: api.testkube.example.com
        paths:
          - path: /
            pathType: Prefix

5.2 本地开发/测试部署（Docker Compose）

使用 4.2.2 节的 docker-compose.yml 配置，配合 .env 文件管理敏感信息：

ini
# .env 文件
LICENSE_KEY=tk-enterprise-xxxx-xxxx-xxxx
DB_USER=dev-user
DB_PASSWORD=dev-pass
JWT_SECRET=dev-only-jwt-secret-key

启动后通过 http://localhost:8080/health 验证服务状态，通过 http://localhost:8080/swagger 访问 API 文档（Swagger UI）。