Skip to content

docs: cover the BYO harness path in the UI (#539) - #723

Open
boxcee-interview wants to merge 1 commit into
kagent-dev:mainfrom
boxcee-interview:fix/issue-539
Open

boxcee-interview wants to merge 1 commit into
kagent-dev:mainfrom
boxcee-interview:fix/issue-539

Conversation

@boxcee-interview

Copy link
Copy Markdown
Contributor

Closes #539

agents/bring-your-own-agent.md documented only the CLI and YAML path. Since kagent#2935 the UI authors a byo Harness directly, so a reader working in the UI had no route through the feature.

Adds a Create a BYO Harness in the UI section to the page, written as another route to the same A2A contract rather than a separate feature, as the issue asks:

  • New Harness → byo under Runtime adapter; the form asks for Workload image (digest-pinned) and Command, mirroring the fields the contract table already names.
  • Create harness stays disabled while the form reports a problem, so the same workload.command rule the API enforces at apply time is enforced at authoring time. Verified against harnessDraftProblems in kagent's ui/src/components/harness-form/harnessDraft.ts.
  • The Harnesses tab reports the runtime as byo (runtime column in HarnessesTab.tsx).
  • The model is optional on a byo agent; the Agent form asks for a model configuration only for non-byo harnesses (AgentFormPage.tsx).

Applied to both main and latest, which currently carry identical copies of this page. No matching line was needed in agent-harness.md: its workload.command row already states the requirement.

Screenshots omitted — no capture environment available here; happy to add them if you can point me at the fixture workflow.

How to Test

make build-docs (Hugo v0.160.1, the version CI pins) → HUGO_EXIT=0, 956 pages, no ERROR lines. The new section renders on both version copies with the internal ui/launch-ui link resolving.

@boxcee-interview

Copy link
Copy Markdown
Contributor Author

CI note: all code checks pass (Static + content checks, linkChecker, DCO). The only red check is the Preview deploy — it fails at the external "Upload preview version" step (cloudflare/wrangler-action, Worker version upload) after the Hugo build succeeds, so it looks like a transient Cloudflare-side issue rather than a docs problem. A re-run of the deploy job should clear it if maintainers have the access to trigger one.

@boxcee-interview

Copy link
Copy Markdown
Contributor Author

Heads up: the deploy check fails before any content is involved — the Preview step errors with 'In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work.' All content checks (Static + content checks, linkChecker, DCO, Framework tests, Links) pass. I can't fix a missing workflow secret from a fork; once CLOUDFLARE_API_TOKEN is available to the workflow this PR should go green.

@boxcee-interview

Copy link
Copy Markdown
Contributor Author

The deploy check fails before it reaches the PR's content: the GitHub Actions runner has no CLOUDFLARE_API_TOKEN, so wrangler aborts with "it's necessary to set a CLOUDFLARE_API_TOKEN environment variable". Every other check on this PR passes (Static + content checks, linkChecker, DCO). This looks like a repo secret the maintainers would need to (re)attach to the Actions environment — happy to close and reopen if a new push is needed once it's in place.

Signed-off-by: Moritz Schmitz von Hülst <mschmitzvonhuelst@gmail.com>
@boxcee-interview

Copy link
Copy Markdown
Contributor Author

Update on the new head (08e269e): the deploy check re-ran and still fails at the same step — "Upload preview version" (cloudflare/wrangler-action) aborts with 'In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable'. All other checks pass (Static + content checks, linkChecker, DCO, Framework tests). This confirms it is the missing CLOUDFLARE_API_TOKEN secret on the Actions side, not anything in the docs change.

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.

Docs: cover creating a BYO Harness in the UI for kagent 1.x

1 participant