Skip to content

chore: [TKC-4507] Enhance multi-agent runner helm chart documentation #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
caiomede-tk wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: [TKC-4507] Enhance multi-agent runner helm chart documentation #412

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce543b5
chore: Enhance multi-agent runner helm chart documentation
caiomede-tk Nov 11, 2025
b83b9b4
fix: warning and note
caiomede-tk Nov 12, 2025
0096a11
fix: improving agent writting
caiomede-tk Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/articles/multi-agent-runner-helm-chart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,62 @@ cloud:
- Self-registering Agents must be able to create Kubernetes `Secrets` in their namespace.
These secrets are used to store the agent's ID and connection key which are generated during registration.
If the Agent cannot create a `Secret` it will self-register every time it starts up.
- Agents mode cannot be changed after registration, to change that first uninstall and remove manually removed using the UI or CLI to later install again with new mode.
- Agents will not deregister themselves during `helm uninstall`. Instead, self-registered Agents must be manually removed using the UI or CLI.

## Runner Agent Cookbook

There are common things that you may want to set up in your values.

### Setting Agent Mode
Copy link
Copy Markdown
Member

@olensmar olensmar Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is specific to Runner Agents - so please use "Runner Agent" everywhere - i.e. "Setting Runner Agent Mode", "Runner Agent mode cannot be changed..", "Runner Agents allow 3 modes..", etc

Copy link
Copy Markdown
Collaborator Author

@caiomede-tk caiomede-tk Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for that feedback 🫶


:::note
The agent mode cannot be changed after registration. To modify it, you must uninstall the agent via the UI or CLI and then perform a fresh installation.
:::

Agents allows 3 modes: Independent, Global, and Grouped, review the description of them
[here](/articles/test-workflows-running#runner-agent-modes). By default all new Agents
will use mode **Independent**, to set a different mode there is 2 options:

* For Global mode:

```yaml
runner:
register:
global: true
```

:::note
Global mode has more priority than any other modes, so to set another mode ensure Global is `false`.
:::

* For Grouped mode:

```yaml
runner:
register:
global: false
groupName: my-group
```

### Setting Agent Labels

Agent labels are derived from the agent deployment’s labels using a specific prefix, which defaults to `runner.testkube.io/`.
All labels with this prefix are sent to the Testkube Control Plane when the agent starts.

For example, the agent deployment label `runner.testkube.io/env: testing` becomes the agent label `env=testing`.

Use the following values to set agent labels:

```yaml
runner:
register:
labels:
env: testing
## To replace label prefix uncomment:
# labelPrefix: runner.testkube.io/
```

### Install Runner Agent in one namespace and run executions in another

To separate concerns, you may separate your Runner Agents from the execution:
Expand Down