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
3 changes: 2 additions & 1 deletion assets/agw-docs/pages/operations/agctl-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Install `agctl`, the command-line tool that you use to inspect and debug agentga
| `agctl costs` | Manage the model cost catalogs that price LLM requests, including importing catalog data from supported pricing sources. |{{< /version >}}{{< version exclude-if="1.3.x,1.2.x,1.1.x,1.0.x,2.2.x" >}}
| `agctl catalog` | Manage the model catalogs that price LLM requests, including importing catalog data from supported pricing sources. |{{< /version >}}{{< version exclude-if="1.3.x,1.2.x,1.1.x,1.0.x,2.2.x" >}}
| `agctl migrate` | Migrate agentgateway resources to newer configurations. |{{< /version >}}
| `agctl version` | Print version information for the `agctl` CLI. |
| `agctl version` | Print version information for the `agctl` CLI. |{{< version include-if="main" >}}{{< conditional-text include-if="kubernetes" >}}
| `agctl bug-report` | Collect agentgateway resources, logs, and metrics from your cluster into an archive that you can attach to a bug report. Secret values are redacted. |{{< /conditional-text >}}{{< /version >}}
| `agctl completion` | Turn on autocompletion for your shell in `bash`, `zsh`, `fish`, or `powershell`. |

For a complete list of subcommands and flags, see the [`agctl` CLI reference]({{< link-hextra path="/reference/agctl/" >}}).
Expand Down
46 changes: 46 additions & 0 deletions assets/agw-docs/pages/reference/agctl/main/agctl-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Collect agentgateway resources, logs, and metrics into an archive

### Synopsis

Collect agentgateway resources, logs, and metrics into an archive for bug reports.

Captured resources are all Gateway API resources, and all resources with a category containing
"agentgateway". Services, ConfigMaps, Secrets, and Events are captured from every namespace holding one of
those resources, or the controller. Secret values are redacted.

Logs and metrics are captured from agentgateway proxy pods and all pods in the controller namespace.

```
agctl bug-report [flags]
```

### Examples

```
agctl bug-report
agctl bug-report -n team-a -n team-b --since 1h
agctl bug-report --config-dump -o /tmp/report.tar.gz
```

### Options

```
--config-dump Capture /config_dump from each proxy
-h, --help help for bug-report
-n, --namespace strings Only capture namespaced resources and proxies in these namespaces. The controller namespace is always captured.
-o, --output string Output archive (default "bug-report.tar.gz")
--since duration Only capture logs newer than this duration (default 24h0m0s)
--tail int Maximum log lines per container; 0 for no limit (default 5000)
--timeout duration Deadline for the whole collection; anything collected before it is still written (default 5m0s)
```

### Options inherited from parent commands

```
-k, --kubeconfig string kubeconfig
```

### SEE ALSO

* [agctl](../agctl/) - agctl controls and inspects Agentgateway resources

1 change: 1 addition & 0 deletions assets/agw-docs/pages/reference/agctl/main/agctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ agctl controls and inspects Agentgateway resources

### SEE ALSO

* [agctl bug-report](agctl_bug-report.md) - Collect agentgateway resources, logs, and metrics into an archive
* [agctl catalog](../agctl-catalog/) - Manage model catalogs
* [agctl controller](../agctl-controller/) - Inspect and manage the agentgateway controller
* [agctl migrate](../agctl-migrate/) - Migrate agentgateway resources to newer configurations
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -716,9 +716,9 @@
port: 443
targetPort: 8443
protocol: TCP</code></pre></div></div><details class="ks-validation"><summary class="ks-validation-summary">Validation</summary><div class="ks-validation-body"><div class="ks-validation-item"><span class="ks-validation-label">Preserve unknown fields</span><span class="ks-validation-value">true</span></div></div></details><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (3)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/customize/">documentation/setup/customize/customize</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../integrations/llm/providers/azure/">integrations/llm/providers/azure</a></div></div></details></div></template>
<template data-ks-field-panel="p14"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-complex">object[]</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Container environment variables. These override any existing<br />values. If you want to delete an environment variable entirely, use<br /><code class="ks-inline-code">$patch: delete</code> with an overlay instead. Note that<br />[variable<br />expansion](https://kubernetes.io/docs/tasks/inject-data-application/define-interdependent-environment-variables/)<br />does apply, but is highly discouraged -- to set dependent environment<br />variables, you can use <code class="ks-inline-code">$(VAR_NAME)</code>, but it's highly discouraged.<br /><code class="ks-inline-code">$$(VAR_NAME)</code> avoids expansion and results in a literal<br /><code class="ks-inline-code">$(VAR_NAME)</code>.</div><div class="ks-rich-block">If <code class="ks-inline-code">SESSION_KEY</code> is specified, it takes precedence over the<br />controller-managed per-<code class="ks-inline-code">Gateway</code> session key <code class="ks-inline-code">Secret</code>.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (2)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/guardrails/webhook/guardrails/">documentation/llm/guardrails/webhook/guardrails</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p15"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-string">string</span><span class="ks-detail-required">Required</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Name of the environment variable.<br />May consist of any printable ASCII characters except '='.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (2)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/guardrails/webhook/guardrails/">documentation/llm/guardrails/webhook/guardrails</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p16"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-string">string</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Variable references $(VAR_NAME) are expanded<br />using the previously defined environment variables in the container and<br />any service environment variables. If a variable cannot be resolved,<br />the reference in the input string will be unchanged. Double $$ are reduced<br />to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.<br />&quot;$$(VAR_NAME)&quot; will produce the string literal &quot;$(VAR_NAME)&quot;.<br />Escaped references will never be expanded, regardless of whether the variable<br />exists or not.<br />Defaults to &quot;&quot;.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (2)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/guardrails/webhook/guardrails/">documentation/llm/guardrails/webhook/guardrails</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p14"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-complex">object[]</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Container environment variables. These override any existing<br />values. If you want to delete an environment variable entirely, use<br /><code class="ks-inline-code">$patch: delete</code> with an overlay instead. Note that<br />[variable<br />expansion](https://kubernetes.io/docs/tasks/inject-data-application/define-interdependent-environment-variables/)<br />does apply, but is highly discouraged -- to set dependent environment<br />variables, you can use <code class="ks-inline-code">$(VAR_NAME)</code>, but it's highly discouraged.<br /><code class="ks-inline-code">$$(VAR_NAME)</code> avoids expansion and results in a literal<br /><code class="ks-inline-code">$(VAR_NAME)</code>.</div><div class="ks-rich-block">If <code class="ks-inline-code">SESSION_KEY</code> is specified, it takes precedence over the<br />controller-managed per-<code class="ks-inline-code">Gateway</code> session key <code class="ks-inline-code">Secret</code>.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (3)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/guardrails/webhook/guardrails/">documentation/llm/guardrails/webhook/guardrails</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/callout-proxy/">documentation/setup/customize/callout-proxy</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p15"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-string">string</span><span class="ks-detail-required">Required</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Name of the environment variable.<br />May consist of any printable ASCII characters except '='.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (3)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/guardrails/webhook/guardrails/">documentation/llm/guardrails/webhook/guardrails</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/callout-proxy/">documentation/setup/customize/callout-proxy</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p16"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-string">string</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Variable references $(VAR_NAME) are expanded<br />using the previously defined environment variables in the container and<br />any service environment variables. If a variable cannot be resolved,<br />the reference in the input string will be unchanged. Double $$ are reduced<br />to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.<br />&quot;$$(VAR_NAME)&quot; will produce the string literal &quot;$(VAR_NAME)&quot;.<br />Escaped references will never be expanded, regardless of whether the variable<br />exists or not.<br />Defaults to &quot;&quot;.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (3)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/guardrails/webhook/guardrails/">documentation/llm/guardrails/webhook/guardrails</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/callout-proxy/">documentation/setup/customize/callout-proxy</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p17"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-complex">object</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Source for the environment variable's value. Cannot be used if value is not empty.</div></div></div></template>
<template data-ks-field-panel="p18"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-complex">object</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Selects a key of a ConfigMap.</div></div><details class="ks-validation"><summary class="ks-validation-summary">Validation</summary><div class="ks-validation-body"><div class="ks-validation-item"><span class="ks-validation-label">Map type</span><span class="ks-validation-value">atomic</span></div></div></details></div></template>
<template data-ks-field-panel="p19"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-string">string</span><span class="ks-detail-required">Required</span></div><div class="ks-detail-desc"><div class="ks-rich-block">The key to select from the ConfigMap's Data field.<br />Keys in the BinaryData field are not currently propagated to container env vars.</div></div></div></template>
Expand Down Expand Up @@ -819,7 +819,7 @@
- name: everything
stdio:
cmd: npx
args: [&quot;@modelcontextprotocol/server-everything&quot;]</code></pre></div></div><details class="ks-validation"><summary class="ks-validation-summary">Validation</summary><div class="ks-validation-body"><div class="ks-validation-item"><span class="ks-validation-label">Preserve unknown fields</span><span class="ks-validation-value">true</span></div></div></details><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (2)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/cost-controls/dashboard/">documentation/llm/cost-controls/dashboard</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/customize/">documentation/setup/customize/customize</a></div></div></details></div></template>
args: [&quot;@modelcontextprotocol/server-everything&quot;]</code></pre></div></div><details class="ks-validation"><summary class="ks-validation-summary">Validation</summary><div class="ks-validation-body"><div class="ks-validation-item"><span class="ks-validation-label">Preserve unknown fields</span><span class="ks-validation-value">true</span></div></div></details><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (3)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/llm/cost-controls/dashboard/">documentation/llm/cost-controls/dashboard</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/callout-proxy/">documentation/setup/customize/callout-proxy</a></div><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/customize/">documentation/setup/customize/customize</a></div></div></details></div></template>
<template data-ks-field-panel="p62"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-complex">object</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Compute resources required by this container. See<br />https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/<br />for details.</div></div><details class="ks-validation ks-documentation"><summary class="ks-validation-summary">Documentation References (1)</summary><div class="ks-validation-body"><div class="ks-doc-link-row"><a class="ks-doc-link" href="../../../documentation/setup/customize/configs/">documentation/setup/customize/configs</a></div></div></details></div></template>
<template data-ks-field-panel="p63"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-complex">object[]</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Claims lists the names of resources, defined in spec.resourceClaims,<br />that are used by this container.</div><div class="ks-rich-block">This field depends on the<br />DynamicResourceAllocation feature gate.</div><div class="ks-rich-block">This field is immutable. It can only be set for containers.</div></div><details class="ks-validation"><summary class="ks-validation-summary">Validation</summary><div class="ks-validation-body"><div class="ks-validation-item"><span class="ks-validation-label">List type</span><span class="ks-validation-value">map</span></div><div class="ks-validation-item"><span class="ks-validation-label">List map keys</span><span class="ks-validation-value">name</span></div></div></details></div></template>
<template data-ks-field-panel="p64"><div class="ks-detail-card"><div class="ks-detail-path" data-ks-detail-path></div><div class="ks-detail-meta-line"><span class="ks-detail-type ks-type-string">string</span><span class="ks-detail-required">Required</span></div><div class="ks-detail-desc"><div class="ks-rich-block">Name must match the name of one entry in pod.spec.resourceClaims of<br />the Pod where this field is used. It makes that resource available<br />inside a container.</div></div></div></template>
Expand Down
Loading
Loading