grafana/xk6 Docker镜像文档

镜像概述和主要用途

grafana/xk6 是 xk6 的官方Docker镜像。xk6 是一款命令行工具，用于构建包含自定义扩展的 k6 二进制文件。该镜像允许用户直接使用 xk6 功能，无需在本地配置 Go 开发环境。

核心功能和特性

• 无需本地 Go 环境：通过容器化方式运行 xk6，避免本地 Go 开发环境的配置开销。
• 支持核心 xk6 命令：包括 build（构建自定义二进制文件）、run（执行测试）、new（初始化扩展项目）等。
• 跨平台构建：可针对 Linux、macOS、Windows 等不同目标操作系统生成二进制文件。
• 多架构支持：提供 linux/amd64（x86 系统）和 linux/arm64（ARM 系统，如 Apple Silicon）架构的镜像。
• 灵活的标签策略：支持特定版本、次要版本系列、主要版本系列及最新稳定版等多种标签格式。

使用场景和适用范围

适用于需要构建包含自定义扩展的 k6 二进制文件，且希望避免配置本地 Go 开发环境的开发者。典型使用场景包括：

• 为性能测试构建集成特定扩展（如 xk6-faker）的 k6 工具。
• 快速原型化和开发 k6 扩展项目。
• 跨平台分发自定义 k6 二进制文件（如同时支持 Linux 和 Windows 环境）。

使用方法和配置说明

基本使用方式

使用该镜像时，需将当前工作目录挂载到容器内的 /xk6 目录，以便输出构建结果。如需指定目标操作系统，可通过 --os 标志（或 GOOS 环境变量）设置。

核心命令为 xk6 build（构建自定义二进制文件），此外还支持 xk6 run（运行测试）、xk6 new（初始化扩展项目）等命令。

平台-specific 示例

以下示例均构建包含 xk6-faker 扩展的 k6 二进制文件，并输出到当前工作目录。

Linux

默认构建目标为 Linux，直接执行：

docker run --rm -it -u "$(id -u):$(id -g)" -v "$(pwd):/xk6" \
  grafana/xk6 build --with github.com/grafana/xk6-faker

参数说明：

• -u "$(id -u):$(id -g)"：指定当前用户ID和组ID，避免文件权限问题。
• -v "$(pwd):/xk6"：挂载当前工作目录到容器内 /xk6。
• --with：指定要集成的扩展（此处为 xk6-faker）。

macOS

通过 --os darwin 标志指定目标为 macOS：

docker run --rm -it -u "$(id -u):$(id -g)" -v "$(pwd):/xk6" \
  grafana/xk6 build --os darwin --with github.com/grafana/xk6-faker

Windows (PowerShell)

通过 --os windows 标志指定目标为 Windows，使用 PowerShell 时：

docker run --rm -it -v "${pwd}:/xk6" \
  grafana/xk6 build --os windows --with github.com/grafana/xk6-faker

Windows (命令提示符)

使用 Windows 命令提示符时：

docker run --rm -it -v "%cd%:/xk6" \
  grafana/xk6 build --os windows --with github.com/grafana/xk6-faker

支持的标签

该镜像基于官方 golang 镜像构建，提供以下标签格式以满足不同需求：

多架构支持

grafana/xk6 是多架构镜像，支持以下架构：

• linux/amd64：适用于 x86 架构的 Linux 系统。
• linux/arm64：适用于 ARM 架构的 Linux 系统（如 Apple Silicon Mac）。

自动架构选择

拉取标准标签（如 grafana/xk6:latest）时，Docker 会根据宿主机架构自动选择匹配的镜像。

显式指定架构

如需手动指定架构，可在标签后添加架构后缀，格式为 <标签>-<架构>：

• v1.1.0-amd64（x86 架构）
• latest-arm64（ARM 架构）

更多信息

如需高级用法、完整文档或 xk6 详细说明，请访问官方 grafana/xk6 GitHub 仓库。