add agentharness docs#372
Open
peterj wants to merge 1 commit into
Open
Conversation
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
artberger
approved these changes
May 27, 2026
Collaborator
artberger
left a comment
artberger
left a comment
There was a problem hiding this comment.
I left some questions, but approved. Thanks for adding this to the docs!
|
|
||
| # Agent Harness | ||
|
|
||
| An `AgentHarness` is a Kubernetes resource that asks kagent to provision a long-running remote execution environment through an OpenShell gateway. It is useful when you want a managed sandbox that can be attached to, bootstrapped, and connected to messaging channels, but you do not want kagent to package and run a full agent runtime inside the workload. |
Collaborator
There was a problem hiding this comment.
Suggested change
| An `AgentHarness` is a Kubernetes resource that asks kagent to provision a long-running remote execution environment through an OpenShell gateway. It is useful when you want a managed sandbox that can be attached to, bootstrapped, and connected to messaging channels, but you do not want kagent to package and run a full agent runtime inside the workload. | |
| An `AgentHarness` is a Kubernetes custom resource that asks kagent to provision a long-running remote execution environment through an [OpenShell](https://github.com/NVIDIA/OpenShell) gateway. It is useful when you want a managed sandbox that can be attached to, bootstrapped, and connected to messaging channels, but you do not want kagent to package and run a full agent runtime inside the workload. |
|
|
||
| ## Backend model | ||
|
|
||
| The `spec.backend` field selects the backend implementation. |
Collaborator
There was a problem hiding this comment.
I am wondering if these backends are separate resources that you have to already have deployed to the cluster?
|
|
||
| `spec.modelConfigRef` points at a kagent `ModelConfig`. OpenClaw-compatible backends translate that model configuration into OpenClaw bootstrap config. Hermes uses the referenced model while building its Hermes configuration. | ||
|
|
||
| If `spec.image` is omitted, kagent uses the default base image for the selected backend. Set `spec.image` only when you have a backend-compatible custom image. |
Collaborator
There was a problem hiding this comment.
Is the default base image something that kagent sets somewhere? or for nemoclaw would it be something like the most recent tag?
|
|
||
| ## Channels | ||
|
|
||
| `spec.channels` declares messaging integrations inside the harness environment. Each channel has a stable `name`, a `type`, and exactly one matching channel spec. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `spec.channels` declares messaging integrations inside the harness environment. Each channel has a stable `name`, a `type`, and exactly one matching channel spec. | |
| `spec.channels` declares the external messaging platform (such as Slack) that you want to integrate with the harness. Each channel has a stable `name`, a `type`, and exactly one matching channel spec. |
|
|
||
| ## Create an OpenClaw harness | ||
|
|
||
| The following resource creates an OpenClaw harness and lets it reach the OpenAI and Slack APIs. |
Collaborator
There was a problem hiding this comment.
Do you have to allowlist the LLM APIs that match the ModelConfig LLM provider that you set up? so this allows OpenAI because the default ModelConfig is for OpenAI.
| metricsPort: 0 | ||
| EOF | ||
|
|
||
| This example disables TLS and authentication. For production environments, configure TLS and authentication according to your OpenShell requirements. |
Collaborator
There was a problem hiding this comment.
Suggested change
| This example disables TLS and authentication. For production environments, configure TLS and authentication according to your OpenShell requirements. | |
| This example disables TLS and authentication. For production environments, configure TLS and authentication according to your OpenShell requirements. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.