From 5b8f5097a3abc9f9c203146c7a66f1b23c122b55 Mon Sep 17 00:00:00 2001 From: Rachael-Graham <29711887+Rachael-Graham@users.noreply.github.com> Date: Wed, 4 Nov 2026 23:13:52 +0000 Subject: [PATCH] docs: Update kagent 1.x reference docs at v1.0.0-rc2 Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../versions/agent-substrate-chart.md | 2 +- .../kagent-docs/versions/agent-substrate.md | 2 +- .../assets/kagent-docs/versions/kagent.md | 2 +- .../versions/runtime-image-claude.md | 2 +- .../versions/runtime-image-codex.md | 2 +- .../kagent-docs/versions/runtime-image.md | 2 +- .../content/kagent/1.x/reference/api-ref.md | 65 ++++++++++++++----- 7 files changed, 53 insertions(+), 24 deletions(-) diff --git a/docs-site/assets/kagent-docs/versions/agent-substrate-chart.md b/docs-site/assets/kagent-docs/versions/agent-substrate-chart.md index bfff33f4..12c42733 100644 --- a/docs-site/assets/kagent-docs/versions/agent-substrate-chart.md +++ b/docs-site/assets/kagent-docs/versions/agent-substrate-chart.md @@ -1 +1 @@ -{{< version include-if="0.x" >}}0.0.9{{< /version >}}{{< version include-if="1.x" >}}1.0.0-rc1{{< /version >}} \ No newline at end of file +{{< version include-if="0.x" >}}0.0.9{{< /version >}}{{< version include-if="1.x" >}}1.0.0-rc2{{< /version >}} \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/agent-substrate.md b/docs-site/assets/kagent-docs/versions/agent-substrate.md index bfff33f4..12c42733 100644 --- a/docs-site/assets/kagent-docs/versions/agent-substrate.md +++ b/docs-site/assets/kagent-docs/versions/agent-substrate.md @@ -1 +1 @@ -{{< version include-if="0.x" >}}0.0.9{{< /version >}}{{< version include-if="1.x" >}}1.0.0-rc1{{< /version >}} \ No newline at end of file +{{< version include-if="0.x" >}}0.0.9{{< /version >}}{{< version include-if="1.x" >}}1.0.0-rc2{{< /version >}} \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/kagent.md b/docs-site/assets/kagent-docs/versions/kagent.md index a2dc7563..9c30e1db 100644 --- a/docs-site/assets/kagent-docs/versions/kagent.md +++ b/docs-site/assets/kagent-docs/versions/kagent.md @@ -1 +1 @@ -{{< version include-if="0.x" >}}0.10.3{{< /version >}}{{< version include-if="1.x" >}}1.0.0-rc1{{< /version >}} \ No newline at end of file +{{< version include-if="0.x" >}}0.10.3{{< /version >}}{{< version include-if="1.x" >}}1.0.0-rc2{{< /version >}} \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/runtime-image-claude.md b/docs-site/assets/kagent-docs/versions/runtime-image-claude.md index d7f30fc6..9bddf8cb 100644 --- a/docs-site/assets/kagent-docs/versions/runtime-image-claude.md +++ b/docs-site/assets/kagent-docs/versions/runtime-image-claude.md @@ -1 +1 @@ -ghcr.io/kagent-dev/kagent/claude-harness@sha256:359f8d8107df0ac5b0ebb306b0bc2e8d0ae0c3eae4540fe909724f1d8379dad5 \ No newline at end of file +ghcr.io/kagent-dev/kagent/claude-harness@sha256:c61047f0a9000f207c597beae15207622a08f2c79323d51e1d36d39f812c9a5d \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/runtime-image-codex.md b/docs-site/assets/kagent-docs/versions/runtime-image-codex.md index e49ce169..e84c381d 100644 --- a/docs-site/assets/kagent-docs/versions/runtime-image-codex.md +++ b/docs-site/assets/kagent-docs/versions/runtime-image-codex.md @@ -1 +1 @@ -ghcr.io/kagent-dev/kagent/codex-harness@sha256:c26d94cc976a9388a77687d4dc932d4cb8e5f814e762ea7fd47cf7167bb30f97 \ No newline at end of file +ghcr.io/kagent-dev/kagent/codex-harness@sha256:183f447a7be6536ac12f2778e7cd6cedc7013c605c5706ecb673738c3db5844b \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/runtime-image.md b/docs-site/assets/kagent-docs/versions/runtime-image.md index 9904c21c..2246cf08 100644 --- a/docs-site/assets/kagent-docs/versions/runtime-image.md +++ b/docs-site/assets/kagent-docs/versions/runtime-image.md @@ -1 +1 @@ -ghcr.io/kagent-dev/kagent/golang-adk@sha256:5b06741be8cb69c9293477bdbf3203c6526127c533fa940fd9f595a82a801701 \ No newline at end of file +ghcr.io/kagent-dev/kagent/golang-adk@sha256:1f2f72c1743dad076beb4a7d12c1d6313f3814ec5ab56204c99783747a8451bc \ No newline at end of file diff --git a/docs-site/content/kagent/1.x/reference/api-ref.md b/docs-site/content/kagent/1.x/reference/api-ref.md index 2aabb822..6f9c961f 100644 --- a/docs-site/content/kagent/1.x/reference/api-ref.md +++ b/docs-site/content/kagent/1.x/reference/api-ref.md @@ -30,6 +30,7 @@ The gateway injects the token; its value never enters the runtime. _Appears in:_ - [EgressAuthentication](#egressauthentication) - [ModelConfigSpec](#modelconfigspec) +- [ModelInvocationAuth](#modelinvocationauth) - [RemoteMCPServerSpec](#remotemcpserverspec) | Field | Description | Default | Validation | @@ -179,6 +180,7 @@ following the pattern used by Gateway API for cross-namespace route attachments. By default (when not specified), only references from the same namespace are allowed. _Appears in:_ +- [DiscoveredModelConfigTemplate](#discoveredmodelconfigtemplate) - [ModelConfigSpec](#modelconfigspec) - [RemoteMCPServerSpec](#remotemcpserverspec) @@ -342,6 +344,18 @@ _Appears in:_ | `name` _string_ | | | MinLength: 1
**Required**
| | `key` _string_ | | | MinLength: 1
**Required**
| +#### DiscoveredModelConfigTemplate + +DiscoveredModelConfigTemplate supplies shared settings for discovered ModelConfigs. + +_Appears in:_ +- [ModelProviderConfigSpec](#modelproviderconfigspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `auth` _[ModelInvocationAuth](#modelinvocationauth)_ | Auth configures invocation credentials. Omit to add no explicit credentials.
Discovery credentials are not inherited. | | AtMostOneOf: [actorJwt secretRef tokenPassthrough]
| +| `allowedNamespaces` _[AllowedNamespaces](#allowednamespaces)_ | AllowedNamespaces controls which namespaces may reference discovered models
and their invocation credentials. Omitted policy permits only the same namespace. | | | + #### EgressAuthentication EgressAuthentication replaces a request header with a prefix and credential. @@ -460,6 +474,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | +| `baseUrl` _string_ | BaseURL is the complete API prefix for a custom Gemini endpoint, including
any required version (for example, https://gateway.example.com/team/v1).
The client appends /models/\{model\}:generateContent or its streaming equivalent.
Authentication for custom endpoints uses apiKeySecret or actorJwt, when configured. | | MinLength: 1
Pattern: `^https?://[^/?#@ ]+(/[^?# ]*)?$`
| | `maxOutputTokens` _integer_ | Maximum output tokens to generate for a single response | | Minimum: 1
| #### GeminiVertexAIConfig @@ -699,6 +714,34 @@ _Appears in:_ | `observedGeneration` _integer_ | | | | | `secretHash` _string_ | The secret hash stores a hash of any secrets required by the model config (i.e. api key, tls cert) to ensure agents referencing this model config detect changes to these secrets and restart if necessary. | | | +#### ModelDiscoveryAuth + +ModelDiscoveryAuth supplies a Bearer token for discovery requests. + +_Appears in:_ +- [ModelProviderConfigSpec](#modelproviderconfigspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `secretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | SecretRef selects the discovery Bearer token from a Secret in the
ModelProviderConfig's namespace. The selected value must be nonempty. | | **Required**
| + +#### ModelInvocationAuth + +ModelInvocationAuth selects invocation credentials using ModelConfig auth semantics. +Secret references resolve in the ModelProviderConfig and generated ModelConfig namespace. + +_Validation:_ +- AtMostOneOf: [actorJwt secretRef tokenPassthrough] + +_Appears in:_ +- [DiscoveredModelConfigTemplate](#discoveredmodelconfigtemplate) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `actorJwt` _[ActorJWT](#actorjwt)_ | ActorJWT authenticates as the executing Actor. Substrate mints and injects the token. | | | +| `secretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#secretkeyselector-v1-core)_ | SecretRef selects the invocation API key from a Secret in the
ModelProviderConfig and generated ModelConfig namespace. | | | +| `tokenPassthrough` _boolean_ | TokenPassthrough forwards the incoming A2A bearer token to the model provider. | | | + #### ModelProvider _Underlying type:_ _string_ @@ -750,9 +793,10 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `type` _[ModelProvider](#modelprovider)_ | Type is the model provider type (OpenAI, Anthropic, etc.) | | Enum: [Anthropic OpenAI AzureOpenAI Ollama Gemini GeminiVertexAI AnthropicVertexAI Bedrock SAPAICore Foundry Mistral]
**Required**
| -| `endpoint` _string_ | Endpoint is the API endpoint URL for the provider.
If not specified, the default endpoint for the provider type will be used. | | Pattern: `^https?://.*`
| -| `secretRef` _[SecretReference](#secretreference)_ | SecretRef references the Kubernetes Secret containing the API key.
Optional for providers that don't require authentication (e.g., local Ollama). | | | +| `type` _[ModelProvider](#modelprovider)_ | Type is the discovery protocol. OpenAI-compatible endpoints are supported. | | Enum: [Anthropic OpenAI AzureOpenAI Ollama Gemini GeminiVertexAI AnthropicVertexAI Bedrock SAPAICore Foundry Mistral]
**Required**
| +| `endpoint` _string_ | Endpoint is the API endpoint URL for the provider.
If not specified, the default endpoint for the provider type will be used. | | Pattern: `^https?://[^/?#@]+(/[^?#]*)?$`
| +| `discoveryAuth` _[ModelDiscoveryAuth](#modeldiscoveryauth)_ | DiscoveryAuth authenticates requests to list models. Omit for unauthenticated discovery.
These credentials are never used to invoke discovered models. | | | +| `modelConfigTemplate` _[DiscoveredModelConfigTemplate](#discoveredmodelconfigtemplate)_ | ModelConfigTemplate configures the ModelConfigs created for discovered models
in this ModelProviderConfig's namespace. | | | #### ModelProviderConfigStatus @@ -765,10 +809,7 @@ _Appears in:_ | --- | --- | --- | --- | | `observedGeneration` _integer_ | ObservedGeneration reflects the generation of the most recently observed ModelProviderConfig spec | | | | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#condition-v1-meta) array_ | Conditions represent the latest available observations of the ModelProviderConfig's state | | | -| `discoveredModels` _string array_ | DiscoveredModels is the cached list of model IDs available from this model provider | | | | `modelCount` _integer_ | ModelCount is the number of discovered models (for kubectl display) | | | -| `lastDiscoveryTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta)_ | LastDiscoveryTime is the timestamp of the last successful model discovery | | | -| `secretHash` _string_ | SecretHash is a hash of the referenced secret data, used to detect secret changes | | | #### ObjectReference @@ -1044,18 +1085,6 @@ _Appears in:_ | --- | --- | --- | --- | | `image` _string_ | Image is an OCI image reference pinned by sha256 digest. | | Pattern: `^[^[:space:]@]+@sha256:[a-f0-9]\{64\}$`
**Required**
| -#### SecretReference - -SecretReference references a Kubernetes Secret that must contain exactly one data key -holding the API key or credential. - -_Appears in:_ -- [ModelProviderConfigSpec](#modelproviderconfigspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | Name is the name of the secret in the same namespace as the ModelProviderConfig. | | **Required**
| - #### SubAgentToolBinding SubAgentToolBinding exposes a same-namespace AgentTemplate as a logical tool.