Testkube

https://docs.testkube.io/
Admin
Testkube is the open testing platform for AI-driven engineering teams. It provides a single platform...
Tokens:894,289
Snippets:7,473
Trust Score:8.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Initialize Testkube Demo

Source: https://docs.testkube.io/articles/tutorial/quickstart/individual-evaluation

Start the Testkube installer for a demo environment.

```bash
testkube init demo
```

--------------------------------

### SuperAgent Helm Install Command Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Command to install or upgrade the Testkube agent using Helm.

```bash
helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.example.com:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube
```

--------------------------------

### Install Testkube with composable flags

Source: https://docs.testkube.io/articles/install/deploy-on-aws-eks

Examples of using the install.sh script with different configuration flags for production environments.

```bash
./install.sh --with-pod-identity --production
./install.sh --with-s3 --with-alb --production
```

--------------------------------

### SuperAgent Connect Command Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Command to connect an existing Testkube OSS installation to Testkube Pro.

```bash
testkube pro connect --agent-key tkcagnt_111
```

--------------------------------

### Helm Install with Environment Variables

Source: https://docs.testkube.io/articles/artifacts

Example command to set storage environment variables during Helm installation.

```bash
helm install testkube oci://us-east1-docker.pkg.dev/testkube-cloud-372110/testkube/testkube --version <version> --set STORAGE_ENDPOINT=custom_value --create-namespace --namespace testkube
```

--------------------------------

### Workflow Template Execution Order Example

Source: https://docs.testkube.io/articles/test-workflow-templates

Demonstrates how setup, steps, and after blocks are merged from templates into a workflow, resulting in a specific execution sequence.

```yaml
# my-template-a  

spec:  

  steps:  

    - shell: echo a1  

  after:  

    - shell: echo a2  

  

# my-template-b  

spec:  

  setup:  

    - shell: echo b1  

  steps:  

    - shell: echo b2  

  after:  

    - shell: echo b3  

  

# my-workflow-w  

spec:  

  use:  

    - name: my-template-a  

    - name: my-template-b  

  setup:  

    - shell: echo w1  

  steps:  

    - shell: echo w2  

  

# Merged workflow  

spec:  

  setup:  

    - shell: echo b1  

    - shell: echo w1  

  steps:  

    - shell: echo a1  

    - shell: echo b2  

    - shell: echo w2  

  after:  

    - shell: echo b3  

    - shell: echo a2
```

--------------------------------

### Repackage testkube-tw-toolkit with additional dependencies

Source: https://docs.testkube.io/articles/repackaging-testkube

An advanced Dockerfile example that installs system packages and copies toolkit binaries into a Red Hat UBI base image.

```dockerfile
ARG TESTKUBE_VERSION=2.1.99  

ARG UBI_VERSION=9  

  

# For reference, Testkube Dockerfiles can be found here:  

# https://github.com/kubeshop/testkube/tree/main/build/new  

FROM kubeshop/testkube-tw-toolkit:${TESTKUBE_VERSION} as testkube  

  

FROM registry.access.redhat.com/ubi${UBI_VERSION}/ubi  

  

# Install necessary packages  

RUN dnf install -y ca-certificates openssl git openssh-clients && \

    dnf clean all  

  

# Create a non-root user  

RUN useradd --home / --no-create-home --uid 1001 default  

USER 1001  

  

COPY --from=testkube /.tktw-bin /.tktw-bin  

COPY --from=testkube /toolkit /toolkit  

COPY --from=testkube /init /init  

  

ENTRYPOINT ["/toolkit"]
```

--------------------------------

### Install and Run Workflow

Source: https://docs.testkube.io/articles/examples/marketplace

Install and execute a workflow in one command, with options for unattended execution and log streaming.

```bash
# Install and run unattended (suitable for CI)

testkube marketplace install redis-connectivity --run=true

# Install only, do not prompt or run

testkube marketplace install redis-connectivity --run=false

# Install, run, and follow the execution (logs stream until completion;
# exit code matches the workflow's result)

testkube marketplace install redis-connectivity -f
```

--------------------------------

### testkube get synopsis

Source: https://docs.testkube.io/cli/testkube-get

The basic syntax for the get command.

```bash
testkube get <resourceName> [flags]
```

--------------------------------

### testkube install command syntax

Source: https://docs.testkube.io/cli/testkube-install

The basic syntax for the testkube install command.

```bash
testkube install [flags]
```

--------------------------------

### testkube marketplace install command syntax

Source: https://docs.testkube.io/cli/testkube-marketplace-install

The basic syntax for installing a TestWorkflow from the marketplace.

```bash
testkube marketplace install <name> [flags]
```

--------------------------------

### Claude Desktop Usage Examples

Source: https://docs.testkube.io/articles/mcp-configuration

Example prompts for interacting with Testkube resources through Claude Desktop.

```text
Can you show me all my test workflows and their recent execution status?

I need to create a new workflow for testing my Python application.
Can you help me set this up?
```

--------------------------------

### Install Testkube CLI on Ubuntu with APT

Source: https://docs.testkube.io/articles/install/cli

Configure the repository and install the Testkube CLI using the APT package manager.

```bash
sudo apt-get update && sudo apt-get install -y gnupg wget

sudo install -m 0755 -d /etc/apt/keyrings

wget -qO- https://repo.testkube.io/key.pub | sudo gpg --dearmor -o /etc/apt/keyrings/testkube.gpg

echo "deb [signed-by=/etc/apt/keyrings/testkube.gpg] https://repo.testkube.io/linux linux main" | sudo tee /etc/apt/sources.list.d/testkube.list

sudo apt-get update

sudo apt-get install -y testkube
```

