Skip to content

[Automated] Draft docs (kagent): fix(api): reject unsupported Harness workload overrides - #733

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3616
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3616

Conversation

@github-actions

@github-actions github-actions Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

kagent-dev/kagent#3616 — fix(api): reject unsupported Harness workload overrides

Docs versions: main

What changes for users: Harness admission now rejects spec.workload.command and spec.workload.args on claude and codex harnesses. The API server also rejects an empty command or args list on any Harness.

What the docs now say: The Agent harness and Bring your own agent pages now say that workload.command and workload.args are supported on kagent and byo harnesses, and rejected on claude and codex harnesses.

How kagent-3616 was drafted

Plan, and what changed it

  • Planned: Correct the Harness pages that mention workload.command and workload.args.
  • Learned: The BYO example page uses workload.command only for byo, so it was not stale; agent-harness.md and bring-your-own-agent.md had the stale claims.
  • Did: Updated the two stale field-table rows and left the BYO example unchanged.

Why a documentation change is necessary

The pull request changes the Harness CRD validation so that claude and codex harnesses reject workload.command and workload.args. The existing Agent harness page said that every harness honors an explicit workload.command, and the Bring your own agent page said that workload.command is optional for every non-BYO harness. Those statements contradicted the new API behavior.

How to verify this change

  1. Apply a claude Harness that sets spec.workload.command.
    kubectl apply -f - <<'EOF'
    apiVersion: api.kagent.dev/v1alpha3
    kind: Harness
    metadata:
      name: claude-command-rejected
      namespace: kagent
    spec:
      claude: {}
      workload:
        command: ["/bin/sh"]
      substrate:
        workerPoolRef:
          name: kagent-default
        snapshotPolicy:
          location: s3://ate-snapshots/kagent/
    EOF
    The API server rejects the resource with Claude harnesses do not support workload.command or workload.args.
  2. Apply a kagent Harness that sets spec.workload.command and spec.workload.args.
    kubectl apply -f - <<'EOF'
    apiVersion: api.kagent.dev/v1alpha3
    kind: Harness
    metadata:
      name: kagent-command-accepted
      namespace: kagent
    spec:
      kagent: {}
      workload:
        command: ["/agent"]
        args: ["serve"]
      substrate:
        workerPoolRef:
          name: kagent-default
        snapshotPolicy:
          location: s3://ate-snapshots/kagent/
    EOF
    The API server accepts the resource.
  3. Apply any Harness that sets spec.workload.command: [].
    kubectl apply -f - <<'EOF'
    apiVersion: api.kagent.dev/v1alpha3
    kind: Harness
    metadata:
      name: empty-command-rejected
      namespace: kagent
    spec:
      kagent: {}
      workload:
        command: []
      substrate:
        workerPoolRef:
          name: kagent-default
        snapshotPolicy:
          location: s3://ate-snapshots/kagent/
    EOF
    The API server rejects the resource with spec.workload.command in body should have at least 1 items.

Proposed release note

Harness admission now rejects workload.command and workload.args on Claude and Codex harnesses, and rejects an empty command or args list on any harness.

Files in this pull request

  • docs-site/content/kagent/main/agents/agent-harness.md
  • docs-site/content/kagent/main/agents/bring-your-own-agent.md
How the pages were chosen (triage report)

Draft a documentation change

kagent-dev/kagent#3616 — fix(api): reject unsupported Harness workload overrides

  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: main
  • Summary (read from the body): Harness admission now rejects workload.command and workload.args on Claude and Codex harnesses, and rejects an empty command or args list on any harness.
  • Not tested: a cluster was used only to dry-run the YAML manifests the draft added; prose, inline field paths and commands are unrun

Draft branch: pr-tracker-draft-kagent-3616

… workload overrides

Signed-off-by: GitHub Action <action@github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant