Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions src/app/docs/kagent/resources/api-ref/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,24 @@ _Appears in:_



#### AgentProvider



AgentProvider identifies the organization responsible for an agent on its A2A AgentCard.



_Appears in:_
- [AgentSpec](#agentspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `organization` _string_ | Organization is the name of the agent provider's organization. | | MinLength: 1 <br /> |
| `url` _string_ | URL is a URL for the agent provider's website or relevant documentation. | | Format: uri <br /> |


#### AgentSkill


Expand Down Expand Up @@ -422,6 +440,10 @@ _Appears in:_
| `byo` _[BYOAgentSpec](#byoagentspec)_ | BYO configures a "bring your own" agent backed by a user-provided<br />container image. Kagent deploys the image and expects it to serve the<br />agent over the A2A protocol on port 8080.<br />Required if type is BYO. | | |
| `declarative` _[DeclarativeAgentSpec](#declarativeagentspec)_ | Declarative configures an agent that is fully described by this resource<br />(model, instructions, tools) and runs on one of kagent's built-in runtimes.<br />Required if type is Declarative. | | |
| `description` _string_ | | | |
| `iconUrl` _string_ | IconURL is a URL to an icon representing the agent. It is surfaced on the<br />agent's A2A AgentCard. | | Format: uri <br /> |
| `documentationUrl` _string_ | DocumentationURL is a URL to human-readable documentation for the agent. It<br />is surfaced on the agent's A2A AgentCard. | | Format: uri <br /> |
| `version` _string_ | Version is the agent's version string, surfaced on the A2A AgentCard. | | |
| `provider` _[AgentProvider](#agentprovider)_ | Provider identifies the organization responsible for the agent. It is<br />surfaced on the agent's A2A AgentCard. | | |
| `skills` _[SkillForAgent](#skillforagent)_ | Skills to load into the agent. They will be pulled from the specified container images.<br />and made available to the agent under the `/skills` folder. | | |
| `sandbox` _[SandboxConfig](#sandboxconfig)_ | Sandbox configures sandboxed execution behavior shared across runtimes.<br />This is intended for sandboxed declarative execution today, and can also<br />be consumed by BYO agents. | | |
| `allowedNamespaces` _[AllowedNamespaces](#allowednamespaces)_ | AllowedNamespaces defines which namespaces are allowed to reference this Agent as a tool.<br />This follows the Gateway API pattern for cross-namespace route attachments.<br />If not specified, only Agents in the same namespace can reference this Agent as a tool.<br />This field only applies when this Agent is used as a tool by another Agent.<br />See: https://gateway-api.sigs.k8s.io/guides/multiple-ns/#cross-namespace-route-attachment | | |
Expand Down Expand Up @@ -1334,6 +1356,10 @@ _Appears in:_
| `byo` _[BYOAgentSpec](#byoagentspec)_ | BYO configures a "bring your own" agent backed by a user-provided<br />container image. Kagent deploys the image and expects it to serve the<br />agent over the A2A protocol on port 8080.<br />Required if type is BYO. | | |
| `declarative` _[DeclarativeAgentSpec](#declarativeagentspec)_ | Declarative configures an agent that is fully described by this resource<br />(model, instructions, tools) and runs on one of kagent's built-in runtimes.<br />Required if type is Declarative. | | |
| `description` _string_ | | | |
| `iconUrl` _string_ | IconURL is a URL to an icon representing the agent. It is surfaced on the<br />agent's A2A AgentCard. | | Format: uri <br /> |
| `documentationUrl` _string_ | DocumentationURL is a URL to human-readable documentation for the agent. It<br />is surfaced on the agent's A2A AgentCard. | | Format: uri <br /> |
| `version` _string_ | Version is the agent's version string, surfaced on the A2A AgentCard. | | |
| `provider` _[AgentProvider](#agentprovider)_ | Provider identifies the organization responsible for the agent. It is<br />surfaced on the agent's A2A AgentCard. | | |
| `skills` _[SkillForAgent](#skillforagent)_ | Skills to load into the agent. They will be pulled from the specified container images.<br />and made available to the agent under the `/skills` folder. | | |
| `sandbox` _[SandboxConfig](#sandboxconfig)_ | Sandbox configures sandboxed execution behavior shared across runtimes.<br />This is intended for sandboxed declarative execution today, and can also<br />be consumed by BYO agents. | | |
| `allowedNamespaces` _[AllowedNamespaces](#allowednamespaces)_ | AllowedNamespaces defines which namespaces are allowed to reference this Agent as a tool.<br />This follows the Gateway API pattern for cross-namespace route attachments.<br />If not specified, only Agents in the same namespace can reference this Agent as a tool.<br />This field only applies when this Agent is used as a tool by another Agent.<br />See: https://gateway-api.sigs.k8s.io/guides/multiple-ns/#cross-namespace-route-attachment | | |
Expand Down
1 change: 1 addition & 0 deletions src/app/docs/kagent/resources/helm/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ A Helm chart for kagent, built with Google ADK
| database.postgres.bundled.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]}}` | Container-level security context for the bundled PostgreSQL container. |
| database.postgres.bundled.storage | string | `"500Mi"` | PersistentVolumeClaim size for demo PostgreSQL data |
| database.postgres.bundled.storageClassName | string | `""` | StorageClass for the PostgreSQL PVC. Defaults to the cluster default when empty. |
| database.postgres.skipMigrations | bool | `false` | Skip running database migrations at controller startup. The controller instead verifies the database is already migrated and fails if it is not. Migrations must be applied out-of-band (e.g. from a CI/CD pipeline) before install/upgrade. |
| database.postgres.url | string | `""` | External PostgreSQL connection string. Is always used if set regardless of the `.bundled.enabled` field. |
| database.postgres.urlFile | string | `""` | Path to a file containing the database URL. Takes precedence over url when set. Is always used if set regardless of the `.bundled.enabled` field. |
| database.postgres.vectorEnabled | bool | `false` | Enable the pgvector migration Required to use features that depend on database vector capability. (e.g. long-term memory) Set to true when using an external PostgreSQL that has the pgvector extension installed. |
Expand Down
Loading