Repository navigation
[Automated] Draft docs (kagent): refactor(adk): generate runtime configuration from protobuf - #626
Merged
Merged
Conversation
…iguration from protobuf Signed-off-by: GitHub Action <action@github.com>
Signed-off-by: Rachael Graham <rachael.graham@solo.io>
Rachael-Graham
approved these changes
Oct 19, 2026
Contributor
Author
Docs preview
Both are uploaded Worker versions and serve no production traffic. |
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
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.
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:
.gitignoreMakefileSTYLE.mddocs/architecture/configuration-and-compilation.mddocs/architecture/process-configuration.mddocs/architecture/structured-output.mdWhat 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.jsondocument now uses the protobuf-backedADKConfigshape, so Go code reads runtime settings withadk.ProcessConfig,runtime.ControlPlaneUrl, and the numericruntime.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.jsonand passing the runtime settings toapp.New.Not verified: No cluster; the steps and configuration are unrun.
How
kagent-3162was drafted, and what was not verifiedPlan, and what changed it
/config/config.json.changed-functions.mdshow the helper API moved fromcompiled.ProcessConfig()toadk.ProcessConfig(compiled), and a grep found the same stale sample ondocs-site/content/kagent/1.x/agents/bring-your-own-agent.md, which was not in the work-list targets.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 calladk.ProcessConfig(compiled), readruntime.ControlPlaneUrl, and pass the numeric port throughfmt.Sprint(cmp.Or(runtime.GetPort(), 80)).How to verify this change
/config/config.jsoncompiles withadk.ProcessConfig,runtime.ControlPlaneUrl, andruntime.GetPort().docs-site/content/kagent/1.x/examples/a2a-byo.md.kagent agent invoke --session $SESSION_ID --task "hello"; the command returnsBYO agent response.What was not verified
docs-site/content/kagent/1.x/agents/bring-your-own-agent.mdalso contains the old Go helper API, but that page was not an authorized target in this work-list.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, andgo/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
kagent-dev/website.gitignoreMakefileSTYLE.mddocs/architecture/configuration-and-compilation.mddocs/architecture/process-configuration.mddocs/architecture/structured-output.mdDraft branch:
pr-tracker-draft-kagent-3162Important
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 asaction_requireduntil 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.