Repository navigation
[Automated] Draft docs (kagent): api/models: update ModelProviderConfig discovery contract - #728
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…ig discovery contract Signed-off-by: GitHub Action <action@github.com>
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.
The target's own content scan fails where the base build passed (docs-theme-extras
markdown-leaks/built-html-integrity):kagent-dev/kagent#3494 — api/models: update ModelProviderConfig discovery contract
Docs versions:
mainNo code-path rule covers 6 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:
go/api/clientset/versioned/typed/api/v1alpha3/api_client.gogo/api/clientset/versioned/typed/api/v1alpha3/fake/fake_api_client.gogo/api/clientset/versioned/typed/api/v1alpha3/fake/fake_modelproviderconfig.gogo/api/clientset/versioned/typed/api/v1alpha3/generated_expansion.gogo/api/clientset/versioned/typed/api/v1alpha3/modelproviderconfig.gogo/core/internal/service/model/discovery.goWhat changes for users: ModelProviderConfig now separates credentials for model discovery from credentials for the generated ModelConfigs. Discovery is OpenAI-compatible only, cached model inventories are no longer stored in status, and a non-refresh model lookup returns NotFound.
What the docs now say: The model providers guide now documents ModelProviderConfig discovery credentials, generated ModelConfig invocation credentials, endpoint constraints, and status fields. The 0.x upgrade guide now converts the old
spec.secretRefinto bothspec.discoveryAuth.secretRefandspec.modelConfigTemplate.auth.secretRef.How
kagent-3494was draftedPlan, and what changed it
setup/model-providers/about-model-providers.mdandoperations/upgrade-from-0x.mdowned the changed ModelProviderConfig behavior.Why a documentation change is necessary
The pull request adds
spec.discoveryAuthandspec.modelConfigTemplate, removes cached model inventory fields from ModelProviderConfig status, and changes non-refresh model lookup to return NotFound. The model providers guide did not explain ModelProviderConfig discovery at all, so readers could not learn that discovery credentials are not inherited by generated ModelConfigs. The 0.x upgrade guide already convertedspec.secretReftospec.discoveryAuth.secretRef, but that conversion left generated ModelConfigs without the invocation credential that the new API requires explicitly.How to verify this change
setup/model-providers/about-model-providers.md.kubectl get modelproviderconfig llm-gateway -n kagent -o yamland check thatspec.discoveryAuth.secretRef.name,spec.discoveryAuth.secretRef.key,spec.modelConfigTemplate.auth.secretRef.name, andspec.modelConfigTemplate.auth.secretRef.keyare present.operations/upgrade-from-0x.mdagainst an exportedv1alpha2ModelProviderConfig that hasspec.secretRef.name; the converted file should contain bothspec.discoveryAuth.secretRefandspec.modelConfigTemplate.auth.secretRefwith<secret-key>placeholders.Proposed release note
No
proposed-release-note.mdwritten becausemarkers.notes_placeableis false. Suggested note text: ModelProviderConfig now separates credentials for model discovery from credentials for generated ModelConfigs, supports only OpenAI-compatible discovery endpoints, and no longer stores model inventories in status. Setspec.discoveryAuth.secretReffor discovery andspec.modelConfigTemplate.authfor invocation credentials.Files in this pull request
docs-site/content/kagent/main/operations/upgrade-from-0x.mddocs-site/content/kagent/main/setup/model-providers/about-model-providers.mdHow the pages were chosen (triage report)
Draft a documentation change
kagent-dev/kagent#3494 — api/models: update ModelProviderConfig discovery contract
kagent-dev/websitego/api/clientset/versioned/typed/api/v1alpha3/api_client.gogo/api/clientset/versioned/typed/api/v1alpha3/fake/fake_api_client.gogo/api/clientset/versioned/typed/api/v1alpha3/fake/fake_modelproviderconfig.gogo/api/clientset/versioned/typed/api/v1alpha3/generated_expansion.gogo/api/clientset/versioned/typed/api/v1alpha3/modelproviderconfig.gogo/core/internal/service/model/discovery.goDraft branch:
pr-tracker-draft-kagent-3494Important
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.