Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions docs-site/content/kagent/main/agents/agent-harness.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ EOF
| Field | Required | Description |
| ----- | -------- | ----------- |
| One of `kagent`, `codex`, `claude`, `byo` | Yes | The harness that executes the agent. Naming none, or more than one, is rejected. To compare the four harnesses, see [Choose a harness](#choose-a-harness). |
| `workload.image` | For `byo` | The container image to run, pinned by `sha256` digest. A tag with no digest is rejected, because a revision must be reproducible. Omit it on a `kagent`, `codex`, or `claude` Harness to run the built-in image of the installed release. For more information, see [Built-in runtime images](#built-in-runtime-images). |
| `workload.image` | For `byo` | The container image to run, pinned by `sha256` digest. A tag with no digest is rejected, because a revision must be reproducible. Omit it on a `kagent`, `codex`, or `claude` Harness to run the built-in image of the installed release. For more information, see [Built-in runtime images](#built-in-runtime-images). |{{< version include-if="latest,0.x" >}}
| `workload.command` | For `byo` | Overrides the image entrypoint, up to 32 entries. Required for the `byo` harness, optional otherwise. Every harness honors an explicit value, the `kagent` harness included, regardless of the language its image is written in. |
| `workload.args` | No | Overrides the image arguments, up to 64 entries. An override that you omit stays unset rather than taking a default. |
| `workload.args` | No | Overrides the image arguments, up to 64 entries. An override that you omit stays unset rather than taking a default. |{{< /version >}}{{< version exclude-if="latest,0.x" >}}
| `workload.command` | For `byo` | Overrides the image entrypoint, up to 32 entries. Required for the `byo` harness and optional for the `kagent` harness. The `claude` and `codex` harnesses reject this field. An empty list is also rejected. |
| `workload.args` | No | Overrides the image arguments, up to 64 entries. Supported on the `kagent` and `byo` harnesses. The `claude` and `codex` harnesses reject this field. An override that you omit stays unset, and an empty list is rejected. |{{< /version >}}
| `env` | No | Environment variables for the agent process. Each entry sets a literal `value`, which is required and can be an empty string. The schema does not define a secret-backed source, so the API server rejects a `credentialRef` entry as an unknown field. Put credentials in a ModelConfig or a RemoteMCPServer instead. For more information, see [About model providers]({{< link path="setup/model-providers/about-model-providers#credentials-that-kagent-rejects" >}}). Limits and reserved names both apply. For more information, see [Environment variables on an Actor](#environment-variables-on-an-actor). |
| `substrate.workerPoolRef.name` | Yes | The {{< gloss "WorkerPool" >}}WorkerPool{{< /gloss >}} that this Harness's Actors are scheduled onto. An operator must provision one before any agent can run. |
| `substrate.snapshotPolicy.location` | Yes | The object storage location for Actor {{< gloss "Snapshot" >}}snapshots{{< /gloss >}}. |
Expand Down
5 changes: 3 additions & 2 deletions docs-site/content/kagent/main/agents/bring-your-own-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,9 @@ EOF
| Field | Required | Description |
| ----- | -------- | ----------- |
| `byo` | Yes | Selects this harness. The object is always empty, and naming a second harness alongside it is rejected. |
| `workload.image` | Yes | Your image, pinned by `sha256` digest. A tag alone is rejected, because a revision must be reproducible. |
| `workload.command` | Yes | The entrypoint to run, up to 32 entries. Required for `byo` and optional for every other harness. |
| `workload.image` | Yes | Your image, pinned by `sha256` digest. A tag alone is rejected, because a revision must be reproducible. |{{< version include-if="latest,0.x" >}}
| `workload.command` | Yes | The entrypoint to run, up to 32 entries. Required for `byo` and optional for every other harness. |{{< /version >}}{{< version exclude-if="latest,0.x" >}}
| `workload.command` | Yes | The entrypoint to run, up to 32 entries. Required for `byo` and optional for the `kagent` harness. The `claude` and `codex` harnesses reject this field. |{{< /version >}}
| `env` | No | Any setting that your image reads. Each entry takes a literal `value` only. Put credentials in a ModelConfig or a RemoteMCPServer instead. |

An opaque agent's AgentTemplate sets only a description for the agent card. An Agent then pairs it with the Harness.
Expand Down