Skip to content

Simplify the kagent install docs for kagent-dev/kagent#3566 - #705

Merged
sebbycorp merged 4 commits into
mainfrom
docs/install-onboarding-3566
Nov 10, 2026
Merged

sebbycorp merged 4 commits into
mainfrom
docs/install-onboarding-3566

Conversation

@EItanya

@EItanya EItanya commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Docs for the onboarding changes in kagent-dev/kagent#3566. That PR is on kagent main but not in v1.0.0, so these changes go to the main docs (content/kagent/main/). The latest (1.0.0) docs are unchanged except where noted.

  • Install (CLI): the quick install is two lines: export OPENAI_API_KEY=... and curl -sL https://kagent.dev/install | bash && kagent install. A new "Customize the CLI installation" section covers --provider, --version pinning, the supported platforms, passing Helm values through the CLI config file (including global.clusterDomain, which kagent install does not detect), and what the installer sets up.
  • Default Harnesses: documents kagent-default, codex-default and claude-default, and that spec.harnessRef is namespace-local. The Helm path covers harnesses.enabled, harnesses.snapshotLocation (default s3://ate-snapshots/kagent/) and harnesses.<runtime>.enabled. A verify step lists the Harnesses.
  • grpcurl guides: kagent install users no longer set config.server.grpcReflection (Helm installs still do). A new grpcurl-reflection snippet explains that reflection needs the configured authentication: anonymous in insecure mode, credentials otherwise. The examples in the identity page are updated to match.
  • Debug: golden build failures caused by an image pull now show could not pull image <ref>.
  • UI: the guide describes the Harness and Agent form changes, editing Harnesses in place, the ModelConfig dropdowns, and the update-failure reason on the agent page.

Shared snippets (affect latest too)

  • install-cli.md now uses curl -sL https://kagent.dev/install | bash, with --version as an option. This works for 1.0.0: I ran the live script with and without --version v1.0.0, and both installed the 1.0.0 CLI.
  • grpcurl-prerequisites.md is gated with version include-if: latest keeps the 1.0.0 grpcReflection step and main gets the new reflection text. I checked both on the preview.

Blog

  • The self-managed sandboxes post installs the CLI with curl -sL https://kagent.dev/install | bash -s -- --version v1.0.0 instead of the raw GitHub URL.

Testing

  • CI and preview deploy pass. On the preview, latest/examples/a2a-agents and main/examples/a2a-agents show the correct grpcurl prerequisite. The main install page shows the two-line install, and the latest install page is unchanged.
  • Ran get-kagent from https://kagent.dev/install against v1.0.0, pinned and unpinned.
  • The Hugo build was not run locally beyond the CI preview.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Docs preview

Link Points at
Branch preview The newest push to this branch. Updates in place.
Commit preview 41dbe55 only. Frozen.

Both are uploaded Worker versions and serve no production traffic.

EItanya and others added 3 commits November 10, 2026 00:20
Hold until a kagent release that includes #3566 ships and the version
conref is bumped.

- CLI install: drop the grpcReflection values file and take --provider
  instead of a config file for the provider. Keep the clusterDomain step,
  since kagent install does not detect the domain; the CLI config file now
  lives there.
- Install the CLI with curl -sL https://kagent.dev/install | bash, which
  installs the newest release; --version pins one. List the published
  platforms.
- Document the kagent-default, codex-default and claude-default Harnesses
  (namespace-local to the release namespace), the harnesses.* Helm values
  with the s3://ate-snapshots/kagent/ default, and add a verify step.
- grpcurl guides: drop the grpcReflection step for kagent install (Helm
  installs still set it) and explain that reflection needs the same
  authentication as other gRPC calls, in a shared grpcurl-reflection
  snippet.
- Debug: golden build image-pull failures now name the image.
- UI: describe the Harness and Agent form improvements, ModelConfig
  dropdowns and the agent page's update-failure reason.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io>
The CLI install is now:

  export OPENAI_API_KEY=...
  curl -sL https://kagent.dev/install | bash && kagent install

kagent install defaults to the kagent namespace and waits for the
install before printing next steps, so the namespace flag, the rollout
wait and the tool list are gone from the main path. Providers, pinning
a release, platforms, Helm values (including clusterDomain) and what the
installer sets up move to a "Customize the CLI installation" section.
The Helm path sets the API key in its own Secret step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io>
The docs split into latest (kagent 1.0.0) and main (kagent main) after
this branch started. kagent install turns reflection on only after
kagent-dev/kagent#3566, which is not in 1.0.0, so the shared grpcurl
prerequisite keeps the grpcReflection step on latest and uses the new
reflection text on main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io>
@EItanya
EItanya force-pushed the docs/install-onboarding-3566 branch from f8947ce to 58e828c Compare November 10, 2026 00:21
@EItanya
EItanya marked this pull request as ready for review November 10, 2026 00:22
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io>
@EItanya EItanya changed the title Update kagent 1.x install docs for kagent-dev/kagent#3566 Simplify the kagent install docs for kagent-dev/kagent#3566 Nov 10, 2026
@sebbycorp
sebbycorp self-requested a review November 10, 2026 00:34
@sebbycorp
sebbycorp merged commit 7926bf2 into main Nov 10, 2026
4 checks passed
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.

2 participants