--------------------------------

### testkube install runner options

Source: https://docs.testkube.io/cli/testkube-install-runner

Available flags for configuring the runner installation.

```bash
      --create                        auto create that agent  

      --dry-run                       display helm commands only  

  -e, --env strings                   (with --create) environment ID or slug that the agent have access to  

  -N, --execution-namespace string    namespace to run executions (defaults to installation namespace)  

      --floating                      (with --create) create as a floating agent  

      --global                        make it global agent  

  -g, --global-template-path string   include global template  

      --group string                  make it grouped agent  

  -h, --help                          help for runner  

  -l, --label strings                 (with --create) label key value pair: --label key1=value1  

  -n, --namespace string              namespace to install the agent  

  -s, --secret string                 secret key for the selected agent  

      --version string                agent version to use (defaults to latest)
```

--------------------------------

### ResourceRequest Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example values for CPU and memory resource requests.

```yaml
cpu:
  description: requested cpu units
  type: string
  example: 250m
memory:
  description: requested memory units
  type: string
  example: 64Mi
```

--------------------------------

### Diagnostics install options

Source: https://docs.testkube.io/cli/testkube-diagnostics-install

Available flags for the install command.

```bash
  -h, --help   help for install
```

--------------------------------

### Install kind on Windows

Source: https://docs.testkube.io/articles/install/quickstart-no-k8s

Use Chocolatey to install the kind CLI tool on Windows.

```bash
choco install kind
```

--------------------------------

### Template Configuration Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example configuration for a Testkube template, including name, namespace, body, and labels.

```json
{
  "name": "webhook-template",
  "namespace": "testkube",
  "body": "{\"id\": \"{{ .Id }}\"}",
  "labels": {
    "app": "backend",
    "env": "prod"
  }
}
```

--------------------------------

### Install Testkube Runner

Source: https://docs.testkube.io/articles/tutorial/quickstart

Use this command to install a Testkube Runner after initializing the control plane.

```bash
testkube install runner
```

--------------------------------

### Test Resource Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example configuration for a Test resource, including name, namespace, description, and type.

```json
{
  "name": "test1",
  "namespace": "testkube",
  "description": "this test is used for that purpose",
  "type": "postman/collection"
}
```

--------------------------------

### Run testkube diagnostics install

Source: https://docs.testkube.io/cli/testkube-diagnostics-install

Basic usage of the diagnostics install command.

```bash
testkube diagnostics install [flags]
```

--------------------------------

### testkube install agent command options

Source: https://docs.testkube.io/cli/testkube-install-agent

Available flags for configuring the agent installation.

```bash
      --create                        auto create that agent  

      --dry-run                       display helm commands only  

  -e, --env strings                   (with --create) environment ID or slug that the agent have access to  

  -N, --execution-namespace string    namespace to run executions (defaults to installation namespace)  

      --floating                      (with --create) create as a floating agent  

      --gitops                        enable gitops capability  

      --global                        make it global agent  

  -g, --global-template-path string   include global template  

      --group string                  make it grouped agent  

  -h, --help                          help for agent  

  -l, --label strings                 (with --create) label key value pair: --label key1=value1  

      --listener                      enable listener component (default: enabled when no component flags are set)  

  -n, --namespace string              namespace to install the agent  

      --runner                        enable runner component (default: enabled when no component flags are set)  

  -s, --secret string                 secret key for the selected agent  

      --version string                agent version to use (defaults to latest)  

      --webhooks                      enable webhooks capability
```

--------------------------------

### Install Testkube Runner via Helm

Source: https://docs.testkube.io/articles/multi-agent-runner-helm-chart

Use this command to install the Helm Chart from the OCI Registry.

```bash
helm upgrade --install \
  --create-namespace \
  --namespace my-runner \
  --set 'runner.id=<your:tkcrun_:runner_id>' \
  --set 'runner.orgId=<your:tkcorg_:organization_id>' \
  --set 'runner.envId=<your:tkcenv_:environment_id>' \
  --set 'runner.secret=<your:tkckey_agent_:key>' \
  --set 'cloud.url=agent.testkube.io:443' \
  my-runner oci://us-east1-docker.pkg.dev/testkube-cloud-372110/testkube/testkube-runner --version <version>
```

--------------------------------

### Cursor Usage Examples

Source: https://docs.testkube.io/articles/mcp-configuration

Example prompts for interacting with Testkube through Cursor's AI assistant.

```text
Create a test workflow that checks my REST API endpoints, then run it and show me the results.
```

```text
Look at my recent test failures and help me understand what's causing them. Check the logs and artifacts.
```

--------------------------------

### Install Testkube Runner

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Command to install a Testkube runner using Helm with registration tokens.

```bash
helm install --create-namespace runner testkube/testkube-runner --set runner.register.token=<runner-token> --set runner.orgId=<org-id> --namespace testkube
```

--------------------------------

### Install usage export Helm chart

Source: https://docs.testkube.io/articles/usage-export-job

Manually add the Testkube Enterprise repository and install the usage export chart.

```bash
helm repo add testkubeenterprise https://kubeshop.github.io/testkube-cloud-charts
helm repo update

helm upgrade --install testkube-usage-export testkubeenterprise/testkube-usage-export \
  -n <namespace> --create-namespace \
  -f <your-values.yaml>
```

