kubeshop/testkube-logs-sidecar

Testkube CLI Docker镜像文档

1. 镜像概述与主要用途

Testkube CLI Docker镜像是Testkube命令行工具（CLI）的容器化分发版本。Testkube是一款Kubernetes原生的测试编排与执行平台，旨在解耦测试流程与CI/CD/GitOps工具链，提供集中化平台用于大规模运行各类测试。该Docker镜像封装了Testkube CLI及其依赖环境，使用户可通过容器化方式便捷地与Testkube平台交互，无需在本地系统安装CLI，适用于自动化测试流程集成、跨环境测试管理等场景。

主要用途：

• 管理测试工作流定义与执行任务
• 触发测试执行（手动/CI/CD集成/定时任务）
• 收集与分析测试日志、报告及 artifacts
• 在Kubernetes环境中实现测试的规模化与分布式执行

2. 核心功能与特性

2.1 Testkube CLI核心功能

• 测试定义与编排：通过命令行创建测试工作流，集成现有测试工具（K6、Playwright、JMeter、Cypress等），支持多步骤测试套件编排。
• 多模式触发机制：支持CLI直接触发、CI/CD流水线集成、Kubernetes事件监听、定时任务及CRD定义等多种测试触发方式。
• Kubernetes原生扩展：利用Kubernetes的容器编排能力，实现测试执行的横向扩展，支持负载测试与功能测试的分布式运行。
• 全链路可观测性：收集测试工具产生的日志、视频、报告等 artifacts，通过CLI或UI便捷查看，加速故障定位。
• 测试洞察与报告：生成功能与操作层面的测试报告，提供执行趋势分析，优化测试策略与资源配置。

2.2 Docker镜像特性

• 容器化环境隔离：封装CLI及依赖组件，避免本地环境冲突，确保测试工具版本一致性。
• 跨平台兼容性：支持任何运行Docker的操作系统（Linux、macOS、Windows），无需针对架构单独配置。
• 轻量级部署：镜像体积优化，启动快速，适合集成至CI/CD流水线等资源敏感场景。
• 版本精确控制：通过镜像标签指定CLI版本，便于测试流程的版本管理与回溯。

3. 使用场景与适用范围

典型使用场景

• CI/CD流水线集成：在Jenkins、GitLab CI、GitHub Actions等流程中，通过容器运行CLI命令触发测试，实现构建-测试-部署自动化。
• 本地开发调试：开发人员无需本地安装CLI，通过Docker快速启动环境，验证测试配置与工作流定义。
• Kubernetes集群内测试：通过Kubernetes Job或CronJob运行CLI容器，实现集群内定时测试或事件驱动测试。
• 多环境标准化：在开发、测试、预生产环境中使用统一镜像版本，确保测试流程一致性。
• 临时测试任务：快速执行一次性测试命令，完成后自动清理容器，无系统残留依赖。

适用范围

• 需要集中管理多类型测试工具（功能/性能/负载测试）的团队
• 基于Kubernetes构建应用基础设施的组织
• 追求测试流程自动化与可观测性的DevOps/SRE团队
• 需要跨环境统一测试工具链的开发团队

4. 使用方法与配置说明

4.1 基础使用（docker run）

通过docker run命令直接执行Testkube CLI命令，基本格式：

bash
docker run --rm kubeshop/testkube-cli:latest [testkube-command] [options]

示例1：查看CLI版本信息

bash
docker run --rm kubeshop/testkube-cli:latest version

示例2：触发测试执行

假设已定义名为api-functional-test的测试，通过CLI触发执行：

bash
docker run --rm \
  -e TESTKUBE_API_SERVER=http://testkube-api-server:8088 \
  -e TESTKUBE_TOKEN=your-auth-token \
  kubeshop/testkube-cli:latest \
  test run api-functional-test

示例3：挂载本地配置文件

Testkube CLI默认使用~/.testkube/config.yaml存储配置（API地址、命名空间等）。挂载本地配置目录至容器，实现配置持久化：

bash
docker run --rm \
  -v ~/.testkube:/root/.testkube \
  kubeshop/testkube-cli:latest \
  test list

4.2 环境变量配置

通过环境变量配置CLI连接参数，常用变量如下：

4.3 CLI命令选项

CLI支持通过命令行选项覆盖默认配置，常用全局选项：

示例：指定命名空间与API地址执行命令

bash
docker run --rm \
  kubeshop/testkube-cli:latest \
  test get ui-e2e-test \
  --api-uri http://testkube-api:8088 \
  --namespace testkube-staging \
  --verbose

4.4 Docker Compose配置（本地开发环境）

针对本地开发环境，可通过docker-compose.yml配置持久化CLI环境，示例：

yaml
version: '3.8'

services:
  testkube-cli:
    image: kubeshop/testkube-cli:latest
    volumes:
      - ~/.testkube:/root/.testkube  # 挂载本地配置目录
      - ./test-scripts:/scripts      # 挂载测试脚本目录（可选）
    environment:
      - TESTKUBE_API_SERVER=http://testkube-api:8088  # 本地API服务地址
      - TESTKUBE_NAMESPACE=testkube
      - TESTKUBE_HTTP_TIMEOUT=60
    # 交互式终端配置（可选）
    stdin_open: true
    tty: true

启动并进入交互式终端：

bash
docker-compose run --rm testkube-cli sh

在容器内执行测试命令：

bash
testkube test run /scripts/load-test.js --type k6

5. 相关资源

• 官方文档：docs.testkube.io（含CLI命令参考、配置指南）
• GitHub仓库：https://github.com/kubeshop/testkube%EF%BC%88%E8%8E%B7%E5%8F%96%E9%95%9C%E5%83%8F%E6%A0%87%E7%AD%BE%E4%B8%8E%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97%EF%BC%89
• 社区支持：
  • Slack：Testkube Workspace
  • ***：@testkube_io
• CLI命令手册：Testkube CLI Reference