kubeshop/testkube-dashboard
:warning: The Open Source version of the Testkube Dashboard is being deprecated.
For further details and next steps, please refer to our official announcement.
Welcome to Testkube - Your friendly cloud-native testing framework for Kubernetes
Website | Documentation | *** | Slack | Blog
Dashboard to manage your Testkube cluster and monitor its real-time results.
The Dashboard is deployed as an application in the cluster. It runs in a browser, and it communicates with the Testkube API Server via Ingress Controller (either provided or bundled).
By default, Dashboard is installed in your cluster along with your Testkube system.
To use the bundled Dashboard, run testkube dashboard command with
Testkube CLI, to forward the UI and API ports from the Kubernetes
cluster.
:warning: Testkube Pro and Enterprise
This Dashboard works only for the Testkube Open Source installations. To manage the Testkube in Enterprise or Pro offering, use their corresponding dashboards:
- app.testkube.io for Testkube Pro
- Your Enterprise URL for Testkube Enterprise
:eight_spoked_asterisk: Disable bundling dashboard
To disable Dashboard installation with the Testkube system, you may use
testkube-dashboard.enabled=falsevalue in the Helm chart.
To run the Testkube Dashboard for development:
npm start commandbashgit clone ***:kubeshop/testkube-dashboard.git && cd testkube-dashboard npm install npm start
To learn more about the Testkube Dashboard development and architecture, see the Contribution manual.
:eight_spoked_asterisk: Environment variables
To configure your environment variables, either:
- create
.envfile in the repository, or- export the environment variables globally
You may use both build time and dynamic variables here.
Please note, that you may want to use Create React App's variables too, i.e.
BROWSER=noneto avoid opening the browser.
The Docker images for the Testkube Dashboard are deployed to the Docker Hub as kubeshop/testkube-dashboard.
To start Dashboard using Docker, run the image with the dynamic environment variables you would like to pass, i.e.:
bashdocker run --rm \ -p 8080:8080 \ -e REACT_APP_API_SERVER_ENDPOINT=[***] \ kubeshop/testkube-dashboard:latest
:warning: Environment variables
To override the build time environment variables too, you need to build the Docker image on your own.
All the Dashboard is configured with the environment variables.
Part of them is included directly in the production build, while the rest may be modified for the running application.
The latest variables are listed in env.ts file, but for simplicity we keep them documented below too.
:eight_spoked_asterisk: Deep-linking overrides
You may temporarily override the variables in the running application using the query string. The Dashboard seeks for query params starting with
~and try to override any matching known variable.The query param name should be a variable name, but for simplicity it may omit
REACT_APP_prefix and is case-insensitive. Short name from the tables above may be used.As an example, to change the API endpoint, you may use
https://demo.testkube.io?~api_server_endpoint=http://localhost:8088.
The build time environments are loaded from process.env during build time.
| Name | Short Name | Description |
|---|---|---|
REACT_APP_SENTRY_DSN | sentry_dsn | Sentry DSN for error reporting |
REACT_APP_GTM_ID | gtm_id | Google Tag Manager ID for telemetry |
REACT_APP_VERSION | version | Dashboard version used for reporting and displaying |
The dynamic variables are loaded from automatically generated env-config.js file.
| Name | Short Name | Description |
|---|---|---|
REACT_APP_API_SERVER_ENDPOINT | api_server_endpoint | URL for the Testkube API Server |
REACT_APP_DISABLE_TELEMETRY | disable_telemetry | Force disabling telemetry in the Dashboard |
REACT_APP_DEBUG_TELEMETRY | debug_telemetry | Display debugging information about telemetry in the console log |
REACT_APP_CRD_OPERATOR_REVISION | crd_operator_revision | testkube-operator's branch for getting the JSON Schema for CRDs |
REACT_APP_ROUTE_BASENAME | route_basename | Basename for the application. Use only when your Dashboard is accessible via different path than / |
To build the Docker image of Testkube Dashboard locally, simply build the Dockerfile, optionally with the environment variables from above.
bashdocker build \ --build-arg REACT_APP_API_SERVER_ENDPOINT=[***] \ -t kubeshop/testkube-dashboard:latest .
:eight_spoked_asterisk: Environment variables
When you are building images with
docker build, you may either both set the build time variables, and set defaults for the dynamic variables.
To learn more about the Testkube Dashboard development and architecture, see the Contribution manual.
To learn more about what custom events we expose to Google Tag Manager, see Telemetry document.
Unleash the power of cloud native testing in Kubernetes with Testkube.
探索更多轩辕镜像的使用方法,找到最适合您系统的配置方式
通过 Docker 登录认证访问私有仓库
在 Linux 系统配置镜像服务
在 Docker Desktop 配置镜像
Docker Compose 项目配置
Kubernetes 集群配置 Containerd
K3s 轻量级 Kubernetes 镜像加速
VS Code Dev Containers 配置
MacOS OrbStack 容器配置
在宝塔面板一键配置镜像
Synology 群晖 NAS 配置
飞牛 fnOS 系统配置镜像
极空间 NAS 系统配置服务
爱快 iKuai 路由系统配置
绿联 NAS 系统配置镜像
QNAP 威联通 NAS 配置
Podman 容器引擎配置
HPC 科学计算容器配置
ghcr、Quay、nvcr 等镜像仓库
无需登录使用专属域名
需要其他帮助?请查看我们的 常见问题Docker 镜像访问常见问题解答 或 提交工单
免费版仅支持 Docker Hub 访问,不承诺可用性和速度;专业版支持更多镜像源,保证可用性和稳定速度,提供优先客服响应。
专业版支持 docker.io、gcr.io、ghcr.io、registry.k8s.io、nvcr.io、quay.io、mcr.microsoft.com、docker.elastic.co 等;免费版仅支持 docker.io。
当返回 402 Payment Required 错误时,表示流量已耗尽,需要充值流量包以恢复服务。
通常由 Docker 版本过低导致,需要升级到 20.x 或更高版本以支持 V2 协议。
先检查 Docker 版本,版本过低则升级;版本正常则验证镜像信息是否正确。
使用 docker tag 命令为镜像打上新标签,去掉域名前缀,使镜像名称更简洁。
来自真实用户的反馈,见证轩辕镜像的优质服务