--------------------------------

### testkube install runner command syntax

Source: https://docs.testkube.io/cli/testkube-install-runner

The basic command structure for installing a Testkube runner.

```bash
testkube install runner <name> [flags]
```

--------------------------------

### Get user settings response sample

Source: https://docs.testkube.io/openapi/cloud/Core-Operations--users

Example JSON response for the GET /users/{id}/settings endpoint.

```json
{
  "elements": [
    {
      "key": "aiCopilotEnabled",
      "valueType": "boolean",
      "value": null,
      "organizationId": "string",
      "environmentId": "string",
      "userId": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "metadata": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}
```

--------------------------------

### Initialize Ginkgo Project

Source: https://docs.testkube.io/test-types/executor-ginkgo

Commands to initialize a Go module and bootstrap a Ginkgo project.

```bash
go mod init testkube-ginkgo-example  

ginkgo bootstrap  
```

--------------------------------

### testkube install agent command syntax

Source: https://docs.testkube.io/cli/testkube-install-agent

The basic syntax for the testkube install agent command.

```bash
testkube install agent <name> [flags]
```

--------------------------------

### GET /organizations/{id}/integrations/github/connect

Source: https://docs.testkube.io/articles/github-app-auth

Retrieves a signed installation URL to initiate the GitHub App installation process in a browser.

```APIDOC
## GET /organizations/{id}/integrations/github/connect

### Description
Retrieves a signed installation URL that should be opened in a browser to install the Testkube GitHub App.

### Method
GET

### Endpoint
/organizations/{id}/integrations/github/connect

### Parameters
#### Path Parameters
- **id** (string) - Required - The organization ID.

### Response
#### Success Response (200)
- **connectUrl** (string) - The URL to redirect the user to for GitHub App installation.
```

--------------------------------

### Create and Install an Agent Simultaneously

Source: https://docs.testkube.io/articles/multi-agent-cli

Combines the creation and installation steps into a single command using the --create flag, while also applying labels.

```bash
$ testkube install agent staging-runner --create -l env=staging
```

--------------------------------

### Get execution logs v2 response sample

Source: https://docs.testkube.io/openapi/agent/default--executions

Example JSON response structure for the GET /executions/{id}/logs/v2 endpoint.

```json
[
  {
    "time": "2018-03-20T09:12:28Z",
    "content": "string",
    "type": "string",
    "source": "job-pod",
    "error": true,
    "version": "v1",
    "metadata": {
      "argsl": "passed command arguments"
    },
    "v1": {
      "result": {
        "status": "queued",
        "output": "string",
        "outputType": "text/plain",
        "errorMessage": "string",
        "steps": [
          {
            "name": "step1",
            "duration": "10m0s",
            "status": "passed",
            "assertionResults": [
              {
                "name": "assertion1",
                "status": "passed",
                "errorMessage": "string"
              }
            ]
          }
        ],
        "reports": {
          "junit": "string"
        }
      }
    }
  }
]
```

--------------------------------

### testkube init demo options

Source: https://docs.testkube.io/cli/testkube-init-demo

Available flags for configuring the demo installation, including dry-run, export, and Helm-specific settings.

```bash
      --dry-run                   Dry run  

      --export                    Export the values.yaml  

      --helm-arg stringToString   helm arg option in form of key=value (default [])  

      --helm-set stringToString   helm set option in form of key=value (default [])  

  -h, --help                      help for demo  

  -l, --license string            License key  

  -n, --namespace string          Namespace to install Testkube On-Prem demo  

  -y, --no-confirm                Skip confirmation
```

--------------------------------

### testkube get context help options

Source: https://docs.testkube.io/cli/testkube-get-context

Displays the available help options for the context command.

```bash
  -h, --help   help for context
```

--------------------------------

### GET /organizations/{id}/integrations/github/installations

Source: https://docs.testkube.io/articles/github-app-auth

Lists all GitHub App installations currently connected to the specified organization.

```APIDOC
## GET /organizations/{id}/integrations/github/installations

### Description
Lists all GitHub App installations connected to the organization.

### Method
GET

### Endpoint
/organizations/{id}/integrations/github/installations

### Parameters
#### Path Parameters
- **id** (string) - Required - The organization ID.
```

--------------------------------

### Testkube Pro help options

Source: https://docs.testkube.io/cli/testkube-pro

Displays help information for the pro command.

```bash
  -h, --help   help for pro
```

--------------------------------

### testkube marketplace install options

Source: https://docs.testkube.io/cli/testkube-marketplace-install

Available flags for configuring the installation process, including dry-run, interactive mode, and parameter overrides.

```bash
      --dry-run           validate the workflow (with overrides applied) without creating it  

  -f, --follow            follow the execution (stream logs and wait for completion); implies --run=true when --run is not supplied  

  -h, --help              help for install  

  -i, --interactive       prompt for every spec.config parameter (default: auto — prompt when attached to a terminal). Use --interactive=false to force non-interactive, --interactive to force prompting.  

      --name string       override the TestWorkflow name  

      --run               run the workflow after install (default: ask). Use --run=true to skip the prompt and run, --run=false to skip both prompt and run  

      --set stringArray   override a spec.config parameter, in key=value form (repeatable)  

      --update            update, if test workflow already exists
```

--------------------------------

### Example k6 smoke test

Source: https://docs.testkube.io/test-types/executor-k6

A basic k6 script that performs an HTTP GET request to the Testkube website.

```javascript
import http from "k6/http";  

  

export default function () {  

  http.get("https://testkube.kubeshop.io/");  

}  



```

--------------------------------

### Install or Upgrade Testkube Enterprise

Source: https://docs.testkube.io/articles/ai-test-creation

Apply the configuration by installing or upgrading the Testkube Enterprise Helm chart.

```bash
helm upgrade --install \

  --namespace testkube \

  --create-namespace \

  --values values.yaml \

  testkube \

  oci://us-east1-docker.pkg.dev/testkube-cloud-372110/testkube/testkube-enterprise \

  --version <chart-version>
```

--------------------------------

### Get Testkube Pro logs response sample

Source: https://docs.testkube.io/openapi/cloud/Environment-Operations----executions

Example JSON response for a successful log retrieval operation.

```json
{
  "elements": [
    {
      "lineNumber": 123,
      "severity": "INFO",
      "line": "This is a log line",
      "timestamp": "2006-01-02T15:04:05Z"
    }
  ],
  "stats": {
    "lines": 123,
    "bytes": 123456
  }
}
```

--------------------------------

### Action Parameters Example with JSONPath and Templates

Source: https://docs.testkube.io/articles/test-triggers

An example demonstrating the use of static values, JSONPath expressions for resource data, and Golang templates for object metadata.

```yaml
spec:  

  actionParameters:  

    config:  

      environment: production  

      datavalue: jsonpath={.data.test} # if the resource object is a configmap with key `test`  

      labels: "{{ .ObjectMeta.Labels }}"  

    tags:  

      workflow: core  

      trigger: jsonpath={.metadata.namespace} # namespace of the resource object  

      name: "{{ .ObjectMeta.Name }}"  
```

--------------------------------

### Get organization members response sample

Source: https://docs.testkube.io/openapi/cloud/Organization-Operations----members

Example JSON response for a successful request to retrieve organization members.

```json
[
  {
    "id": "string",
    "email": "jack.the.ripper@testkube.io",
    "status": "Invited",
    "role": "owner",
    "maxRole": "read",
    "inviteID": "1234567890-12312321-123123-3333",
    "invitingEmail": "pikachu@testkube.io",
    "cascadedRoles": [
      "string"
    ],
    "lastActivityAt": "2019-08-24T14:15:22Z"
  }
]
```

--------------------------------

### testkube migrate help options

Source: https://docs.testkube.io/cli/testkube-migrate

Displays help information for the migrate command.

```bash
  -h, --help   help for migrate
```

--------------------------------

### Install Testkube CLI on Windows with Chocolatey

Source: https://docs.testkube.io/articles/install/cli

Add the Kubeshop repository and install the Testkube CLI using Chocolatey.

```powershell
choco source add --name=kubeshop_repo --source=https://chocolatey.kubeshop.io/chocolatey

choco install testkube -y
```

--------------------------------

### Repository Structure Example

Source: https://docs.testkube.io/articles/gitops-overview

Recommended directory layout for organizing application manifests alongside Testkube test resources.

```text
├── apps/  
│   ├── api/  
│   │   ├── deployment.yaml  
│   │   └── service.yaml  
│   └── frontend/  
│       └── deployment.yaml  
├── tests/  
│   ├── workflows/  
│   │   ├── api-integration.yaml  
│   │   └── e2e-tests.yaml  
│   ├── triggers/  
│   │   └── on-api-update.yaml  
│   └── templates/  
│       └── common-steps.yaml  
└── kustomization.yaml  
```

--------------------------------

### Get test trigger by ID response

Source: https://docs.testkube.io/openapi/agent/default--triggers

Example of a successful 200 response containing the full configuration of a test trigger.

```json
{
  "name": "test1",
  "namespace": "testkube",
  "labels": {
    "env": "prod",
    "app": "backend"
  },
  "annotations": {
    "group": "teamA",
    "app": "backend"
  },
  "selector": {
    "matchExpressions": [
      {
        "key": "string",
        "operator": "string",
        "values": [
          "string"
        ]
      }
    ],
    "matchLabels": {
      "property1": "string",
      "property2": "string"
    }
  },
  "resource": "pod",
  "resourceRef": {
    "group": "apps",
    "version": "v1",
    "kind": "Deployment"
  },
  "resourceSelector": {
    "name": "nginx",
    "nameRegex": "nginx.*",
    "namespace": "testkube",
    "namespaceRegex": "test*",
    "labelSelector": {
      "matchExpressions": [
        {
          "key": "string",
          "operator": "string",
          "values": [
            "string"
          ]
        }
      ],
      "matchLabels": {
        "property1": "string",
        "property2": "string"
      }
    }
  },
  "event": "modified",
  "match": [
    {
      "path": "string",
      "operator": "equals",
      "value": "string"
    }
  ],
  "listener": {
    "match": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "not": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "replicate": [
      "string"
    ]
  },
  "conditionSpec": {
    "conditions": [
      {
        "status": "True",
        "type": "Progressing",
        "reason": "NewReplicaSetAvailable",
        "ttl": 1
      }
    ],
    "timeout": 1,
    "delay": 1
  },
  "probeSpec": {
    "probes": [
      {
        "scheme": "http",
        "host": "testkube-api-server",
        "path": "/",
        "port": 80,
        "headers": {
          "Content-Type": "application/xml"
        }
      }
    ],
    "timeout": 1,
    "delay": 1
  },
  "contentSelector": {
    "git": {
      "uri": "string",
      "branches": [
        "string"
      ],
      "branchesIgnore": [
        "string"
      ],
      "paths": [
        "string"
      ],
      "pathsIgnore": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "tagsIgnore": [
        "string"
      ],
      "username": "string",
      "usernameFrom": {
        "configMapKeyRef": {
          "key": "string",
          "name": "string",
          "optional": true
        },
        "fieldRef": {
          "apiVersion": "string",
          "fieldPath": "string"
        },
        "resourceFieldRef": {
          "containerName": "string",
          "divisor": "string",
          "resource": "string"
        },
        "secretKeyRef": {
          "key": "string",
          "name": "string",
          "optional": true
        }
      },
      "token": "string",
      "tokenFrom": {
        "configMapKeyRef": {
          "key": "string",
          "name": "string",
          "optional": true
        },
        "fieldRef": {
          "apiVersion": "string",
          "fieldPath": "string"
        },
        "resourceFieldRef": {
          "containerName": "string",
          "divisor": "string",
          "resource": "string"
        },
        "secretKeyRef": {
          "key": "string",
          "name": "string",
          "optional": true
        }
      },
      "sshKey": "string",
      "sshKeyFrom": {
```

