From e668d2f0313f3061c0cbd1facf1df86aac942dbb Mon Sep 17 00:00:00 2001 From: Rachael Graham Date: Tue, 22 Sep 2026 15:04:27 -0500 Subject: [PATCH] docs: add product and Helm chart name conrefs for the enterprise import The enterprise import rebases these pages verbatim into solo-io/docs, so 1.x prose arrived downstream saying "kagent" where it should say "Solo Enterprise for kagent", and the install commands pointed at the OSS chart. Adds four conrefs under assets/kagent-docs/snippets/ and wires them up: - helm-path, helm-kagent and helm-kagent-crds across the 8 chart references in setup/installation, agents/agent-memory, observability/audit-prompts, observability/tracing and operations/operational-considerations. helm-path deliberately carries the whole structural difference between the two registries (/helm vs /charts) so that no literal left at a call site is correct for only one side. Release names and the kagent namespace stay literal, being identical on both sides. - name-product at the first product mention on 24 pages. Component names such as the kagent controller and the kagent CLI, link text, headings, reference/community.md and the generated reference/helm.md are left alone. Rendered output on this site does not change: every conref resolves to the value that was previously inline. Co-Authored-By: Claude Opus 5 (1M context) Signed-off-by: Rachael Graham --- docs-site/assets/kagent-docs/snippets/helm-kagent-crds.md | 1 + docs-site/assets/kagent-docs/snippets/helm-kagent.md | 1 + docs-site/assets/kagent-docs/snippets/helm-path.md | 1 + docs-site/assets/kagent-docs/snippets/name-product.md | 1 + docs-site/content/kagent/1.x/_index.md | 2 +- docs-site/content/kagent/1.x/about/_index.md | 2 +- docs-site/content/kagent/1.x/about/core-concepts.md | 2 +- docs-site/content/kagent/1.x/about/what-is-kagent.md | 2 +- docs-site/content/kagent/1.x/agents/agent-memory.md | 2 +- docs-site/content/kagent/1.x/agents/bring-your-own-agent.md | 2 +- docs-site/content/kagent/1.x/agents/system-prompts.md | 2 +- docs-site/content/kagent/1.x/examples/a2a-agents.md | 2 +- .../content/kagent/1.x/get-started/your-first-agent.md | 2 +- docs-site/content/kagent/1.x/observability/audit-prompts.md | 6 +++--- docs-site/content/kagent/1.x/observability/launch-ui.md | 2 +- docs-site/content/kagent/1.x/observability/tracing.md | 6 +++--- docs-site/content/kagent/1.x/operations/debug.md | 2 +- .../kagent/1.x/operations/operational-considerations.md | 4 ++-- .../content/kagent/1.x/operations/tune-agent-substrate.md | 2 +- docs-site/content/kagent/1.x/operations/upgrade-from-0x.md | 2 +- docs-site/content/kagent/1.x/reference/faq.md | 2 +- docs-site/content/kagent/1.x/reference/glossary.md | 2 +- docs-site/content/kagent/1.x/reference/tools-ecosystem.md | 2 +- docs-site/content/kagent/1.x/reference/versions.md | 2 +- docs-site/content/kagent/1.x/setup/installation.md | 6 +++--- .../kagent/1.x/setup/model-providers/amazon-bedrock.md | 2 +- .../content/kagent/1.x/setup/model-providers/ollama.md | 2 +- .../content/kagent/1.x/setup/model-providers/sap-ai-core.md | 2 +- docs-site/content/kagent/1.x/substrate-runtime/identity.md | 2 +- 29 files changed, 36 insertions(+), 32 deletions(-) create mode 100644 docs-site/assets/kagent-docs/snippets/helm-kagent-crds.md create mode 100644 docs-site/assets/kagent-docs/snippets/helm-kagent.md create mode 100644 docs-site/assets/kagent-docs/snippets/helm-path.md create mode 100644 docs-site/assets/kagent-docs/snippets/name-product.md diff --git a/docs-site/assets/kagent-docs/snippets/helm-kagent-crds.md b/docs-site/assets/kagent-docs/snippets/helm-kagent-crds.md new file mode 100644 index 00000000..8a0dea42 --- /dev/null +++ b/docs-site/assets/kagent-docs/snippets/helm-kagent-crds.md @@ -0,0 +1 @@ +kagent-crds \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/snippets/helm-kagent.md b/docs-site/assets/kagent-docs/snippets/helm-kagent.md new file mode 100644 index 00000000..f8ea9653 --- /dev/null +++ b/docs-site/assets/kagent-docs/snippets/helm-kagent.md @@ -0,0 +1 @@ +kagent \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/snippets/helm-path.md b/docs-site/assets/kagent-docs/snippets/helm-path.md new file mode 100644 index 00000000..feb83db5 --- /dev/null +++ b/docs-site/assets/kagent-docs/snippets/helm-path.md @@ -0,0 +1 @@ +oci://ghcr.io/kagent-dev/kagent/helm \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/snippets/name-product.md b/docs-site/assets/kagent-docs/snippets/name-product.md new file mode 100644 index 00000000..f8ea9653 --- /dev/null +++ b/docs-site/assets/kagent-docs/snippets/name-product.md @@ -0,0 +1 @@ +kagent \ No newline at end of file diff --git a/docs-site/content/kagent/1.x/_index.md b/docs-site/content/kagent/1.x/_index.md index acd2827b..d5c70e62 100644 --- a/docs-site/content/kagent/1.x/_index.md +++ b/docs-site/content/kagent/1.x/_index.md @@ -6,4 +6,4 @@ weight: 10 author: kagent.dev --- -kagent 1.0 moves the runtime from Kubernetes Deployments to [Agent Substrate](https://github.com/agent-substrate/substrate), introducing Harness, AgentTemplate, and AgentInstance as the new API surface. For a summary of what changed in 1.0, see the [Release notes]({{< link path="reference/release-notes/1.0#100" >}}). \ No newline at end of file +{{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 moves the runtime from Kubernetes Deployments to [Agent Substrate](https://github.com/agent-substrate/substrate), introducing Harness, AgentTemplate, and AgentInstance as the new API surface. For a summary of what changed in 1.0, see the [Release notes]({{< link path="reference/release-notes/1.0#100" >}}). \ No newline at end of file diff --git a/docs-site/content/kagent/1.x/about/_index.md b/docs-site/content/kagent/1.x/about/_index.md index e2c087a0..0dbc1bab 100644 --- a/docs-site/content/kagent/1.x/about/_index.md +++ b/docs-site/content/kagent/1.x/about/_index.md @@ -5,4 +5,4 @@ weight: 20 author: kagent.dev --- -Learn what changed in kagent 1.0 and the vocabulary the rest of these docs build on. +Learn what changed in {{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 and the vocabulary the rest of these docs build on. diff --git a/docs-site/content/kagent/1.x/about/core-concepts.md b/docs-site/content/kagent/1.x/about/core-concepts.md index 2947d27d..596ad27d 100644 --- a/docs-site/content/kagent/1.x/about/core-concepts.md +++ b/docs-site/content/kagent/1.x/about/core-concepts.md @@ -7,7 +7,7 @@ author: kagent.dev ## kagent 1.0 -kagent 1.0 replaces the Deployment-based `Agent` custom resource with a new model built around **Harness**, **AgentTemplate**, and **AgentInstance**, running on [Agent Substrate]({{< link path="about/agent-substrate" >}}) instead of the plain Kubernetes Deployments that the 0.x model uses. This page defines the vocabulary that the rest of the 1.0 model docs use. If you already have a 0.x installation, see [Upgrade from 0.x]({{< link path="operations/upgrade-from-0x#recreate-your-resources" >}}), which maps each 0.x resource onto its 1.0 replacement. +{{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 replaces the Deployment-based `Agent` custom resource with a new model built around **Harness**, **AgentTemplate**, and **AgentInstance**, running on [Agent Substrate]({{< link path="about/agent-substrate" >}}) instead of the plain Kubernetes Deployments that the 0.x model uses. This page defines the vocabulary that the rest of the 1.0 model docs use. If you already have a 0.x installation, see [Upgrade from 0.x]({{< link path="operations/upgrade-from-0x#recreate-your-resources" >}}), which maps each 0.x resource onto its 1.0 replacement. The new model separates what an agent can do from how it is allowed to run: diff --git a/docs-site/content/kagent/1.x/about/what-is-kagent.md b/docs-site/content/kagent/1.x/about/what-is-kagent.md index cfd248a3..6e4724be 100644 --- a/docs-site/content/kagent/1.x/about/what-is-kagent.md +++ b/docs-site/content/kagent/1.x/about/what-is-kagent.md @@ -5,7 +5,7 @@ weight: 10 author: kagent.dev --- -kagent is an open-source, Kubernetes-native platform for running AI agents. It defines an agent's runtime and behavior as ordinary Kubernetes custom resources, governed by the same GitOps and observability that you already use for your other workloads, and runs each agent's conversation inside [Agent Substrate]({{< link path="about/agent-substrate" >}}), a sandboxed, suspend-and-resume compute layer built for bursty, mostly idle agent workloads. kagent works with every major large language model (LLM) provider. Agents run on kagent's own Go and Python engines, which build on Google's Agent Development Kit (ADK), on the Codex or Claude coding agents, or on an image of your own. +{{< reuse "kagent-docs/snippets/name-product.md" >}} is an open-source, Kubernetes-native platform for running AI agents. It defines an agent's runtime and behavior as ordinary Kubernetes custom resources, governed by the same GitOps and observability that you already use for your other workloads, and runs each agent's conversation inside [Agent Substrate]({{< link path="about/agent-substrate" >}}), a sandboxed, suspend-and-resume compute layer built for bursty, mostly idle agent workloads. kagent works with every major large language model (LLM) provider. Agents run on kagent's own Go and Python engines, which build on Google's Agent Development Kit (ADK), on the Codex or Claude coding agents, or on an image of your own. kagent was created at [Solo.io](https://www.solo.io) in 2025 and is a [Cloud Native Computing Foundation](https://www.cncf.io) sandbox project. diff --git a/docs-site/content/kagent/1.x/agents/agent-memory.md b/docs-site/content/kagent/1.x/agents/agent-memory.md index cb724339..9909d375 100644 --- a/docs-site/content/kagent/1.x/agents/agent-memory.md +++ b/docs-site/content/kagent/1.x/agents/agent-memory.md @@ -62,7 +62,7 @@ Memories are scoped to the agent and to the user who created them, and carry the 3. Upgrade your kagent installation with the values file. The `--reuse-values` flag keeps every value that you installed kagent with, such as the Agent Substrate settings, and adds only the values in this file. ```bash helm upgrade kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent --timeout 10m --reuse-values \ -f kagent-memory-values.yaml diff --git a/docs-site/content/kagent/1.x/agents/bring-your-own-agent.md b/docs-site/content/kagent/1.x/agents/bring-your-own-agent.md index 83a97e62..d5303139 100644 --- a/docs-site/content/kagent/1.x/agents/bring-your-own-agent.md +++ b/docs-site/content/kagent/1.x/agents/bring-your-own-agent.md @@ -5,7 +5,7 @@ weight: 20 author: kagent.dev --- -The `byo` runtime runs a container image that you build, and treats what is inside it as opaque. kagent still compiles the {{< gloss "Harness" >}}Harness{{< /gloss >}} and {{< gloss "AgentTemplate" >}}AgentTemplate{{< /gloss >}} into a {{< gloss "Revision" >}}revision{{< /gloss >}}, schedules that revision onto {{< gloss "Agent Substrate" >}}Agent Substrate{{< /gloss >}}, and routes conversations to it. What the image does with a message is yours to decide. Choose this runtime when you have an agent framework that kagent does not adapt, and you would rather bring the image than the integration. +The `byo` runtime runs a container image that you build, and treats what is inside it as opaque. {{< reuse "kagent-docs/snippets/name-product.md" >}} still compiles the {{< gloss "Harness" >}}Harness{{< /gloss >}} and {{< gloss "AgentTemplate" >}}AgentTemplate{{< /gloss >}} into a {{< gloss "Revision" >}}revision{{< /gloss >}}, schedules that revision onto {{< gloss "Agent Substrate" >}}Agent Substrate{{< /gloss >}}, and routes conversations to it. What the image does with a message is yours to decide. Choose this runtime when you have an agent framework that kagent does not adapt, and you would rather bring the image than the integration. ## What kagent runs and what your image runs diff --git a/docs-site/content/kagent/1.x/agents/system-prompts.md b/docs-site/content/kagent/1.x/agents/system-prompts.md index 760b08bd..66153634 100644 --- a/docs-site/content/kagent/1.x/agents/system-prompts.md +++ b/docs-site/content/kagent/1.x/agents/system-prompts.md @@ -5,7 +5,7 @@ weight: 30 author: kagent.dev --- -An {{< gloss "AgentTemplate" >}}AgentTemplate{{< /gloss >}}'s system prompt defines the agent's role and how it should behave. kagent resolves the prompt when it compiles a {{< gloss "Revision" >}}revision{{< /gloss >}}, so the text that an agent runs with is fixed for the life of an {{< gloss "AgentInstance" >}}AgentInstance{{< /gloss >}}. Editing the prompt affects instances created after the edit compiles, but not ones that are already running. +An {{< gloss "AgentTemplate" >}}AgentTemplate{{< /gloss >}}'s system prompt defines the agent's role and how it should behave. {{< reuse "kagent-docs/snippets/name-product.md" >}} resolves the prompt when it compiles a {{< gloss "Revision" >}}revision{{< /gloss >}}, so the text that an agent runs with is fixed for the life of an {{< gloss "AgentInstance" >}}AgentInstance{{< /gloss >}}. Editing the prompt affects instances created after the edit compiles, but not ones that are already running. ## Write an effective prompt diff --git a/docs-site/content/kagent/1.x/examples/a2a-agents.md b/docs-site/content/kagent/1.x/examples/a2a-agents.md index 347d4a15..3d524e81 100644 --- a/docs-site/content/kagent/1.x/examples/a2a-agents.md +++ b/docs-site/content/kagent/1.x/examples/a2a-agents.md @@ -5,7 +5,7 @@ weight: 30 author: kagent.dev --- -Every {{< gloss "AgentInstance" >}}AgentInstance{{< /gloss >}} is reachable over the {{< gloss "A2A" >}}A2A{{< /gloss >}} (Agent-to-Agent) protocol through the kagent controller. kagent uses the A2A protocol for its own agent traffic, rather than an extra interface beside it. The CLI, the [MCP server]({{< link path="examples/agents-via-mcp" >}}), and any client you write all take the same path. +Every {{< gloss "AgentInstance" >}}AgentInstance{{< /gloss >}} is reachable over the {{< gloss "A2A" >}}A2A{{< /gloss >}} (Agent-to-Agent) protocol through the kagent controller. {{< reuse "kagent-docs/snippets/name-product.md" >}} uses the A2A protocol for its own agent traffic, rather than an extra interface beside it. The CLI, the [MCP server]({{< link path="examples/agents-via-mcp" >}}), and any client you write all take the same path. This example uses [grpcurl](https://github.com/fullstorydev/grpcurl) to show the requests and replies directly. Real callers use an A2A client library rather than assembling requests by hand. diff --git a/docs-site/content/kagent/1.x/get-started/your-first-agent.md b/docs-site/content/kagent/1.x/get-started/your-first-agent.md index fbbcbf2f..0350bd48 100644 --- a/docs-site/content/kagent/1.x/get-started/your-first-agent.md +++ b/docs-site/content/kagent/1.x/get-started/your-first-agent.md @@ -5,7 +5,7 @@ weight: 10 author: kagent.dev --- -This guide walks you through creating an agent, from applying a Harness and an AgentTemplate to holding a conversation with the AgentInstance that they produce. You apply the Harness and the AgentTemplate as Kubernetes resources, and you create and talk to the AgentInstance with the kagent CLI. For definitions of each of these components, review the [core concepts]({{< link path="about/core-concepts" >}}). For an overview of how each component fits together in kagent, review the [architecture]({{< link path="about/architecture" >}}). For the complete schema of every field that this guide sets, see the [API reference]({{< link path="reference/api-ref" >}}). +This guide walks you through creating an agent, from applying a Harness and an AgentTemplate to holding a conversation with the AgentInstance that they produce. You apply the Harness and the AgentTemplate as Kubernetes resources, and you create and talk to the AgentInstance with the kagent CLI. For definitions of each of these components, review the [core concepts]({{< link path="about/core-concepts" >}}). For an overview of how each component fits together in {{< reuse "kagent-docs/snippets/name-product.md" >}}, review the [architecture]({{< link path="about/architecture" >}}). For the complete schema of every field that this guide sets, see the [API reference]({{< link path="reference/api-ref" >}}). ## Before you begin diff --git a/docs-site/content/kagent/1.x/observability/audit-prompts.md b/docs-site/content/kagent/1.x/observability/audit-prompts.md index 4da3e65b..08ad96c2 100644 --- a/docs-site/content/kagent/1.x/observability/audit-prompts.md +++ b/docs-site/content/kagent/1.x/observability/audit-prompts.md @@ -5,7 +5,7 @@ weight: 30 author: kagent.dev --- -Audit every prompt (input) and reply (output) that passes between your agents and their models. Security and compliance teams use these records to review how people use your kagent environment. For example, you can confirm that no request sends personally identifiable information (PII) to a model. You can also reconstruct the instructions that an agent received in an earlier conversation. +Audit every prompt (input) and reply (output) that passes between your agents and their models. Security and compliance teams use these records to review how people use your {{< reuse "kagent-docs/snippets/name-product.md" >}} environment. For example, you can confirm that no request sends personally identifiable information (PII) to a model. You can also reconstruct the instructions that an agent received in an earlier conversation. ## About prompt auditing @@ -212,7 +212,7 @@ Turning on auditing takes two changes. The chart setting installs the log export 1. Upgrade kagent to export audit events to the collector. The controller compiles these settings into every runtime revision that it builds from now on. ```bash helm upgrade kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent --reuse-values \ --set otel.logging.enabled=true \ @@ -379,7 +379,7 @@ To follow a request from its audit records into its trace, take the `trace_id` f 1. Turn the log exporter off again. ```bash helm upgrade kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent --reuse-values \ --set otel.logging.enabled=false diff --git a/docs-site/content/kagent/1.x/observability/launch-ui.md b/docs-site/content/kagent/1.x/observability/launch-ui.md index 40760351..64bde191 100644 --- a/docs-site/content/kagent/1.x/observability/launch-ui.md +++ b/docs-site/content/kagent/1.x/observability/launch-ui.md @@ -5,7 +5,7 @@ weight: 10 author: kagent.dev --- -The kagent UI is a read-and-write console for everything the controller knows about: the agents you defined, the conversations the agents hold, and the Agent Substrate capacity that those conversations run on. The kagent chart installs the UI alongside the controller, so a cluster that follows [Install kagent]({{< link path="setup/installation" >}}) already runs a UI instance. +The {{< reuse "kagent-docs/snippets/name-product.md" >}} UI is a read-and-write console for everything the controller knows about: the agents you defined, the conversations the agents hold, and the Agent Substrate capacity that those conversations run on. The kagent chart installs the UI alongside the controller, so a cluster that follows [Install kagent]({{< link path="setup/installation" >}}) already runs a UI instance. ## Before you begin diff --git a/docs-site/content/kagent/1.x/observability/tracing.md b/docs-site/content/kagent/1.x/observability/tracing.md index da2141ca..68fb89fe 100644 --- a/docs-site/content/kagent/1.x/observability/tracing.md +++ b/docs-site/content/kagent/1.x/observability/tracing.md @@ -5,7 +5,7 @@ weight: 20 author: kagent.dev --- -A trace records one agent request as a tree of timed spans, so you can see where a slow or failed request spent its time and which model and tool calls it made along the way. In kagent 1.0 a single request crosses two processes, the controller and the {{< gloss "Actor" >}}Actor{{< /gloss >}} that runs the agent, and a trace ties both halves together. +A trace records one agent request as a tree of timed spans, so you can see where a slow or failed request spent its time and which model and tool calls it made along the way. In {{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 a single request crosses two processes, the controller and the {{< gloss "Actor" >}}Actor{{< /gloss >}} that runs the agent, and a trace ties both halves together. ## About trace coverage @@ -151,7 +151,7 @@ Tracing is off by default. Turning it on is a Helm change, because the controlle 3. Upgrade the kagent Helm release. ```bash helm upgrade kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent \ --values values.yaml @@ -199,7 +199,7 @@ This behavior allows a kagent trace to arrive promptly rather than on the export 1. Disable tracing in the kagent Helm release. ```bash helm upgrade kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent --reuse-values \ --set otel.tracing.enabled=false diff --git a/docs-site/content/kagent/1.x/operations/debug.md b/docs-site/content/kagent/1.x/operations/debug.md index 81ad4395..925901a9 100644 --- a/docs-site/content/kagent/1.x/operations/debug.md +++ b/docs-site/content/kagent/1.x/operations/debug.md @@ -5,7 +5,7 @@ weight: 30 author: kagent.dev --- -Most kagent failures surface in one place: the readiness conditions that a {{< gloss "Harness" >}}Harness{{< /gloss >}} writes onto the {{< gloss "AgentTemplate" >}}AgentTemplate{{< /gloss >}} that it admits. This page explains where to read those conditions, how to tell the real failure from the ones that follow it, and how to work back from the symptoms that report nothing useful on their own. +Most {{< reuse "kagent-docs/snippets/name-product.md" >}} failures surface in one place: the readiness conditions that a {{< gloss "Harness" >}}Harness{{< /gloss >}} writes onto the {{< gloss "AgentTemplate" >}}AgentTemplate{{< /gloss >}} that it admits. This page explains where to read those conditions, how to tell the real failure from the ones that follow it, and how to work back from the symptoms that report nothing useful on their own. ## Where kagent reports status diff --git a/docs-site/content/kagent/1.x/operations/operational-considerations.md b/docs-site/content/kagent/1.x/operations/operational-considerations.md index 92529d69..4d6feada 100644 --- a/docs-site/content/kagent/1.x/operations/operational-considerations.md +++ b/docs-site/content/kagent/1.x/operations/operational-considerations.md @@ -5,7 +5,7 @@ weight: 10 author: kagent.dev --- -A default kagent installation is built for evaluation. It runs one controller replica against a bundled database, and places no constraints on the nodes that run agents. Production changes each of those. +A default {{< reuse "kagent-docs/snippets/name-product.md" >}} installation is built for evaluation. It runs one controller replica against a bundled database, and places no constraints on the nodes that run agents. Production changes each of those. ## Choose a database @@ -69,7 +69,7 @@ For production, run PostgreSQL outside the cluster's lifecycle so that a kagent ```bash helm upgrade --install kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent \ --values kagent.yaml diff --git a/docs-site/content/kagent/1.x/operations/tune-agent-substrate.md b/docs-site/content/kagent/1.x/operations/tune-agent-substrate.md index 9cb88f1b..dc746999 100644 --- a/docs-site/content/kagent/1.x/operations/tune-agent-substrate.md +++ b/docs-site/content/kagent/1.x/operations/tune-agent-substrate.md @@ -5,7 +5,7 @@ weight: 20 author: kagent.dev --- -kagent runs every agent on [Agent Substrate]({{< link path="about/agent-substrate" >}}), and a fresh installation is deliberately small: one {{< gloss "WorkerPool" >}}WorkerPool{{< /gloss >}} holding a single Worker, snapshots in whichever object storage the Agent Substrate installation was given, and the `gvisor` sandbox class. +{{< reuse "kagent-docs/snippets/name-product.md" >}} runs every agent on [Agent Substrate]({{< link path="about/agent-substrate" >}}), and a fresh installation is deliberately small: one {{< gloss "WorkerPool" >}}WorkerPool{{< /gloss >}} holding a single Worker, snapshots in whichever object storage the Agent Substrate installation was given, and the `gvisor` sandbox class. When preparing for real traffic to your agents, you can size the pool and check where snapshots land. Leave the sandbox class on `gvisor`. A pool set to any other class sits idle while turns time out. diff --git a/docs-site/content/kagent/1.x/operations/upgrade-from-0x.md b/docs-site/content/kagent/1.x/operations/upgrade-from-0x.md index 036c283e..e29b8839 100644 --- a/docs-site/content/kagent/1.x/operations/upgrade-from-0x.md +++ b/docs-site/content/kagent/1.x/operations/upgrade-from-0x.md @@ -5,7 +5,7 @@ weight: 40 author: kagent.dev --- -kagent 1.0 has no in-place upgrade path from the 0.10.x line. Moving to 1.0 means installing kagent fresh against a new database, and recreating your resources on it. When your installation runs 1.0, you can perform regular in-place upgrades for later minor releases. To review upgrade paths and versions, see [Version support]({{< link path="reference/versions#release-support-and-compatibility" >}}). For a summary of what 1.0 changes before you plan the move, see [Release notes]({{< link path="reference/release-notes/1.0#100" >}}). +{{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 has no in-place upgrade path from the 0.10.x line. Moving to 1.0 means installing kagent fresh against a new database, and recreating your resources on it. When your installation runs 1.0, you can perform regular in-place upgrades for later minor releases. To review upgrade paths and versions, see [Version support]({{< link path="reference/versions#release-support-and-compatibility" >}}). For a summary of what 1.0 changes before you plan the move, see [Release notes]({{< link path="reference/release-notes/1.0#100" >}}). ## In-place upgrade blockers diff --git a/docs-site/content/kagent/1.x/reference/faq.md b/docs-site/content/kagent/1.x/reference/faq.md index 4033ceb9..43ceec3b 100644 --- a/docs-site/content/kagent/1.x/reference/faq.md +++ b/docs-site/content/kagent/1.x/reference/faq.md @@ -8,7 +8,7 @@ author: kagent.dev ## How do I get started with kagent? -Install kagent first, with a {{< gloss "WorkerPool" >}}WorkerPool{{< /gloss >}} provisioned, by following [Install kagent]({{< link path="setup/installation" >}}). Then work through [Your first agent]({{< link path="get-started/your-first-agent" >}}), which applies a Harness and an AgentTemplate and holds a conversation with the AgentInstance that they produce. Those two resources and that conversation are the model that the rest of these docs assume. [Your first MCP tool]({{< link path="get-started/your-first-mcp-tool" >}}) then gives that agent a tool. +Install {{< reuse "kagent-docs/snippets/name-product.md" >}} first, with a {{< gloss "WorkerPool" >}}WorkerPool{{< /gloss >}} provisioned, by following [Install kagent]({{< link path="setup/installation" >}}). Then work through [Your first agent]({{< link path="get-started/your-first-agent" >}}), which applies a Harness and an AgentTemplate and holds a conversation with the AgentInstance that they produce. Those two resources and that conversation are the model that the rest of these docs assume. [Your first MCP tool]({{< link path="get-started/your-first-mcp-tool" >}}) then gives that agent a tool. ## What makes kagent different from other agent frameworks? diff --git a/docs-site/content/kagent/1.x/reference/glossary.md b/docs-site/content/kagent/1.x/reference/glossary.md index c1148257..a9adcc60 100644 --- a/docs-site/content/kagent/1.x/reference/glossary.md +++ b/docs-site/content/kagent/1.x/reference/glossary.md @@ -5,6 +5,6 @@ weight: 90 author: kagent.dev --- -kagent 1.0 introduces vocabulary that the rest of these docs use without re-explaining: the resources you author, the runtime objects that the controller compiles them into, and the Agent Substrate primitives that run them. +{{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 introduces vocabulary that the rest of these docs use without re-explaining: the resources you author, the runtime objects that the controller compiles them into, and the Agent Substrate primitives that run them. {{< glossary-list >}} diff --git a/docs-site/content/kagent/1.x/reference/tools-ecosystem.md b/docs-site/content/kagent/1.x/reference/tools-ecosystem.md index 0118c97c..6c9ed652 100644 --- a/docs-site/content/kagent/1.x/reference/tools-ecosystem.md +++ b/docs-site/content/kagent/1.x/reference/tools-ecosystem.md @@ -5,7 +5,7 @@ weight: 40 author: kagent.dev --- -A kagent installation ships with two {{< gloss "Model Context Protocol" >}}Model Context Protocol{{< /gloss >}} (MCP) servers already registered, and you can register more of your own. This page is the catalog: what is installed, what each server serves, and how to narrow the set. For the schema that binds a server to an agent, see [About tools]({{< link path="skills-and-mcp/about-tools#mcp-tools" >}}). +A {{< reuse "kagent-docs/snippets/name-product.md" >}} installation ships with two {{< gloss "Model Context Protocol" >}}Model Context Protocol{{< /gloss >}} (MCP) servers already registered, and you can register more of your own. This page is the catalog: what is installed, what each server serves, and how to narrow the set. For the schema that binds a server to an agent, see [About tools]({{< link path="skills-and-mcp/about-tools#mcp-tools" >}}). ## Servers that a kagent installation registers diff --git a/docs-site/content/kagent/1.x/reference/versions.md b/docs-site/content/kagent/1.x/reference/versions.md index 911509ed..4faf08a9 100644 --- a/docs-site/content/kagent/1.x/reference/versions.md +++ b/docs-site/content/kagent/1.x/reference/versions.md @@ -5,7 +5,7 @@ weight: 60 author: kagent.dev --- -Only the latest kagent release is supported. The versions on this page apply to that release. +Only the latest {{< reuse "kagent-docs/snippets/name-product.md" >}} release is supported. The versions on this page apply to that release. ## What a kagent release includes diff --git a/docs-site/content/kagent/1.x/setup/installation.md b/docs-site/content/kagent/1.x/setup/installation.md index cd851cf4..8aabc446 100644 --- a/docs-site/content/kagent/1.x/setup/installation.md +++ b/docs-site/content/kagent/1.x/setup/installation.md @@ -5,7 +5,7 @@ weight: 10 author: kagent.dev --- -kagent 1.0 runs every agent on [Agent Substrate]({{< link path="about/agent-substrate" >}}), so an installation sets up two systems in the same cluster. Agent Substrate provides the sandboxed compute that agents run on, and kagent provides the Harness, AgentTemplate, and AgentInstance API that you author against. Install Agent Substrate first, because the kagent controller connects to it at startup. +{{< reuse "kagent-docs/snippets/name-product.md" >}} 1.0 runs every agent on [Agent Substrate]({{< link path="about/agent-substrate" >}}), so an installation sets up two systems in the same cluster. Agent Substrate provides the sandboxed compute that agents run on, and kagent provides the Harness, AgentTemplate, and AgentInstance API that you author against. Install Agent Substrate first, because the kagent controller connects to it at startup. > [!NOTE] > These steps install kagent 1.0 fresh. kagent 1.0 has no in-place upgrade from the 0.10.x version line, and installing its custom resource definitions replaces the ones that a 0.10.x installation uses. To move an existing installation, start with [Upgrade from 0.x]({{< link path="operations/upgrade-from-0x#in-place-upgrade-blockers" >}}). @@ -178,7 +178,7 @@ The kagent chart connects the controller to Agent Substrate and creates a Worker 1. Install the kagent CRDs. ```bash helm upgrade --install kagent-crds \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent-crds.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent --create-namespace --wait ``` @@ -186,7 +186,7 @@ The kagent chart connects the controller to Agent Substrate and creates a Worker 2. Install kagent with the Agent Substrate integration enabled. ```bash helm upgrade --install kagent \ - oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + {{< reuse "kagent-docs/snippets/helm-path.md" >}}/{{< reuse "kagent-docs/snippets/helm-kagent.md" >}} \ --version {{< reuse "kagent-docs/versions/kagent.md" >}} \ --namespace kagent --create-namespace --timeout 10m \ -f - <}} reaches it two ways: the native `Bedrock` provider, which is the fuller integration, and Bedrock's OpenAI-compatible endpoint through the `OpenAI` provider. Prefer the native provider. If you need the OpenAI request format, or an inference profile that only that endpoint exposes, use the OpenAI-compatible path. diff --git a/docs-site/content/kagent/1.x/setup/model-providers/ollama.md b/docs-site/content/kagent/1.x/setup/model-providers/ollama.md index c26d1fb5..ff5809d7 100644 --- a/docs-site/content/kagent/1.x/setup/model-providers/ollama.md +++ b/docs-site/content/kagent/1.x/setup/model-providers/ollama.md @@ -5,7 +5,7 @@ weight: 20 author: kagent.dev --- -[Ollama](https://ollama.com) runs large language models on hardware that you control. The `Ollama` provider points kagent at an Ollama server rather than at a hosted API, so it needs a host address instead of an API key. +[Ollama](https://ollama.com) runs large language models on hardware that you control. The `Ollama` provider points {{< reuse "kagent-docs/snippets/name-product.md" >}} at an Ollama server rather than at a hosted API, so it needs a host address instead of an API key. > [!IMPORTANT] > kagent agents call tools, so choose a model that supports function calling. A model without tool support connects successfully and then fails to use any tool that you bind to it. diff --git a/docs-site/content/kagent/1.x/setup/model-providers/sap-ai-core.md b/docs-site/content/kagent/1.x/setup/model-providers/sap-ai-core.md index 10ace7aa..d943135f 100644 --- a/docs-site/content/kagent/1.x/setup/model-providers/sap-ai-core.md +++ b/docs-site/content/kagent/1.x/setup/model-providers/sap-ai-core.md @@ -5,7 +5,7 @@ weight: 20 author: kagent.dev --- -kagent reaches SAP AI Core through its [Orchestration Service](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration), a single endpoint that serves models from several families, including Anthropic, OpenAI, Gemini, Amazon, Meta, and Mistral. Authentication uses OAuth2 client credentials from your SAP AI Core service key. +{{< reuse "kagent-docs/snippets/name-product.md" >}} reaches SAP AI Core through its [Orchestration Service](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration), a single endpoint that serves models from several families, including Anthropic, OpenAI, Gemini, Amazon, Meta, and Mistral. Authentication uses OAuth2 client credentials from your SAP AI Core service key. ## Create the ModelConfig diff --git a/docs-site/content/kagent/1.x/substrate-runtime/identity.md b/docs-site/content/kagent/1.x/substrate-runtime/identity.md index af417ce5..2658f4fc 100644 --- a/docs-site/content/kagent/1.x/substrate-runtime/identity.md +++ b/docs-site/content/kagent/1.x/substrate-runtime/identity.md @@ -5,7 +5,7 @@ weight: 30 author: kagent.dev --- -A kagent installation authenticates three different kinds of caller, and each one is handled by a different system. This page describes what each layer establishes, and what it does not. +A {{< reuse "kagent-docs/snippets/name-product.md" >}} installation authenticates three different kinds of caller, and each one is handled by a different system. This page describes what each layer establishes, and what it does not. - An operator applying a {{< gloss "Harness" >}}Harness{{< /gloss >}} is authenticated by [Kubernetes](#the-kubernetes-plane). - A caller creating or talking to an {{< gloss "AgentInstance" >}}AgentInstance{{< /gloss >}} is authenticated by [kagent's own gRPC API](#the-kagent-plane).