Repository navigation
[Automated] Draft docs (kagent): refactor: simplify config parsing and compiler inputs - #628
Merged
Merged
Conversation
…d compiler inputs Signed-off-by: GitHub Action <action@github.com>
Signed-off-by: Rachael Graham <rachael.graham@solo.io>
Contributor
Author
Docs preview
Both are uploaded Worker versions and serve no production traffic. |
Rachael-Graham
approved these changes
Oct 19, 2026
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#3179 — refactor: simplify config parsing and compiler inputs
Docs versions:
1.x(first shipped in v1.0.0-alpha14)No code-path rule covers 14 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:
docs/architecture/process-configuration.mdgo/api/gen/kagent/api/v1alpha1/config.pb.gogo/core/internal/controller/collections.gogo/core/internal/controller/reconciler.gogo/core/internal/controller/runtime.gogo/core/internal/translator/images.goWhat changes for users: Controller configuration files now follow strict YAML-to-JSON conversion followed by ProtoJSON. Field
nullmeans unset, YAML anchors and merge keys are resolved before duplicate-key checks, only the first YAML document is read, and omitted or zeroconfig.database.pool.minConnsmeans zero minimum connections.What the docs now say: The Operational considerations page now describes the parser behavior for duplicate keys, quoted booleans, YAML 1.1 scalars, anchors, merge keys, null values, and multiple documents. The PostgreSQL pool row now clarifies that
minConnsdiffers from the optional pool fields.Not verified: No cluster; the configuration and commands are unrun.
How
kagent-3179was drafted, and what was not verifiedPlan, and what changed it
minConnsdefault on the page that already documentsconfig.database.pool.minConnschanged to an ordinary scalar and the local target page already owned both controller parsing rules and pool sizing.docs-site/content/kagent/1.x/operations/operational-considerations.mdand left the other code-path target pages unchanged.Why a documentation change is necessary
The pull request changes the controller config loader to use strict YAML conversion followed by ProtoJSON, and the code diff documents how null values, merge keys, aliases, scalar conversion, quoted booleans, and multiple documents behave. The target page still said that null values, YAML aliases or merges, and files with more than one document are rejected. The same page also said that omitting all pool fields keeps pgx defaults, but the diff changes
database.pool.minConnsso omission and explicit zero both mean zero.What changed on disk
docs-site/content/kagent/1.x/operations/operational-considerations.md— Updated controller configuration parsing rules and clarifiedconfig.database.pool.minConnsdefault behavior.How to verify this change
Create a controller config file that uses the documented accepted parser behavior.
Validate the file. The command should finish without an error, because
minConns: nullis unset and only the first YAML document is read.Change
minConnsto a value greater thanmaxConnsand validate again. The command should fail because the effective minimum connection count exceedsmaxConns.What was not verified
helm,kubectl, andkagentcommands in the guide and report are unrun.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#3179 — refactor: simplify config parsing and compiler inputs
kagent-dev/websiteCompilerSettingsandBuiltinImagesand passes the existing protobuf config messages directly to the compilers. Release validation stays at startup, and the translator still selects and validates Harness images. Config files now use strict YAML-to-JSON conversion followed by ProtoJSON, with the library's parsing behavior documented instead of maintaining a custom YAML tree walker.docs/architecture/process-configuration.mdgo/api/gen/kagent/api/v1alpha1/config.pb.gogo/core/internal/controller/collections.gogo/core/internal/controller/reconciler.gogo/core/internal/controller/runtime.gogo/core/internal/translator/images.goDraft branch:
pr-tracker-draft-kagent-3179Important
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.