--------------------------------

### Install a Workflow

Source: https://docs.testkube.io/articles/examples/marketplace

Install a workflow using defaults, parameter overrides, or non-interactive flags. Includes options for dry-run and updates.

```bash
# Install with the workflow's defaults

testkube marketplace install redis-connectivity

# Override one or more parameters; values are written into spec.config defaults

testkube marketplace install redis-connectivity \
  --set host=my-redis.default.svc.cluster.local \
  --set port=6379

# When attached to a terminal, install prompts for every parameter the workflow
# exposes by default. --set values become the pre-filled default; empty input
# keeps the current value; sensitive parameters are read with masked input.

testkube marketplace install redis-connectivity

# Force non-interactive (use defaults + --set as-is) -- handy on a terminal
# when you know the overrides already cover everything you need.

testkube marketplace install redis-connectivity --interactive=false

# Validate without creating, or upsert an existing workflow

testkube marketplace install redis-connectivity --dry-run
testkube marketplace install redis-connectivity --update
```

--------------------------------

### Basic Maven Workflow from Template

Source: https://docs.testkube.io/articles/examples/maven-basic

An example workflow using an official Testkube template to execute a Maven project.

```yaml
apiVersion: testworkflows.testkube.io/v1  

kind: TestWorkflow  

metadata:  

  name: maven-sample-from-template  

  namespace: testkube  

  labels:  

    docs: example  

spec:  

  content:  

    git:  

      uri: https://github.com/kubeshop/testkube  

      revision: main  

      paths:  

        - contrib/executor/maven/examples/hello-maven  

  container:  

    workingDir: /data/repo/contrib/executor/maven/examples/hello-maven  

    env:  

      - name: TESTKUBE_MAVEN  

        value: "true"  

  steps:  

    - name: Run from template  

      template:  

        name: official/maven/v1  

        config:  

          version: 3.9.6-eclipse-temurin-11-focal  
```

--------------------------------

### Get member permissions response sample

Source: https://docs.testkube.io/openapi/cloud/Organization-Operations----members

Example JSON response containing a list of permissions for a specific organization member.

```json
[
  {
    "name": "namespace",
    "slug": "slug",
    "type": "environment",
    "role": "admin",
    "reason": {
      "type": "Team",
      "name": "team X"
    }
  }
]
```

--------------------------------

### testkube config namespace help options

Source: https://docs.testkube.io/cli/testkube-config-namespace

Displays the available help options for the namespace command.

```bash
  -h, --help   help for namespace
```

--------------------------------

### Get Webhook Details 200 Response

Source: https://docs.testkube.io/openapi/cloud/Agent-Operations----webhooks

Example of a successful 200 response containing the full configuration details of a webhook.

```json
{
  "name": "webhook1",
  "namespace": "testkube",
  "labels": {
    "app": "backend",
    "env": "prod"
  },
  "annotations": {
    "app": "backend",
    "env": "prod"
  },
  "created": "2022-07-30T06:54:15Z",
  "updated": "2022-07-30T06:54:15Z",
  "disabled": [
    true,
    false
  ],
  "uri": "https://hooks.app.com/services/1",
  "events": [
    "queue-testworkflow"
  ],
  "selector": "string",
  "payloadObjectField": "string",
  "payloadTemplate": "string",
  "payloadTemplateReference": "string",
  "headers": {
    "Content-Type": "application/xml"
  },
  "config": {
    "property1": {
      "value": {
        "value": "string"
      },
      "secret": {
        "namespace": "string",
        "name": "string",
        "key": "string"
      }
    },
    "property2": {
      "value": {
        "value": "string"
      },
      "secret": {
        "namespace": "string",
        "name": "string",
        "key": "string"
      }
    }
  },
  "parameters": [
    {
      "name": "string",
      "description": "string",
      "required": false,
      "example": "string",
      "default": {
        "value": "string"
      },
      "pattern": "string"
    }
  ],
  "webhookTemplateRef": {
    "name": "string"
  },
  "sync": {
    "creationSource": "kubernetes",
    "lastModificationSource": "kubernetes"
  },
  "target": {
    "match": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "not": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "replicate": [
      "string"
    ]
  }
}
```

--------------------------------

### Get GitHub App connect URL response

Source: https://docs.testkube.io/openapi/cloud/Organization-Operations----integrations

The JSON response body returned when requesting a signed GitHub App installation URL.

