Skip to content

[Automated] Draft docs (kagent): refactor(adk): generate runtime configuration from protobuf - #626

Merged
Rachael-Graham merged 3 commits into
mainfrom
pr-tracker-draft-kagent-3162
Oct 19, 2026
Merged

Rachael-Graham merged 3 commits into
mainfrom
pr-tracker-draft-kagent-3162

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

kagent-dev/kagent#3162 — refactor(adk): generate runtime configuration from protobuf

Docs versions: 1.x (first shipped in v1.0.0-alpha14)

No code-path rule covers 30 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:

  • .gitignore
  • Makefile
  • STYLE.md
  • docs/architecture/configuration-and-compilation.md
  • docs/architecture/process-configuration.md
  • docs/architecture/structured-output.md
  • ...and 24 more

What changes for users: BYO images that use the kagent Go or Python ADK helpers must use the runtime configuration contract from the same release as the controller. The delivered /config/config.json document now uses the protobuf-backed ADKConfig shape, so Go code reads runtime settings with adk.ProcessConfig, runtime.ControlPlaneUrl, and the numeric runtime.GetPort() helper.

What the docs now say: The Run your own agent image example now shows the current Go helper API for reading /config/config.json and passing the runtime settings to app.New.

Not verified: No cluster; the steps and configuration are unrun.

How kagent-3162 was drafted, and what was not verified
  • Code PR: refactor(adk): generate runtime configuration from protobuf kagent#3162
  • Code issue: none linked
  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: 1.x; first shipped in v1.0.0-alpha14. This product publishes one rolling tree, so the release confirms that the change is out rather than choosing a separate version tree.
  • Category: scoped-edit / pr

Plan, and what changed it

  • Planned: Update the BYO agent example that shows how an image reads the runtime configuration from /config/config.json.
  • Learned: the code diff and changed-functions.md show the helper API moved from compiled.ProcessConfig() to adk.ProcessConfig(compiled), and a grep found the same stale sample on docs-site/content/kagent/1.x/agents/bring-your-own-agent.md, which was not in the work-list targets.
  • Did: Updated examples/a2a-byo.md, wrote a breaking-change release note, and reported the non-target stale page for follow-up.

Why a documentation change is necessary

The pull request changes the private runtime configuration contract that BYO images consume. The authorized example page showed Go code that calls the removed compiled.ProcessConfig() method and reads old field names. A reader who follows that sample against the shipped release gets code that does not compile, before they can run the BYO agent image.

What changed on disk

  • docs-site/content/kagent/1.x/examples/a2a-byo.md: Updated the BYO Go code sample to call adk.ProcessConfig(compiled), read runtime.ControlPlaneUrl, and pass the numeric port through fmt.Sprint(cmp.Or(runtime.GetPort(), 80)).

How to verify this change

  1. Build a BYO image from a checkout that uses v1.0.0-alpha14 or the same source revision as the installed controller; the Go code that reads /config/config.json compiles with adk.ProcessConfig, runtime.ControlPlaneUrl, and runtime.GetPort().
  2. Apply the Harness, AgentTemplate, and Agent resources from docs-site/content/kagent/1.x/examples/a2a-byo.md.
  3. Run kagent agent invoke --session $SESSION_ID --task "hello"; the command returns BYO agent response.

What was not verified

  • The configuration was not applied to a cluster.
  • docs-site/content/kagent/1.x/agents/bring-your-own-agent.md also contains the old Go helper API, but that page was not an authorized target in this work-list.
  • the code diff was truncated. The following changed files were not inspected: go/adk/examples/oneshot/testdata/anthropic.json, go/adk/examples/oneshot/testdata/anthropic_vertexai.json, go/adk/examples/oneshot/testdata/azure_openai.json, go/adk/examples/oneshot/testdata/bedrock.json, go/adk/examples/oneshot/testdata/gemini.json, go/adk/examples/oneshot/testdata/gemini_vertexai.json, go/adk/examples/oneshot/testdata/ollama.json, go/adk/examples/oneshot/testdata/openai.json, go/adk/examples/oneshot/testdata/openai_custom.json, go/adk/pkg/a2a/executor_test.go, go/adk/pkg/agent/agent_test.go, go/adk/pkg/agent/compaction_test.go, go/adk/pkg/agent/createllm_test.go, go/adk/pkg/agent/generation_config_test.go, go/adk/pkg/agent/testdata/config_anthropic.json, go/adk/pkg/agent/testdata/config_ollama.json, go/adk/pkg/agent/testdata/config_openai.json, go/adk/pkg/agent/testdata/config_openai_params.json, go/adk/pkg/config/agentplugins_test.go, go/adk/pkg/config/config_loader_test.go, go/adk/pkg/config/config_usage_test.go, go/adk/pkg/embedding/embedding_test.go, go/adk/pkg/embedding/foundry_embedding_test.go, go/adk/pkg/mcp/registry_test.go, go/adk/pkg/memory/kagent_service_grpc_test.go, go/adk/pkg/models/bedrock_test.go, go/adk/pkg/models/openai_adk_test.go, go/adk/pkg/models/openai_responses_test.go, go/adk/pkg/models/tls_test.go, go/api/adk/runtime_test.go, go/api/adk/testdata/agent.json, go/api/adk/testdata/numeric_cases.json, go/api/adk/testdata/runtime.json, go/api/adk/types_test.go, go/api/gen/kagent/api/v1alpha1/adk.pb.go, go/api/gen/kagent/api/v1alpha1/config.pb.go, go/api/v1alpha3/configuration_crd_cel_test.go, go/api/v1alpha3/modelconfig_cel_test.go, go/api/v1alpha3/zz_generated.deepcopy.go, go/core/internal/controller/collections_test.go, go/core/internal/controller/preparation_test.go, go/core/internal/controller/status_test.go, go/core/internal/grpcserver/agenttemplate_harness_test.go, go/core/internal/image/validation_test.go, and go/core/internal/translator/adkconfig/builder_test.go.
How the pages were chosen (triage report)

Feature clusters

Kept apart on purpose. Merging wrongly produces a guide that documents two things and explains neither, so these are reported for a person to merge rather than grouped automatically:

Draft a documentation change

kagent-dev/kagent#3162 — refactor(adk): generate runtime configuration from protobuf

  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: 1.x
  • Summary (read from the body): Stacked on #3151, which is stacked on #3153, using GitHub's native stack.
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 30 touched file(s). The candidate pages below come from the files that DID match a rule, so they may scope this narrower than the change is. Read these before deciding the change is only about the pages listed:
    • .gitignore
    • Makefile
    • STYLE.md
    • docs/architecture/configuration-and-compilation.md
    • docs/architecture/process-configuration.md
    • docs/architecture/structured-output.md
    • ...and 24 more

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


Important

The test suite has not run on this pull request. It was opened by github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. This repository's checks are held as action_required until somebody presses Approve and run on the Checks tab. Checks that come from GitHub Apps rather than Actions, such as DCO, run on their own.

Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.

actions-user and others added 3 commits October 19, 2026 18:14
…iguration from protobuf

Signed-off-by: GitHub Action <action@github.com>
Signed-off-by: Rachael Graham <rachael.graham@solo.io>
@Rachael-Graham
Rachael-Graham merged commit c112fa6 into main Oct 19, 2026
4 checks passed
@Rachael-Graham
Rachael-Graham deleted the pr-tracker-draft-kagent-3162 branch October 19, 2026 21:19
@github-actions

Copy link
Copy Markdown
Contributor Author

Docs preview

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

Both are uploaded Worker versions and serve no production traffic.

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