testkubeenterprise/testkube-enterprise-ui

Testkube Enterprise Dashboard 镜像文档

一、镜像概述和主要用途

Testkube Enterprise Dashboard 是 Testkube 企业版的官方可视化管理控制台，专为简化测试自动化工作流设计。该镜像提供直观的 Web 界面，用于监控、管理和分析 Testkube 测试资源（如测试套件、执行记录、环境配置等），支持企业级测试流程的可视化编排、结果追踪及团队协作，帮助用户高效掌控测试生命周期。

二、核心功能和特性

2.1 核心功能

• 测试资源统一管理：集中管理测试套件、测试执行、环境配置等 Testkube 核心资源，支持创建、编辑、删除及批量操作。
• 实时测试监控：可视化展示测试执行状态（运行中/成功/失败）、执行时长、资源占用等关键指标，支持实时日志查看。
• 测试结果分析：提供多维度测试报告（趋势分析、失败原因归类、历史对比），支持导出 PDF/CSV 格式报告。
• 企业级权限控制：集成 RBAC（基于角色的访问控制），支持多租户管理，可按团队/项目分配资源访问权限。
• 测试流程编排：通过拖拽式界面设计复杂测试工作流，支持定时执行、事件触发（如代码提交后）等自动化规则配置。

2.2 关键特性

• 轻量化部署：基于 Docker 容器化设计，支持单机快速启动或集群化部署，适配多种环境（物理机、云服务器、K8s）。
• 高兼容性：与 Testkube 开源版/企业版 API 完全兼容，支持对接外部工具（如 Jenkins、GitLab CI、Slack 等）。
• 数据持久化：支持测试数据、配置文件的持久化存储，确保重启后数据不丢失。
• 可扩展架构：预留插件接口，支持集成自定义测试报告模板、第三方监控工具（如 Prometheus、Grafana）。

三、使用场景和适用范围

3.1 适用场景

• 企业级测试团队协作：多团队共享测试资源，通过角色权限隔离数据，支持测试任务分配与进度跟踪。
• 持续测试流程可视化：在 CI/CD 流水线中嵌入 Dashboard，实时监控测试环节状态，快速定位流程瓶颈。
• 多环境测试管理：统一管理开发/测试/生产等多环境的测试配置，支持环境间配置同步与差异对比。
• 测试数据分析与优化：基于历史测试数据生成趋势报表，辅助团队识别高频失败用例、优化测试效率。

3.2 适用用户

• 采用 Testkube 进行测试自动化的企业用户。
• 需要可视化管理测试流程的 QA 团队、DevOps 团队。
• 追求测试结果可追溯性与团队协作效率的中大型研发组织。

四、使用方法和配置说明

4.1 前提条件

• 已安装 Docker Engine（20.10+）或 Docker Desktop。
• 已部署 Testkube 企业版集群（v1.10+），且 Dashboard 需能访问 Testkube API 服务（默认地址：http://testkube-api:8088）。
• 若启用持久化存储，需准备本地目录或外部存储卷（如 NFS、PVC）。

五、部署方案示例

5.1 基于 docker run 快速部署

通过以下命令启动 Dashboard 容器，映射端口并配置必要环境变量：

bash
docker run -d \
  --name testkube-enterprise-dashboard \
  -p 8080:8080 \  # 主机端口:容器端口（默认容器内端口 8080）
  -e PORT=8080 \  # 容器内服务端口（默认 8080，与 -p 映射保持一致）
  -e TESTKUBE_API_URL="http://testkube-api:8088" \  # Testkube API 服务地址（必填）
  -e AUTH_ENABLED=true \  # 是否启用认证（企业版默认 true）
  -e AUTH_JWT_SECRET="your-jwt-secret" \  # JWT 密钥（企业版需与 API 服务一致）
  -v /host/path/to/data:/app/data \  # 持久化存储测试数据（可选，默认内存存储）
  testkube/enterprise-dashboard:latest

5.2 基于 docker-compose 部署

创建 docker-compose.yml 文件，定义 Dashboard 服务及依赖（如 Testkube API 代理，可选）：

yaml
version: '3.8'

services:
  testkube-dashboard:
    image: testkube/enterprise-dashboard:latest
    container_name: testkube-enterprise-dashboard
    restart: always
    ports:
      - "8080:8080"  # 对外暴露 Web 访问端口
    environment:
      - PORT=8080
      - TESTKUBE_API_URL="http://testkube-api:8088"  # 替换为实际 Testkube API 地址
      - AUTH_ENABLED=true
      - AUTH_JWT_SECRET="your-jwt-secret"  # 与 Testkube API 服务的 JWT 密钥一致
      - LOG_LEVEL=info  # 日志级别：debug/info/warn/error（默认 info）
      - THEME=dark  # 界面主题：light/dark（默认 light）
    volumes:
      - dashboard-data:/app/data  # 持久化存储测试报告、配置等数据
    networks:
      - testkube-network  # 接入 Testkube 集群网络（确保与 API 服务通信）

volumes:
  dashboard-data:  # 声明命名卷，数据持久化

networks:
  testkube-network:  # 与 Testkube 集群共享网络（需提前创建：docker network create testkube-network）
    external: true

启动服务：

bash
docker-compose up -d

六、配置参数说明

6.1 环境变量配置

6.2 卷挂载配置

6.3 网络配置

• 通信要求：容器需与 Testkube API 服务网络互通（可通过 --network 参数接入集群网络，或配置 TESTKUBE_API_URL 为可访问的公网地址）。
• 端口映射：通过 -p hostPort:containerPort 映射宿主机端口（如 8080:8080），确保外部可访问 Web 界面。

七、访问与验证

部署完成后，通过浏览器访问 http://<宿主机IP>:<映射端口>（如 http://localhost:8080），输入 Testkube 企业版账号密码（默认管理员账号：admin@testkube.io，密码：admin123，首次登录需修改），即可进入 Dashboard 控制台。

八、数据持久化与备份

为避免容器重启导致数据丢失，建议通过卷挂载持久化 /app/data 目录。备份数据可直接打包卷目录：

bash
# 备份 dashboard-data 卷数据（假设卷挂载路径为 /var/lib/docker/volumes/dashboard-data/_data）
tar -czf dashboard-backup-$(date +%F).tar.gz /var/lib/docker/volumes/dashboard-data/_data