```json
{
  "connectUrl": "http://example.com"
}
```

--------------------------------

### testkube mcp serve command usage

Source: https://docs.testkube.io/cli/testkube-mcp-serve

The basic syntax for starting the MCP server.

```bash
testkube mcp serve [flags]
```

--------------------------------

### Define Prerun and Postrun Scripts

Source: https://docs.testkube.io/articles/creating-tests

Shell scripts can be executed before and after tests. These examples show a certificate setup script and a sleep command script.

```bash
#!/bin/sh



echo "Storing ssl certificate in file from env secret env"

echo "$SSL_CERT" > /data/ssl.crt
```

```bash
#!/bin/sh



echo "Sleeping for 30 seconds"

sleep 30
```

--------------------------------

### testkube config help options

Source: https://docs.testkube.io/cli/testkube-config

Displays the available help options for the config command.

```bash
-h, --help   help for config
```

--------------------------------

### Download artifact error response sample

Source: https://docs.testkube.io/openapi/agent/default--executions

Example JSON response structure for error cases when downloading artifacts via GET /executions/{id}/artifacts/{filename}.

```json
[
  {
    "type": "https://kubeshop.io/testkube/problems/invalidtestname",
    "title": "Invalid test name",
    "status": 500,
    "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
    "instance": "http://10.23.23.123:8088/tests"
  }
]
```

--------------------------------

### testkube init demo command usage

Source: https://docs.testkube.io/cli/testkube-init-demo

Basic syntax for the testkube init demo command. Note that this installs the Control Plane only; workflows require a separate Testkube Runner installation.

```bash
testkube init demo [flags]
```

--------------------------------

### Configure API Token MCP Server

Source: https://docs.testkube.io/articles/mcp-security

Example configuration for an MCP server using API tokens for machine-to-machine authentication. This setup requires an Authorization header with a Bearer token.

```json
{
  "mcpServers": {
    "testkube": {
      "url": "https://api.testkube.io/organizations/{org_id}/environments/{env_id}/mcp",
      "transport": {
        "type": "sse"
      },
      "headers": {
        "Authorization": "Bearer YOUR_API_TOKEN"
      }
    }
  }
}
```

--------------------------------

### Troubleshoot Pod Startup Issues

Source: https://docs.testkube.io/articles/install/deploy-on-aws-eks

Commands to inspect pod status and logs when pods fail to start in the testkube namespace.

```bash
kubectl describe pod <pod-name> -n testkube  

kubectl logs <pod-name> -n testkube
```

--------------------------------

### Sharded Playwright Test Workflow

Source: https://docs.testkube.io/articles/test-workflows-parallel

This example demonstrates cloning a repository, installing dependencies, and running sharded Playwright tests across two parallel instances using the transfer property to share the node_modules directory.

```yaml
apiVersion: testworkflows.testkube.io/v1  

kind: TestWorkflow  

metadata:  

  name: example-sharded-playwright-test  

spec:  

  content:  

    git:  

      uri: https://github.com/kubeshop/testkube  

      paths:  

        - test/playwright/playwright-project  

  container:  

    image: mcr.microsoft.com/playwright:v1.32.3-focal  

    workingDir: /data/repo/test/playwright/playwright-project  

  

  steps:  

    - name: Install dependencies  

      shell: "npm ci"  

  

    - name: Run tests  

      parallel:  

        count: 2  

        transfer:  

          - from: /data/repo  

        shell: "npx playwright test --shard {{ index + 1 }}/{{ count }}"
```

--------------------------------

### Matrix and Sharding Configuration

Source: https://docs.testkube.io/articles/test-workflows-matrix-and-sharding

Example configuration showing how to combine matrix parameters with sharding settings.

```yaml
matrix:  

  browser: ["chrome", "firefox"]  

  memory: ["1Gi", "2Gi"]  

count: 2  

shards:  

  url:  

    [  

      "https://testkube.io",  

      "https://docs.testkube.io",  

      "https://app.testkube.io",  

    ]
```

--------------------------------

### Python dependency installation and test execution

Source: https://docs.testkube.io/articles/test-workflows-best-practices

Install dependencies explicitly before running tests, marking the installation step as pure.

```yaml
steps:  

  - name: Install dependencies  

    shell: pip install -r requirements.txt  

    pure: true  

  - name: Run tests  

    shell: pytest tests --junit-xml=/data/artifacts/report.xml
```

--------------------------------

### Connect to Pro (full data migration)

Source: https://docs.testkube.io/articles/install/oss-to-cloud

Connects the OSS instance to Pro and migrates all execution data.

```bash
testkube pro connect --api-key <key> --org-id <org> --env-id <env> --root-domain <domain>
```

--------------------------------

### Install Testkube Operator and CRDs

Source: https://docs.testkube.io/articles/install/standalone-agent

Perform the first step of a fresh installation by installing the operator and CRDs with the PostgreSQL cluster disabled.

```bash
helm upgrade --install testkube oci://us-east1-docker.pkg.dev/testkube-cloud-372110/testkube/testkube --version <version> \

-n testkube \

--create-namespace \

-f values.yaml \

--set postgresqlCluster.enabled=false
```

--------------------------------

### Start MCP Server with API Key

Source: https://docs.testkube.io/articles/mcp-cli

Start the MCP server using the configured API key and view the confirmation output.

```bash
testkube mcp serve --verbose
```

```text
Starting MCP server with configuration:

  Organization: Your Organization (tkcorg_xxx)

  Environment: Your Environment (tkcenv_yyy)

  API URL: https://api.testkube.io

  Dashboard URL: https://app.testkube.io

  API Key: tk_xxx...xxx
```

--------------------------------

### Install Workflow from URL

Source: https://docs.testkube.io/articles/examples/marketplace

Create a TestWorkflow directly from a remote HTTP(S) URL.

```bash
testkube create testworkflow --url \
  https://raw.githubusercontent.com/kubeshop/testkube-marketplace/main/workflows/databases/redis/redis-connectivity.yaml
```

--------------------------------

### Install Testkube via Helm

Source: https://docs.testkube.io/articles/getting-started-with-open-source

Add the Testkube Helm repository and install the chart into the testkube namespace. This command creates the namespace if it does not exist and installs the necessary CRDs.

```bash
helm repo add kubeshop https://kubeshop.github.io/helm-charts

helm repo update

helm upgrade --install testkube kubeshop/testkube \
  --create-namespace \
  --namespace testkube \
  --set installCRDs=true
```

--------------------------------

### testkube init options

Source: https://docs.testkube.io/cli/testkube-init

Available flags for the init command, including exporting values.yaml and help.

```bash
      --export   Export the values.yaml  

  -h, --help     help for init  
```

--------------------------------

### Status Service Name Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example value for the name of a service.

```yaml
example: API Services
```

--------------------------------

### testkube migrate agent help options

Source: https://docs.testkube.io/cli/testkube-migrate-agent

Displays help information for the agent migration command.

```bash
-h, --help   help for agent
```

--------------------------------

### Dex configuration example

Source: https://docs.testkube.io/articles/vault-install

A sample Dex configuration file customized for Kubernetes storage and static password authentication.

```yaml
logger:  

  level: debug  

  format: json  

storage:  

  type: kubernetes  

  config:  

    inCluster: true  

issuer: <idp url>  

enablePasswordDB: true  

staticPasswords:  

  - email: "admin@testkube.com"  

    # bcrypt hash of the string "password": $(echo password | htpasswd -BinC 10 admin | cut -d: -f2)  

    hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"  

    username: "admin"  

    userID: "4761be60-0ae4-45e6-a21d-2196e911e010"
```

--------------------------------

### Zero to running test walkthrough

Source: https://docs.testkube.io/articles/testkube-skills

A sequence of prompts to guide the agent through setting up and running tests in Testkube.

```text
I want to run this repository's tests in Testkube. Start by making sure the CLI is installed.
```

```text
I don't have a Testkube environment yet — set up a local open source one.
```

```text
Now look through this repository and tell me what tests exist and what framework runs them.
```

```text
Create a TestWorkflow for the end-to-end suite you found.
```

```text
Run it and tell me what happened.
```

--------------------------------

### GET /organizations/{id}/groups/{groupID}

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Get a resource group by its id.

```APIDOC
## GET /organizations/{id}/groups/{groupID}

### Description
Get a resource group by its `id`.

### Method
GET

### Endpoint
/organizations/{id}/groups/{groupID}

### Parameters
#### Path Parameters
- **id** (string) - Required - organizationId
- **groupID** (string) - Required - The ID of the resource group
```

--------------------------------

### testkube set help options

Source: https://docs.testkube.io/cli/testkube-set

Displays the available help flags for the set command.

```bash
-h, --help   help for set
```

--------------------------------

### GET /test-workflows/{id}/metrics

Source: https://docs.testkube.io/assets/files/testkube-agent-openapi-06772fa03112aba5f9e479661aaf009e.yaml

Get metrics of test workflow executions.

```APIDOC
## GET /test-workflows/{id}/metrics

### Description
Get metrics of test workflow executions.

### Method
GET

### Endpoint
/test-workflows/{id}/metrics

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the test workflow.

### Response
#### Success Response (200)
- **metrics** (ExecutionsMetrics) - The metrics data for the test workflow executions.
```

--------------------------------

### Minikube mount command output

Source: https://docs.testkube.io/articles/local-dev-loop

Example output showing a successful mount of the local host path into the Minikube VM.

```text
➜  testkube git:(main) ✗ minikube mount /Users/olensmar/Dev/cursor/testkube/testkube:/minikube-host/testkube --uid=1000 --gid=1000  

📁  Mounting host path /Users/olensmar/Dev/cursor/testkube/testkube into VM as /minikube-host/testkube ...  

    ▪ Mount type:   9p  

    ▪ User ID:      1000  

    ▪ Group ID:     1000  

    ▪ Version:      9p2000.L  

    ▪ Message Size: 262144  

    ▪ Options:      map[]  

    ▪ Bind Address: 127.0.0.1:61734  

🚀  Userspace file server: ufs starting  

✅  Successfully mounted /Users/olensmar/Dev/cursor/testkube/testkube to /minikube-host/testkube  

  

📌  NOTE: This process must stay alive for the mount to be accessible ...
```

--------------------------------

### SuperAgent Token Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example of an agent token used for environment authentication.

```yaml
example: tkcagnt_adead343112adeadcaaaaa221daee2
```

--------------------------------

### Status Service Operability Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example percentage value for passed tests.

```yaml
example: 99.999
```

--------------------------------

### Kubernetes Secret Resource Example

Source: https://docs.testkube.io/articles/adding-tests-secrets

An example of a Kubernetes Secret resource definition.

```yaml
apiVersion: v1

kind: Secret

data:

  03f9de1e-f90c-4cfa-bb64-2fc55681f1f4: eyJzZWMxIjoicGFzczEifQ==

  1cc30442-8a94-4147-96b3-25c978817d81: eyJzZWMxIjoiIn0=

  29e028e8-9fcd-408f-9ca9-babee98db13d: eyJzZWMxIjoicGFzczEifQ==

  435e41a9-dd9d-46e9-820f-142c15a7ef51: eyJzZWMxIjoiIn0=

  74c7e5f0-1032-4968-97a8-0b2b7e0b0b23: eyJzZWMxIjoiIn0=

  962fb637-3458-4c82-a430-64d169b96252: eyJzZWMxIjoicGFzczEifQ==

  current-secret: OTYyZmI2MzctMzQ1OC00YzgyLWE0MzAtNjRkMTY5Yjk2MjUy

  sec1: cGFzczE=

metadata:

  name: my-secret

  namespace: testkube

  resourceVersion: "3293159"

  uid: 8516b80b-74ba-48cf-abe6-6c9791f1b08d

type: Opaque
```

--------------------------------

### Run testkube docker init command

Source: https://docs.testkube.io/cli/testkube-docker-init

Basic syntax for initializing the Testkube Docker Agent.

```bash
testkube docker init [flags]
```

--------------------------------

### Basic Cypress Workflow from Template

Source: https://docs.testkube.io/articles/examples/cypress-basic

An example workflow utilizing the official Testkube Cypress template to simplify test execution.

```yaml
apiVersion: testworkflows.testkube.io/v1  

kind: TestWorkflow  

metadata:  

  name: cypress-sample-from-template  

  namespace: testkube  

  labels:  

    docs: example  

spec:  

  container:  

    workingDir: /data/repo/test/cypress/cypress-13  

    env:  

      - name: CYPRESS_CUSTOM_ENV  

        value: "CYPRESS_CUSTOM_ENV_value"  

  content:  

    git:  

      uri: https://github.com/kubeshop/testkube  

      revision: main  

      paths:  

        - test/cypress/cypress-13  

  steps:  

    - name: Run from template  

      workingDir: /data/repo/test/cypress/cypress-13  

      template:  

        name: official/cypress/v1  

        config:  

          version: 13.6.4  

          run: "npx cypress run --env NON_CYPRESS_ENV=NON_CYPRESS_ENV_value"  

      artifacts:  

        paths:  

          - "cypress/videos/**/*"  

          - "cypress/screenshots/**/*"  
```

--------------------------------

### Install kind on MacOS

Source: https://docs.testkube.io/articles/install/quickstart-no-k8s

Use Homebrew to install the kind CLI tool on macOS.

```bash
brew install kind
```

--------------------------------

### Install or Upgrade Testkube Agent

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Command to initialize the Testkube agent with a specific agent key and URL.

```bash
testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.example.com:443
```

--------------------------------

### Validate Testkube CLI installation

Source: https://docs.testkube.io/articles/install/cli

Check the installed version of the Testkube CLI and server.

```bash
testkube version
```

--------------------------------

### GET /test-workflows/{id}/executions/{executionID}

Source: https://docs.testkube.io/assets/files/testkube-agent-openapi-06772fa03112aba5f9e479661aaf009e.yaml

Get test workflow execution details.

```APIDOC
## GET /test-workflows/{id}/executions/{executionID}

### Description
Get test workflow execution details.

### Method
GET

### Endpoint
/test-workflows/{id}/executions/{executionID}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the test workflow.
- **executionID** (string) - Required - The ID of the execution.

### Response
#### Success Response (200)
- **execution** (TestWorkflowExecution) - The details of the specific test workflow execution.
```

--------------------------------

### GET /triggers/{id}

Source: https://docs.testkube.io/openapi/agent/default--triggers

Get test trigger by ID from CRD in kubernetes cluster.

```APIDOC
## GET /triggers/{id}

### Description
Get test trigger by ID from CRD in kubernetes cluster.

### Method
GET

### Endpoint
/triggers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique id of the object

#### Query Parameters
- **namespace** (string) - Optional - Namespace of the object (Default: "testkube")

### Response
#### Success Response (200)
- Returns the test trigger object details.

#### Error Responses
- **404** - Test trigger not found
- **502** - Problem communicating with kubernetes cluster
```

--------------------------------

### testkube create command syntax

Source: https://docs.testkube.io/cli/testkube-create

The basic syntax for the create command.

```bash
testkube create <resourceName> [flags]
```

--------------------------------

### testkube get context command syntax

Source: https://docs.testkube.io/cli/testkube-get-context

The basic syntax for the get context command.

```bash
testkube get context <value> [flags]
```

--------------------------------

### Status Page Slug Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example of a globally unique identifier for a status page.

```yaml
example: mySlugName
```

--------------------------------

### Environment Member Email Example

Source: https://docs.testkube.io/assets/files/testkube-control-plane-openapi-a3dbc4a821370520fb71158b736ab369.yaml

Example of an email address format for an environment member.

```text
jack.the.ripper@testkube.io
```

--------------------------------

### testkube create webhook synopsis

Source: https://docs.testkube.io/cli/testkube-create-webhook

The basic syntax for creating a new Webhook Custom Resource.

```bash
testkube create webhook [flags]
```

--------------------------------

### testkube init command syntax

Source: https://docs.testkube.io/cli/testkube-init

The basic syntax for initializing Testkube with a specified profile.

```bash
testkube init <profile> [flags]
```
Tokens:
Raw