Configuration options¶

Every agentSandbox.* option (201 total), generated from the kubenix modules via nixosOptionsDoc — this reference cannot drift from the code.

Type to filter; click an option to jump to its full entry.

agentSandbox.agent.availableModelsattribute set of attribute set of (submodule)

The model catalog, PROVIDER-FIRST: provider -> model id -> options. Model ids are provider-specific namespaces — "goose" runs Bedrock ids (us.anthropic.…) wh…

agentSandbox.agent.availableModels...defaultboolean

This provider's default model (at most one per provider; else the group's first entry).

agentSandbox.agent.availableModels...hintstring

Deployment guidance shown to the agent by the `list_models` MCP tool, steering when to pick this model (e.g. fast/cheap vs slow/powerful). Empty = no hint.

agentSandbox.agent.builtinSkillsboolean

Ship the platform's own skills, each only when the capability it documents is enabled (e.g. scooter-grafana only with broker.grafana.enable). Set false to su…

agentSandbox.agent.claudeCode.tokenSecretstring

When `agent.provider = "claude-code"`, the name of the Secret holding the long-lived subscription OAuth token (`claude setup-token`) under key `token`. Wired…

agentSandbox.agent.modelnull or string

DEPRECATED — use `availableModels..default = true` instead. When set, it's added to the offered set (back-compat for existing deploys) and, unless the `g…

agentSandbox.agent.namestring

Display name the agent goes by (AGENT_NAME) — its identity in the UI + prompt.

agentSandbox.agent.providerstring

GOOSE_PROVIDER for the real agent (e.g. aws_bedrock, anthropic).

agentSandbox.agent.regionstring

AWS_REGION for the agent process (Bedrock region).

agentSandbox.agent.remoteAgent.bridgeUrlstring

PUBLIC base URL of the BYOC controller's ingress — what the user's container dials (`/byoc/ws/` is appended per owner). DERIVED from `byoc.ingres…

agentSandbox.agent.remoteAgent.enableboolean

Bring-your-own-Claude remote agents (the Settings UI + agent-host mint/status routes). Defaults to `byoc.enable`: the controller and the host-side routes are…

agentSandbox.agent.remoteAgent.imagestring

The ghcr container image the Settings one-liner tells users to `docker run` (REMOTE_AGENT_IMAGE).

agentSandbox.agent.remoteAgent.joinSecretstring

Name of the Secret holding the HS256 signing key (key `secret`) the agent-host uses to sign + verify owner-bound join tokens. ONE server-side key (not per-us…

agentSandbox.agent.skillsattribute set of string

Markdown skills injected into the agent as .goosehints (filename -> content). Rendered to a ConfigMap mounted at SKILLS_DIR on the agent-host and read per co…

agentSandbox.auth.albRegionnull or string

Region for the ALB public-key endpoint. REQUIRED when albVerify = true (no silent default — the public-key host is region-specific).

agentSandbox.auth.albVerifyboolean

alb-oidc: verify the x-amzn-oidc-data JWT signature (fetch ALB's public key) before trusting its claims.

agentSandbox.auth.emailHeaderstring

header mode: request header carrying the user's email (optional; set by the ingress).

agentSandbox.auth.modeone of "header", "alb-oidc"

Identity source: `header` (default; a proxy sets userHeader/emailHeader) or `alb-oidc` (AWS ALB OIDC).

agentSandbox.auth.subEmailMapattribute set of string

Optional static map of user id (OIDC sub) -> email, seeding the learned identity store.

agentSandbox.auth.userHeaderstring

header mode: request header carrying the authenticated user id (set by the ingress).

agentSandbox.broker.aws.accountsattribute set of attribute set of anything

The account registry: alias -> { account_id, broker_role_arn, enabled, description?, allowed_policy?, allowed_managed_policies?, region?, approvers?, auto_ap…

agentSandbox.broker.aws.agentHostUrlstring

Agent-host URL — the broker notifies it to raise the approval interrupt.

agentSandbox.broker.aws.approverClaimone of "email", "id", "name"

Which identity claim authorizes an approver — must match how the FGA `approver` tuples are seeded (accounts..approvers, conventionally emails). The agent-…

agentSandbox.broker.aws.brokerPrincipalArnstring

The broker's IRSA role ARN — the principal the dynamic roles trust.

agentSandbox.broker.aws.enableboolean

Enable the AWS permissions provider (request/approve/provision dynamic IAM roles).

agentSandbox.broker.aws.externalIdstring

STS ExternalId used when the broker assumes each account's base role.

agentSandbox.broker.aws.fga.apiUrlstring

OpenFGA HTTP API URL.

agentSandbox.broker.aws.fga.authorizationModelIdstring

OpenFGA authorization-model id (optional; latest used if empty).

agentSandbox.broker.aws.fga.enableboolean

Enforce per-account approver authorization via OpenFGA. Deploys an openfga server.

agentSandbox.broker.aws.fga.imagestring

OpenFGA server image.

agentSandbox.broker.aws.fga.storeIdstring

OpenFGA store id (created out-of-band or by a seed step).

agentSandbox.broker.aws.regionstring

AWS region.

agentSandbox.broker.aws.roleTtlHourssigned integer

Dynamic-role TTL (refresh window).

agentSandbox.broker.aws.serviceAccountRoleArnstring

IRSA role ARN annotated on the broker SA (eks.amazonaws.com/role-arn). Usually == brokerPrincipalArn.

agentSandbox.broker.datadog.apiKeySecretsubmodule

Secret holding the Datadog API key. Injected as DATADOG_API_KEY. The secret must exist in the broker namespace.

agentSandbox.broker.datadog.apiKeySecret.keystring

Secret key holding the Datadog API key.

agentSandbox.broker.datadog.apiKeySecret.namestring

Secret name (in the broker namespace).

agentSandbox.broker.datadog.appKeySecretsubmodule

Secret holding the Datadog application key. Injected as DATADOG_APP_KEY. The secret must exist in the broker namespace.

agentSandbox.broker.datadog.appKeySecret.keystring

Secret key holding the Datadog application key.

agentSandbox.broker.datadog.appKeySecret.namestring

Secret name (in the broker namespace).

agentSandbox.broker.datadog.enableboolean

Enable the Datadog provider (http-proxy to api. with the two keys injected).

agentSandbox.broker.datadog.sitestring

agentSandbox.broker.enableboolean

Deploy the credential broker.

agentSandbox.broker.githubApp.appIdstring

GitHub App ID (GITHUB_APP_ID).

agentSandbox.broker.githubApp.enableboolean

Enable the GitHub provider, backed by a GitHub App (vends installation tokens for git/HTTPS + the API).

agentSandbox.broker.githubApp.installationIdstring

GitHub App installation ID (GITHUB_APP_INSTALLATION_ID).

agentSandbox.broker.githubApp.privateKeySecretsubmodule

Secret holding the GitHub App private key (PEM). The secret must exist in the broker namespace.

agentSandbox.broker.githubApp.privateKeySecret.keystring

Secret key holding the PEM.

agentSandbox.broker.githubApp.privateKeySecret.namestring

Secret name (in the broker namespace).

agentSandbox.broker.gitlab.enableboolean

Enable the GitLab provider (transparent http-proxy to gitlab.com with the token injected).

agentSandbox.broker.gitlab.tokenSecretsubmodule

Secret holding the GitLab token (glpat-…). Injected as GITLAB_TOKEN. The secret must exist in the broker namespace.

agentSandbox.broker.gitlab.tokenSecret.keystring

Secret key holding the GitLab token.

agentSandbox.broker.gitlab.tokenSecret.namestring

Secret name (in the broker namespace).

agentSandbox.broker.grafana.enableboolean

Enable the Grafana provider (http-proxy to a Grafana stack with a service-account token injected).

agentSandbox.broker.grafana.tokenSecretsubmodule

Secret holding a Grafana service-account token. Injected as GRAFANA_TOKEN. The secret must exist in the broker namespace.

agentSandbox.broker.grafana.tokenSecret.keystring

Secret key holding the Grafana service-account token.

agentSandbox.broker.grafana.tokenSecret.namestring

Secret name (in the broker namespace).

agentSandbox.broker.grafana.urlstring

Base URL of the Grafana stack. Upstream for /grafana/*; a trailing slash is stripped.

agentSandbox.broker.imagestring

OCI ref of the broker image.

agentSandbox.broker.jiraSiteUrlstring

The Jira SITE base URL, used to build a human /browse/{KEY} link when the broker auto-links an issue an agent creates via the Jira proxy (the create-issue AP…

agentSandbox.broker.shares.enableboolean

Enable static-share publishing (/shares + /s//). Persists to the shared Postgres `broker` DB.

agentSandbox.broker.shares.frameAncestorsstring

CSP frame-ancestors allowlist for embedding a served share in an (SHARES_FRAME_ANCESTORS) — the UI origin(s), space-separated. Empty -> defaults to…</p></div> <div class="opt-row" data-opt="agentsandbox.broker.shares.publicbaseurl external origin used to build the returned share url (shares_public_base_url). empty -> defaults to https://<ingress.host> when that is set, else a relative…"><a href="broker/#agentsandboxbrokersharespublicbaseurl"><code>agentSandbox.broker.shares.publicBaseUrl</code></a><span class="opt-type">string</span><p>External origin used to build the returned share URL (SHARES_PUBLIC_BASE_URL). Empty -> defaults to https://<ingress.host> when that is set, else a relative…</p></div> <div class="opt-row" data-opt="agentsandbox.broker.slack.bottokensecret secret holding the slack bot token (xoxb-…). injected as slack_bot_token. the secret must exist in the broker namespace."><a href="broker/#agentsandboxbrokerslackbottokensecret"><code>agentSandbox.broker.slack.botTokenSecret</code></a><span class="opt-type">submodule</span><p>Secret holding the Slack bot token (xoxb-…). Injected as SLACK_BOT_TOKEN. The secret must exist in the broker namespace.</p></div> <div class="opt-row" data-opt="agentsandbox.broker.slack.bottokensecret.key secret key holding the slack bot token."><a href="broker/#agentsandboxbrokerslackbottokensecretkey"><code>agentSandbox.broker.slack.botTokenSecret.key</code></a><span class="opt-type">string</span><p>Secret key holding the Slack bot token.</p></div> <div class="opt-row" data-opt="agentsandbox.broker.slack.bottokensecret.name secret name (in the broker namespace)."><a href="broker/#agentsandboxbrokerslackbottokensecretname"><code>agentSandbox.broker.slack.botTokenSecret.name</code></a><span class="opt-type">string</span><p>Secret name (in the broker namespace).</p></div> <div class="opt-row" data-opt="agentsandbox.broker.slack.enable enable the slack provider (http-proxy to slack.com/api with the bot token injected)."><a href="broker/#agentsandboxbrokerslackenable"><code>agentSandbox.broker.slack.enable</code></a><span class="opt-type">boolean</span><p>Enable the Slack provider (http-proxy to slack.com/api with the bot token injected).</p></div> <div class="opt-row" data-opt="agentsandbox.broker.testprovider enable the `test` (whoami) provider for credential e2e tests."><a href="broker/#agentsandboxbrokertestprovider"><code>agentSandbox.broker.testProvider</code></a><span class="opt-type">boolean</span><p>Enable the `test` (whoami) provider for credential e2e tests.</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.enable deploy the byoc (bring-your-own-claude) controller."><a href="byoc/#agentsandboxbyocenable"><code>agentSandbox.byoc.enable</code></a><span class="opt-type">boolean</span><p>Deploy the BYOC (bring-your-own-Claude) controller.</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.image oci ref of the byoc controller image."><a href="byoc/#agentsandboxbyocimage"><code>agentSandbox.byoc.image</code></a><span class="opt-type">string</span><p>OCI ref of the BYOC controller image.</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.ingress.annotations annotations on the byoc ingress — controller/cert config without auth. the endpoint must accept an unauthenticated websocket upgrade from the user's containe…"><a href="byoc/#agentsandboxbyocingressannotations"><code>agentSandbox.byoc.ingress.annotations</code></a><span class="opt-type">attribute set of string</span><p>Annotations on the BYOC Ingress — controller/cert config WITHOUT auth. The endpoint must accept an unauthenticated WebSocket upgrade from the user's containe…</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.ingress.classname spec.ingressclassname (the controller). empty = cluster default."><a href="byoc/#agentsandboxbyocingressclassname"><code>agentSandbox.byoc.ingress.className</code></a><span class="opt-type">string</span><p>spec.ingressClassName (the controller). Empty = cluster default.</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.ingress.enable expose /byoc/ via a standard ingress so a user's container can dial in. default on when the controller is enabled — a byoc controller nothing can reach is no…"><a href="byoc/#agentsandboxbyocingressenable"><code>agentSandbox.byoc.ingress.enable</code></a><span class="opt-type">boolean</span><p>Expose /byoc/ via a standard Ingress so a user's container can dial in. Default ON when the controller is enabled — a BYOC controller nothing can reach is no…</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.ingress.host public hostname for the byoc connect path (/byoc). defaults to the ui's own ingress host: this is a separate ingress object carrying only the /byoc path with…"><a href="byoc/#agentsandboxbyocingresshost"><code>agentSandbox.byoc.ingress.host</code></a><span class="opt-type">string</span><p>Public hostname for the BYOC connect path (/byoc). Defaults to the UI's own ingress host: this is a SEPARATE Ingress object carrying only the /byoc path with…</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.ingress.tls add a spec.tls entry for `host`."><a href="byoc/#agentsandboxbyocingresstls"><code>agentSandbox.byoc.ingress.tls</code></a><span class="opt-type">boolean</span><p>Add a spec.tls entry for `host`.</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.ingress.tlssecretname tls secret for the ingress host (empty = controller default)."><a href="byoc/#agentsandboxbyocingresstlssecretname"><code>agentSandbox.byoc.ingress.tlsSecretName</code></a><span class="opt-type">string</span><p>TLS secret for the ingress host (empty = controller default).</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.joinsecretname secret holding key `secret` — the hmac key for join tokens. the agent-host mints with the same key the controller verifies with, so by default this is litera…"><a href="byoc/#agentsandboxbyocjoinsecretname"><code>agentSandbox.byoc.joinSecretName</code></a><span class="opt-type">string</span><p>Secret holding key `secret` — the HMAC key for join tokens. The agent-host MINTS with the same key the controller VERIFIES with, so by default this is litera…</p></div> <div class="opt-row" data-opt="agentsandbox.byoc.tracetunnel emit a per-frame trace of the mcp tunnel (`[tunnel.trace] …`): the json-rpc method, direction, byte counts and http status of every stream, correlated by str…"><a href="byoc/#agentsandboxbyoctracetunnel"><code>agentSandbox.byoc.traceTunnel</code></a><span class="opt-type">boolean</span><p>Emit a per-frame trace of the MCP tunnel (`[tunnel.trace] …`): the JSON-RPC method, direction, byte counts and HTTP status of every stream, correlated by str…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.agenthostreplicas agent-host statefulset replicas when the controller is enabled (multi-replica)."><a href="conversationController/#agentsandboxconversationcontrolleragenthostreplicas"><code>agentSandbox.conversationController.agentHostReplicas</code></a><span class="opt-type">signed integer</span><p>agent-host StatefulSet replicas when the controller is enabled (multi-replica).</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.assets.accessmode access mode of the assets pvc. readwritemany because the multi-replica agent-host fleet all write assets and pods may land on different nodes (see #471). lef…"><a href="conversationController/#agentsandboxconversationcontrollerassetsaccessmode"><code>agentSandbox.conversationController.assets.accessMode</code></a><span class="opt-type">string</span><p>Access mode of the assets PVC. ReadWriteMany because the multi-replica agent-host fleet all write assets and pods may land on different nodes (see #471). Lef…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.assets.enable provision a dedicated pvc for asset storage (uploaded images, future media). bytes-only pvc: asset metadata (conversation_id, asset_id, mime_type, size, sha2…"><a href="conversationController/#agentsandboxconversationcontrollerassetsenable"><code>agentSandbox.conversationController.assets.enable</code></a><span class="opt-type">boolean</span><p>Provision a dedicated PVC for asset storage (uploaded images, future media). BYTES-ONLY PVC: asset metadata (conversation_id, asset_id, mime_type, size, sha2…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.assets.hostpath single-node escape hatch (e.g. k3d/odin, which have no rwx provisioner): back the assets pvc with a hostpath pv at this path so a readwritemany claim binds.…"><a href="conversationController/#agentsandboxconversationcontrollerassetshostpath"><code>agentSandbox.conversationController.assets.hostPath</code></a><span class="opt-type">null or string</span><p>Single-node escape hatch (e.g. k3d/odin, which have no RWX provisioner): back the assets PVC with a hostPath PV at this path so a ReadWriteMany claim binds.…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.assets.size size of the dedicated assets pvc (10gi ≈ 2000 images at 5mb each)."><a href="conversationController/#agentsandboxconversationcontrollerassetssize"><code>agentSandbox.conversationController.assets.size</code></a><span class="opt-type">string</span><p>Size of the dedicated assets PVC (10Gi ≈ 2000 images at 5MB each).</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.assets.storageclassname storageclassname for the assets pvc (null = cluster default). point at an rwx class (efs/nfs) on a real multi-node cluster. ignored when hostpath is set."><a href="conversationController/#agentsandboxconversationcontrollerassetsstorageclassname"><code>agentSandbox.conversationController.assets.storageClassName</code></a><span class="opt-type">null or string</span><p>storageClassName for the assets PVC (null = cluster default). Point at an RWX class (EFS/NFS) on a real multi-node cluster. Ignored when hostPath is set.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.autoscale the controller autoscales the agent-host deployment to fit conversation demand (desired = ceil(top-level conversations / podcap), clamped to [minreplicas, ma…"><a href="conversationController/#agentsandboxconversationcontrollerautoscale"><code>agentSandbox.conversationController.autoscale</code></a><span class="opt-type">boolean</span><p>The controller autoscales the agent-host Deployment to fit conversation demand (desired = ceil(top-level conversations / podCap), clamped to [minReplicas, ma…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.historymirror.accessmode access mode of the mirror pvc. readwritemany is required for the real multi-writer mirror (all pods append). left configurable only for the degenerate replic…"><a href="conversationController/#agentsandboxconversationcontrollerhistorymirroraccessmode"><code>agentSandbox.conversationController.historyMirror.accessMode</code></a><span class="opt-type">string</span><p>Access mode of the mirror PVC. ReadWriteMany is required for the real multi-writer mirror (all pods append). Left configurable only for the degenerate replic…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.historymirror.enable provision the shared history-mirror pvc + wire mirror_state_path into agent-host. on by default: cross-pod history revival is the point of multi-replica. set…"><a href="conversationController/#agentsandboxconversationcontrollerhistorymirrorenable"><code>agentSandbox.conversationController.historyMirror.enable</code></a><span class="opt-type">boolean</span><p>Provision the shared history-mirror PVC + wire MIRROR_STATE_PATH into agent-host. On by default: cross-pod history revival is the point of multi-replica. Set…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.historymirror.hostpath single-node escape hatch (e.g. odin, which has no rwx provisioner): back the mirror with a hostpath pv at this path so a readwritemany pvc binds. all agent-h…"><a href="conversationController/#agentsandboxconversationcontrollerhistorymirrorhostpath"><code>agentSandbox.conversationController.historyMirror.hostPath</code></a><span class="opt-type">null or string</span><p>Single-node escape hatch (e.g. odin, which has no RWX provisioner): back the mirror with a hostPath PV at this path so a ReadWriteMany PVC binds. All agent-h…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.historymirror.retainformigration keep the mirror pvc provisioned while the event log migrates to postgres, even once agent-host has stopped writing to it. the migration reads every conversat…"><a href="conversationController/#agentsandboxconversationcontrollerhistorymirrorretainformigration"><code>agentSandbox.conversationController.historyMirror.retainForMigration</code></a><span class="opt-type">boolean</span><p>Keep the mirror PVC provisioned while the event log migrates to Postgres, even once agent-host has stopped writing to it. The migration reads every conversat…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.historymirror.size size of the shared history-mirror pvc."><a href="conversationController/#agentsandboxconversationcontrollerhistorymirrorsize"><code>agentSandbox.conversationController.historyMirror.size</code></a><span class="opt-type">string</span><p>Size of the shared history-mirror PVC.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.historymirror.storageclassname storageclassname for the mirror pvc (null = cluster default). point at an rwx class (efs/nfs) on a real cluster. ignored when hostpath is set."><a href="conversationController/#agentsandboxconversationcontrollerhistorymirrorstorageclassname"><code>agentSandbox.conversationController.historyMirror.storageClassName</code></a><span class="opt-type">null or string</span><p>storageClassName for the mirror PVC (null = cluster default). Point at an RWX class (EFS/NFS) on a real cluster. Ignored when hostPath is set.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.image oci ref of the conversation-controller image."><a href="conversationController/#agentsandboxconversationcontrollerimage"><code>agentSandbox.conversationController.image</code></a><span class="opt-type">string</span><p>OCI ref of the conversation-controller image.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.maxreplicas autoscaler ceiling — never scale the agent-host above this."><a href="conversationController/#agentsandboxconversationcontrollermaxreplicas"><code>agentSandbox.conversationController.maxReplicas</code></a><span class="opt-type">signed integer</span><p>Autoscaler ceiling — never scale the agent-host above this.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.metricsport port the controller serves prometheus /metrics on (conversations-per-pod)."><a href="conversationController/#agentsandboxconversationcontrollermetricsport"><code>agentSandbox.conversationController.metricsPort</code></a><span class="opt-type">signed integer</span><p>Port the controller serves Prometheus /metrics on (conversations-per-pod).</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.minreplicas autoscaler floor — never scale the agent-host below this (a warm fleet)."><a href="conversationController/#agentsandboxconversationcontrollerminreplicas"><code>agentSandbox.conversationController.minReplicas</code></a><span class="opt-type">signed integer</span><p>Autoscaler floor — never scale the agent-host below this (a warm fleet).</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.orphangraceseconds only reap a sandbox with no owning conversation if it's older than this many seconds — long enough that a normal create has registered its conversation cr (t…"><a href="conversationController/#agentsandboxconversationcontrollerorphangraceseconds"><code>agentSandbox.conversationController.orphanGraceSeconds</code></a><span class="opt-type">signed integer</span><p>Only reap a Sandbox with no owning Conversation if it's older than this many seconds — long enough that a normal create has registered its Conversation CR (t…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.podcap max conversations assigned to one agent-host pod before it's considered full."><a href="conversationController/#agentsandboxconversationcontrollerpodcap"><code>agentSandbox.conversationController.podCap</code></a><span class="opt-type">signed integer</span><p>Max conversations assigned to one agent-host pod before it's considered full.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.reaporphans reap orphaned sandboxes — those with no owning conversation cr — destroying the whole per-conversation tree (sandbox + its serviceaccount + module configmap)…"><a href="conversationController/#agentsandboxconversationcontrollerreaporphans"><code>agentSandbox.conversationController.reapOrphans</code></a><span class="opt-type">boolean</span><p>Reap orphaned Sandboxes — those with no owning Conversation CR — destroying the whole per-conversation tree (Sandbox + its ServiceAccount + module ConfigMap)…</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.replicas controller replicas (leader-elected; >1 for availability, only the leader reconciles)."><a href="conversationController/#agentsandboxconversationcontrollerreplicas"><code>agentSandbox.conversationController.replicas</code></a><span class="opt-type">signed integer</span><p>Controller replicas (leader-elected; >1 for availability, only the leader reconciles).</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.routerimage oci ref of the conversation-router image."><a href="conversationController/#agentsandboxconversationcontrollerrouterimage"><code>agentSandbox.conversationController.routerImage</code></a><span class="opt-type">string</span><p>OCI ref of the conversation-router image.</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.routerreplicas router replicas (stateless proxy; fronts the agent-host service)."><a href="conversationController/#agentsandboxconversationcontrollerrouterreplicas"><code>agentSandbox.conversationController.routerReplicas</code></a><span class="opt-type">signed integer</span><p>Router replicas (stateless proxy; fronts the agent-host Service).</p></div> <div class="opt-row" data-opt="agentsandbox.conversationcontroller.scaledowncooldownseconds wait this long between scale-downs (hysteresis; scale-up is immediate)."><a href="conversationController/#agentsandboxconversationcontrollerscaledowncooldownseconds"><code>agentSandbox.conversationController.scaleDownCooldownSeconds</code></a><span class="opt-type">signed integer</span><p>Wait this long between scale-DOWNs (hysteresis; scale-up is immediate).</p></div> <div class="opt-row" data-opt="agentsandbox.agenthostimage oci ref of the agent-host image."><a href="core/#agentsandboxagenthostimage"><code>agentSandbox.agentHostImage</code></a><span class="opt-type">string</span><p>OCI ref of the agent-host image.</p></div> <div class="opt-row" data-opt="agentsandbox.fakeagent run the dummy acp agent (goose_bin=fake) — for cluster e2e."><a href="core/#agentsandboxfakeagent"><code>agentSandbox.fakeAgent</code></a><span class="opt-type">boolean</span><p>Run the dummy ACP agent (GOOSE_BIN=fake) — for cluster e2e.</p></div> <div class="opt-row" data-opt="agentsandbox.idlesuspendms idle window before the agent-host auto-suspends a conversation (drops the sandbox pod, keeps the pvcs). the agent-host owns the activity signal, so it self-m…"><a href="core/#agentsandboxidlesuspendms"><code>agentSandbox.idleSuspendMs</code></a><span class="opt-type">signed integer</span><p>Idle window before the agent-host auto-suspends a conversation (drops the sandbox pod, keeps the PVCs). The agent-host owns the activity signal, so it self-m…</p></div> <div class="opt-row" data-opt="agentsandbox.namespace namespace for the platform + sandboxes."><a href="core/#agentsandboxnamespace"><code>agentSandbox.namespace</code></a><span class="opt-type">string</span><p>Namespace for the platform + sandboxes.</p></div> <div class="opt-row" data-opt="agentsandbox.pullpolicy imagepullpolicy for the platform deployments. ifnotpresent suits side-loaded kind/k3s images; always suits a registry-backed cluster."><a href="core/#agentsandboxpullpolicy"><code>agentSandbox.pullPolicy</code></a><span class="opt-type">one of "Always", "IfNotPresent", "Never"</span><p>imagePullPolicy for the platform Deployments. IfNotPresent suits side-loaded kind/k3s images; Always suits a registry-backed cluster.</p></div> <div class="opt-row" data-opt="agentsandbox.registryprefix registry/repository prefix prepended to the default image names (agent-host, agent-broker, agent-webhooks, agent-sandbox-os). defaults to the published ghcr…"><a href="core/#agentsandboxregistryprefix"><code>agentSandbox.registryPrefix</code></a><span class="opt-type">string</span><p>Registry/repository prefix prepended to the default image names (agent-host, agent-broker, agent-webhooks, agent-sandbox-os). Defaults to the published ghcr…</p></div> <div class="opt-row" data-opt="agentsandbox.replicas agent-host replicas (one host pod runs many goose sessions)."><a href="core/#agentsandboxreplicas"><code>agentSandbox.replicas</code></a><span class="opt-type">signed integer</span><p>agent-host replicas (one host pod runs many goose sessions).</p></div> <div class="opt-row" data-opt="agentsandbox.retentionmaxagems retention reap: destroy (end — pod + pvcs + record) an unstarred conversation that has been inactive (no prompt/event) longer than this. age is measured from…"><a href="core/#agentsandboxretentionmaxagems"><code>agentSandbox.retentionMaxAgeMs</code></a><span class="opt-type">signed integer</span><p>Retention reap: DESTROY (end — pod + PVCs + record) an UNSTARRED conversation that has been inactive (no prompt/event) longer than this. Age is measured from…</p></div> <div class="opt-row" data-opt="agentsandbox.sandboximage oci ref of the generic nix sandbox image."><a href="core/#agentsandboxsandboximage"><code>agentSandbox.sandboxImage</code></a><span class="opt-type">string</span><p>OCI ref of the generic Nix sandbox image.</p></div> <div class="opt-row" data-opt="agentsandbox.sandboxresources resource requests/limits for each conversation's sandbox pod, as {requests = {cpu, memory}; limits = {cpu, memory};}. null = the agent-host default (guarante…"><a href="core/#agentsandboxsandboxresources"><code>agentSandbox.sandboxResources</code></a><span class="opt-type">null or (attribute set)</span><p>Resource requests/limits for each conversation's sandbox pod, as {requests = {cpu, memory}; limits = {cpu, memory};}. null = the agent-host default (Guarante…</p></div> <div class="opt-row" data-opt="agentsandbox.sandboxruntimeclass runtimeclass for the per-conversation sandbox pod (the systemd-pid-1 image). a cgroup-delegating runtime (e.g. crun) gives the sandbox's systemd a writable c…"><a href="core/#agentsandboxsandboxruntimeclass"><code>agentSandbox.sandboxRuntimeClass</code></a><span class="opt-type">null or string</span><p>RuntimeClass for the per-conversation sandbox pod (the systemd-PID-1 image). A cgroup-delegating runtime (e.g. crun) gives the sandbox's systemd a writable c…</p></div> <div class="opt-row" data-opt="agentsandbox.sandboxviabroker route the sandbox lifecycle (create/suspend/resume/destroy + sizing) through the broker instead of the agent-host touching k8s directly (the control-plane mo…"><a href="core/#agentsandboxsandboxviabroker"><code>agentSandbox.sandboxViaBroker</code></a><span class="opt-type">boolean</span><p>Route the sandbox LIFECYCLE (create/suspend/resume/destroy + sizing) through the BROKER instead of the agent-host touching k8s directly (the control-plane mo…</p></div> <div class="opt-row" data-opt="agentsandbox.serviceaccountrolearn irsa role arn annotated onto the agent-host serviceaccount (eks.amazonaws.com/role-arn). the role's trust policy must allow system:serviceaccount:<namespace>…"><a href="core/#agentsandboxserviceaccountrolearn"><code>agentSandbox.serviceAccountRoleArn</code></a><span class="opt-type">null or string</span><p>IRSA role ARN annotated onto the agent-host ServiceAccount (eks.amazonaws.com/role-arn). The role's trust policy must allow system:serviceaccount:<namespace>…</p></div> <div class="opt-row" data-opt="agentsandbox.statelessreplicas replica count for the stateless platform services — the broker, scheduler, webhooks, and ui. defaults to 2 so a node drain / consolidation can't take a whole…"><a href="core/#agentsandboxstatelessreplicas"><code>agentSandbox.statelessReplicas</code></a><span class="opt-type">signed integer</span><p>Replica count for the STATELESS platform services — the broker, scheduler, webhooks, and UI. Defaults to 2 so a node drain / consolidation can't take a whole…</p></div> <div class="opt-row" data-opt="agentsandbox.uiimage oci ref of the ui image (nginx + static build + api proxy)."><a href="core/#agentsandboxuiimage"><code>agentSandbox.uiImage</code></a><span class="opt-type">string</span><p>OCI ref of the UI image (nginx + static build + API proxy).</p></div> <div class="opt-row" data-opt="agentsandbox.deploytools.configfiles config files to mount into every sandbox, as a flat directory at `/etc/agent-sandbox/config/`. keys are plain filenames (no slashes), values are file content…"><a href="deployTools/#agentsandboxdeploytoolsconfigfiles"><code>agentSandbox.deployTools.configFiles</code></a><span class="opt-type">attribute set of strings concatenated with "\n"</span><p>Config FILES to mount into every sandbox, as a flat directory at `/etc/agent-sandbox/config/`. Keys are plain filenames (no slashes), values are file content…</p></div> <div class="opt-row" data-opt="agentsandbox.deploytools.env extra env vars a deployment's tools need, set on each sandbox. values may contain newlines, `;`, and `=` — they're carried to the pod as json (scooter_env),…"><a href="deployTools/#agentsandboxdeploytoolsenv"><code>agentSandbox.deployTools.env</code></a><span class="opt-type">attribute set of string</span><p>Extra env vars a deployment's tools need, set on each sandbox. Values may contain newlines, `;`, and `=` — they're carried to the pod as JSON (SCOOTER_ENV),…</p></div> <div class="opt-row" data-opt="agentsandbox.deploytools.sandboxmanifestoverlay a recursive patch deep-merged on top of the broker-generated per-conversation sandbox manifest — so a deployment can change the pod manifest (nodeselector, t…"><a href="deployTools/#agentsandboxdeploytoolssandboxmanifestoverlay"><code>agentSandbox.deployTools.sandboxManifestOverlay</code></a><span class="opt-type">attribute set of anything</span><p>A recursive PATCH deep-merged on top of the broker-generated per-conversation Sandbox manifest — so a deployment can change the pod manifest (nodeSelector, t…</p></div> <div class="opt-row" data-opt="agentsandbox.deploytools.scooterconfigmap a deployment's .scooter configmap to mount at /etc/agent-sandbox/scooter."><a href="deployTools/#agentsandboxdeploytoolsscooterconfigmap"><code>agentSandbox.deployTools.scooterConfigMap</code></a><span class="opt-type">null or string</span><p>A deployment's .scooter ConfigMap to mount at /etc/agent-sandbox/scooter.</p></div> <div class="opt-row" data-opt="agentsandbox.deploytools.tokenaudiences extra projected sa token audiences a deployment's tools need (mounted at /var/run/secrets/<aud>/token)."><a href="deployTools/#agentsandboxdeploytoolstokenaudiences"><code>agentSandbox.deployTools.tokenAudiences</code></a><span class="opt-type">list of string</span><p>Extra projected SA token audiences a deployment's tools need (mounted at /var/run/secrets/<aud>/token).</p></div> <div class="opt-row" data-opt="agentsandbox.eventbackfill.enable whether to enable the one-shot event backfill job (history mirror pvc → postgres). turn on to run the migration, verify the report shows all conversations ok…"><a href="eventBackfill/#agentsandboxeventbackfillenable"><code>agentSandbox.eventBackfill.enable</code></a><span class="opt-type">boolean</span><p>Whether to enable the one-shot event backfill Job (history mirror PVC → Postgres). Turn ON to run the migration, verify the report shows all conversations OK…</p></div> <div class="opt-row" data-opt="agentsandbox.eventbackfill.image the agent-host image (it carries the compiled dist/scripts/runeventbackfill.js and its deps). defaults to the same image agent-host runs, so the backfill loa…"><a href="eventBackfill/#agentsandboxeventbackfillimage"><code>agentSandbox.eventBackfill.image</code></a><span class="opt-type">string</span><p>The agent-host image (it carries the compiled dist/scripts/runEventBackfill.js and its deps). Defaults to the same image agent-host runs, so the backfill loa…</p></div> <div class="opt-row" data-opt="agentsandbox.eventbackfill.mirrorpath path inside the mounted history mirror pvc where conversation directories live. each conversation is a directory named by its id, containing an events.jsonl…"><a href="eventBackfill/#agentsandboxeventbackfillmirrorpath"><code>agentSandbox.eventBackfill.mirrorPath</code></a><span class="opt-type">string</span><p>Path inside the mounted history mirror PVC where conversation directories live. Each conversation is a directory named by its ID, containing an events.jsonl…</p></div> <div class="opt-row" data-opt="agentsandbox.ingress.annotations annotations on the chat ingress — controller-specific config (cert, scheme, auth, the trusted identity header, external-dns hostname, …). security: the agent…"><a href="ingress/#agentsandboxingressannotations"><code>agentSandbox.ingress.annotations</code></a><span class="opt-type">attribute set of string</span><p>Annotations on the chat Ingress — controller-specific config (cert, scheme, AUTH, the trusted identity header, external-dns hostname, …). SECURITY: the agent…</p></div> <div class="opt-row" data-opt="agentsandbox.ingress.classname spec.ingressclassname (the controller). empty = the cluster's default ingressclass. e.g. "alb", "nginx", "traefik"."><a href="ingress/#agentsandboxingressclassname"><code>agentSandbox.ingress.className</code></a><span class="opt-type">string</span><p>spec.ingressClassName (the controller). Empty = the cluster's default IngressClass. e.g. "alb", "nginx", "traefik".</p></div> <div class="opt-row" data-opt="agentsandbox.ingress.enable expose the agent-host (ag-ui/api + ui) via a standard ingress. on by default so a deploy is reachable by hostname out of the box. security: the module auth-g…"><a href="ingress/#agentsandboxingressenable"><code>agentSandbox.ingress.enable</code></a><span class="opt-type">boolean</span><p>Expose the agent-host (AG-UI/API + UI) via a standard Ingress. On by default so a deploy is reachable by hostname out of the box. SECURITY: the module auth-g…</p></div> <div class="opt-row" data-opt="agentsandbox.ingress.host public hostname for the chat ui / api."><a href="ingress/#agentsandboxingresshost"><code>agentSandbox.ingress.host</code></a><span class="opt-type">string</span><p>Public hostname for the chat UI / API.</p></div> <div class="opt-row" data-opt="agentsandbox.ingress.tls add a spec.tls entry for `host`. needed for cert-manager (the tls block triggers issuance) and for controllers that read spec.tls. deployers that terminate t…"><a href="ingress/#agentsandboxingresstls"><code>agentSandbox.ingress.tls</code></a><span class="opt-type">boolean</span><p>Add a spec.tls entry for `host`. Needed for cert-manager (the tls block triggers issuance) and for controllers that read spec.tls. Deployers that terminate T…</p></div> <div class="opt-row" data-opt="agentsandbox.ingress.tlssecretname the tls secret holding the cert for `host` (populated by cert-manager, your cd, etc.). empty + tls=true emits a spec.tls entry without a secretname (some con…"><a href="ingress/#agentsandboxingresstlssecretname"><code>agentSandbox.ingress.tlsSecretName</code></a><span class="opt-type">string</span><p>The TLS Secret holding the cert for `host` (populated by cert-manager, your CD, etc.). Empty + tls=true emits a spec.tls entry WITHOUT a secretName (some con…</p></div> <div class="opt-row" data-opt="agentsandbox.legacystatemigration.enable whether to enable the one-shot legacy-state migration job (old per-pod rwo pvcs -> shared mirror). turn on for the cutover, run once (with agent-host scaled…"><a href="legacyStateMigration/#agentsandboxlegacystatemigrationenable"><code>agentSandbox.legacyStateMigration.enable</code></a><span class="opt-type">boolean</span><p>Whether to enable the one-shot legacy-state migration Job (old per-pod RWO PVCs -> shared mirror). Turn ON for the cutover, run once (with agent-host scaled…</p></div> <div class="opt-row" data-opt="agentsandbox.legacystatemigration.image a tiny image with a posix shell + cp (busybox) for the copy job."><a href="legacyStateMigration/#agentsandboxlegacystatemigrationimage"><code>agentSandbox.legacyStateMigration.image</code></a><span class="opt-type">string</span><p>A tiny image with a POSIX shell + cp (busybox) for the copy Job.</p></div> <div class="opt-row" data-opt="agentsandbox.legacystatemigration.legacypvcs the legacy statefulset per-pod rwo pvc names to migrate from (named `state-agent-host-<ordinal>` by the old volumeclaimtemplate). each is mounted read-only a…"><a href="legacyStateMigration/#agentsandboxlegacystatemigrationlegacypvcs"><code>agentSandbox.legacyStateMigration.legacyPvcs</code></a><span class="opt-type">list of string</span><p>The legacy StatefulSet per-pod RWO PVC names to migrate FROM (named `state-agent-host-<ordinal>` by the old volumeClaimTemplate). Each is mounted read-only a…</p></div> <div class="opt-row" data-opt="agentsandbox.dbmigrate.enable run the shared-database migration job on deploy (applies lib/sql migrations via atlas). only databases with an atlas schema that are also provisioned (a post…"><a href="misc/#agentsandboxdbmigrateenable"><code>agentSandbox.dbMigrate.enable</code></a><span class="opt-type">boolean</span><p>Run the shared-database migration Job on deploy (applies lib/sql migrations via Atlas). Only databases with an Atlas schema that are also provisioned (a post…</p></div> <div class="opt-row" data-opt="agentsandbox.dbmigrate.image oci ref of the db-migrator image."><a href="misc/#agentsandboxdbmigrateimage"><code>agentSandbox.dbMigrate.image</code></a><span class="opt-type">string</span><p>OCI ref of the db-migrator image.</p></div> <div class="opt-row" data-opt="agentsandbox.ui.enable deploy the conversation ui (nginx serving the assistant-ui build and proxying /agui + /sessions + the management api to the agent-host). when enabled, the in…"><a href="misc/#agentsandboxuienable"><code>agentSandbox.ui.enable</code></a><span class="opt-type">boolean</span><p>Deploy the conversation UI (nginx serving the assistant-ui build and proxying /agui + /sessions + the management API to the agent-host). When enabled, the in…</p></div> <div class="opt-row" data-opt="agentsandbox.observability.browsertelemetry.collectorurl otlp/http base url of the collector that receives browser telemetry. http, not grpc — browsers cannot speak otlp/grpc. no default, deliberately. a plausible-…"><a href="observability/#agentsandboxobservabilitybrowsertelemetrycollectorurl"><code>agentSandbox.observability.browserTelemetry.collectorUrl</code></a><span class="opt-type">null or string</span><p>OTLP/HTTP base URL of the collector that receives browser telemetry. HTTP, not gRPC — browsers cannot speak OTLP/gRPC. NO DEFAULT, deliberately. A plausible-…</p></div> <div class="opt-row" data-opt="agentsandbox.observability.browsertelemetry.enable let the ui send otlp traces to a collector, proxied same-origin through the ui's nginx at /telemetry/. off by default. same-origin on purpose: the browser ho…"><a href="observability/#agentsandboxobservabilitybrowsertelemetryenable"><code>agentSandbox.observability.browserTelemetry.enable</code></a><span class="opt-type">boolean</span><p>Let the UI send OTLP traces to a collector, proxied same-origin through the UI's nginx at /telemetry/. OFF by default. Same-origin on purpose: the browser ho…</p></div> <div class="opt-row" data-opt="agentsandbox.observability.browsertelemetry.sampleratio fraction of browser traces to record (0.0-1.0). 1.0 while debugging; lower it if the ui's live event stream produces more spans than the collector should carry."><a href="observability/#agentsandboxobservabilitybrowsertelemetrysampleratio"><code>agentSandbox.observability.browserTelemetry.sampleRatio</code></a><span class="opt-type">floating point number</span><p>Fraction of browser traces to record (0.0-1.0). 1.0 while debugging; lower it if the UI's live event stream produces more spans than the collector should carry.</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.enable emit opentelemetry metrics (run count/latency, tokens, derived cost, sandbox population) over otlp. off by default. the otlp endpoint + headers come from the…"><a href="observability/#agentsandboxobservabilityotelenable"><code>agentSandbox.observability.otel.enable</code></a><span class="opt-type">boolean</span><p>Emit OpenTelemetry metrics (run count/latency, tokens, derived cost, sandbox population) over OTLP. OFF by default. The OTLP endpoint + headers come from the…</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.env standard otel_exporter_otlp_* env vars passed through to the agent-host (the otel sdk reads them directly). point these at your collector / vendor endpoint.…"><a href="observability/#agentsandboxobservabilityotelenv"><code>agentSandbox.observability.otel.env</code></a><span class="opt-type">attribute set of string</span><p>Standard OTEL_EXPORTER_OTLP_* env vars passed through to the agent-host (the OTel SDK reads them directly). Point these at your collector / vendor endpoint.…</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.environment deployment.environment resource attribute on every metric."><a href="observability/#agentsandboxobservabilityotelenvironment"><code>agentSandbox.observability.otel.environment</code></a><span class="opt-type">null or string</span><p>deployment.environment resource attribute on every metric.</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.pricing per-model price table, usd per 1,000,000 tokens, for cost derivation. rendered to a configmap mounted into the agent-host and read at start. a model absent h…"><a href="observability/#agentsandboxobservabilityotelpricing"><code>agentSandbox.observability.otel.pricing</code></a><span class="opt-type">attribute set of (submodule)</span><p>Per-model price table, USD per 1,000,000 tokens, for cost derivation. Rendered to a ConfigMap mounted into the agent-host and read at start. A model absent h…</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.pricing.<name>.cachedreadpermillion this option has no description."><a href="observability/#agentsandboxobservabilityotelpricing<name>cachedreadpermillion"><code>agentSandbox.observability.otel.pricing.<name>.cachedReadPerMillion</code></a><span class="opt-type">null or signed integer or floating point number</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.pricing.<name>.cachedwritepermillion this option has no description."><a href="observability/#agentsandboxobservabilityotelpricing<name>cachedwritepermillion"><code>agentSandbox.observability.otel.pricing.<name>.cachedWritePerMillion</code></a><span class="opt-type">null or signed integer or floating point number</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.pricing.<name>.inputpermillion this option has no description."><a href="observability/#agentsandboxobservabilityotelpricing<name>inputpermillion"><code>agentSandbox.observability.otel.pricing.<name>.inputPerMillion</code></a><span class="opt-type">signed integer or floating point number</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.observability.otel.pricing.<name>.outputpermillion this option has no description."><a href="observability/#agentsandboxobservabilityotelpricing<name>outputpermillion"><code>agentSandbox.observability.otel.pricing.<name>.outputPerMillion</code></a><span class="opt-type">signed integer or floating point number</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.consumers.<name>.db this option has no description."><a href="postgres/#agentsandboxpostgresconsumers<name>db"><code>agentSandbox.postgres.consumers.<name>.db</code></a><span class="opt-type">string</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.consumers.<name>.user this option has no description."><a href="postgres/#agentsandboxpostgresconsumers<name>user"><code>agentSandbox.postgres.consumers.<name>.user</code></a><span class="opt-type">string</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external point every consumer at an external postgres (rds, etc.) instead of the in-cluster pod. setting this skips the in-cluster deployment/pvc/service; the provisi…"><a href="postgres/#agentsandboxpostgresexternal"><code>agentSandbox.postgres.external</code></a><span class="opt-type">null or (submodule)</span><p>Point every consumer at an EXTERNAL Postgres (RDS, etc.) instead of the in-cluster pod. Setting this SKIPS the in-cluster Deployment/PVC/Service; the provisi…</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.host external postgres host."><a href="postgres/#agentsandboxpostgresexternalhost"><code>agentSandbox.postgres.external.host</code></a><span class="opt-type">string</span><p>External Postgres host.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.passwordsecret secret + key holding the external admin password."><a href="postgres/#agentsandboxpostgresexternalpasswordsecret"><code>agentSandbox.postgres.external.passwordSecret</code></a><span class="opt-type">submodule</span><p>Secret + key holding the external admin password.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.passwordsecret.key this option has no description."><a href="postgres/#agentsandboxpostgresexternalpasswordsecretkey"><code>agentSandbox.postgres.external.passwordSecret.key</code></a><span class="opt-type">string</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.passwordsecret.name this option has no description."><a href="postgres/#agentsandboxpostgresexternalpasswordsecretname"><code>agentSandbox.postgres.external.passwordSecret.name</code></a><span class="opt-type">string</span><p>This option has no description.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.port port."><a href="postgres/#agentsandboxpostgresexternalport"><code>agentSandbox.postgres.external.port</code></a><span class="opt-type">signed integer</span><p>Port.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.sslmode sslmode appended to consumer dsns (e.g. require)."><a href="postgres/#agentsandboxpostgresexternalsslmode"><code>agentSandbox.postgres.external.sslmode</code></a><span class="opt-type">null or string</span><p>sslmode appended to consumer DSNs (e.g. require).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.external.user admin/master user (createdb/createrole)."><a href="postgres/#agentsandboxpostgresexternaluser"><code>agentSandbox.postgres.external.user</code></a><span class="opt-type">string</span><p>Admin/master user (CREATEDB/CREATEROLE).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.image postgres image for the in-cluster server (ignored when `external` is set)."><a href="postgres/#agentsandboxpostgresimage"><code>agentSandbox.postgres.image</code></a><span class="opt-type">string</span><p>Postgres image for the in-cluster server (ignored when `external` is set).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.kubectlimage image for the provisioning job's secret-creating initcontainer (needs kubectl + a shell + coreutils)."><a href="postgres/#agentsandboxpostgreskubectlimage"><code>agentSandbox.postgres.kubectlImage</code></a><span class="opt-type">string</span><p>Image for the provisioning Job's secret-creating initContainer (needs kubectl + a shell + coreutils).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.readers.<name>.grants per-database sets of tables this role may select from (tables) and read-write (writetables)."><a href="postgres/#agentsandboxpostgresreaders<name>grants"><code>agentSandbox.postgres.readers.<name>.grants</code></a><span class="opt-type">list of (submodule)</span><p>Per-database sets of tables this role may SELECT from (tables) and read-write (writeTables).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.readers.<name>.grants.*.db the database holding the tables."><a href="postgres/#agentsandboxpostgresreaders<name>grants*db"><code>agentSandbox.postgres.readers.<name>.grants.*.db</code></a><span class="opt-type">string</span><p>The database holding the tables.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.readers.<name>.grants.*.tables the tables to grant select on (must match owners.toml readers)."><a href="postgres/#agentsandboxpostgresreaders<name>grants*tables"><code>agentSandbox.postgres.readers.<name>.grants.*.tables</code></a><span class="opt-type">list of string</span><p>The tables to grant SELECT on (must match owners.toml readers).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.readers.<name>.grants.*.writetables tables to also grant insert/update/delete on (must match owners.toml writers). role default stays read-only; the writer opens a pool that overrides it."><a href="postgres/#agentsandboxpostgresreaders<name>grants*writetables"><code>agentSandbox.postgres.readers.<name>.grants.*.writeTables</code></a><span class="opt-type">list of string</span><p>Tables to also grant INSERT/UPDATE/DELETE on (must match owners.toml writers). Role default stays read-only; the writer opens a pool that overrides it.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.readers.<name>.user the login role name (read-only by default; writetables opt into writes)."><a href="postgres/#agentsandboxpostgresreaders<name>user"><code>agentSandbox.postgres.readers.<name>.user</code></a><span class="opt-type">string</span><p>The login role name (read-only by default; writeTables opt into writes).</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.storage pvc size for the in-cluster postgres data volume."><a href="postgres/#agentsandboxpostgresstorage"><code>agentSandbox.postgres.storage</code></a><span class="opt-type">string</span><p>PVC size for the in-cluster Postgres data volume.</p></div> <div class="opt-row" data-opt="agentsandbox.postgres.storageclass pvc storageclassname (null = cluster default)."><a href="postgres/#agentsandboxpostgresstorageclass"><code>agentSandbox.postgres.storageClass</code></a><span class="opt-type">null or string</span><p>PVC storageClassName (null = cluster default).</p></div> <div class="opt-row" data-opt="agentsandbox.scheduler.enable deploy the scheduled-tasks service (cron-spawns conversations)."><a href="scheduler/#agentsandboxschedulerenable"><code>agentSandbox.scheduler.enable</code></a><span class="opt-type">boolean</span><p>Deploy the scheduled-tasks service (cron-spawns conversations).</p></div> <div class="opt-row" data-opt="agentsandbox.scheduler.image oci ref of the scheduler image."><a href="scheduler/#agentsandboxschedulerimage"><code>agentSandbox.scheduler.image</code></a><span class="opt-type">string</span><p>OCI ref of the scheduler image.</p></div> <div class="opt-row" data-opt="agentsandbox.scheduler.loglevel root log level (log_level) — info logs task fires/spawns; debug is verbose."><a href="scheduler/#agentsandboxschedulerloglevel"><code>agentSandbox.scheduler.logLevel</code></a><span class="opt-type">string</span><p>Root log level (LOG_LEVEL) — INFO logs task fires/spawns; DEBUG is verbose.</p></div> <div class="opt-row" data-opt="agentsandbox.scheduler.relaykey api key gating the /tasks api (bearer). empty = auth disabled (local only). for a real deploy, set via a secret + envfrom, not inline."><a href="scheduler/#agentsandboxschedulerrelaykey"><code>agentSandbox.scheduler.relayKey</code></a><span class="opt-type">string</span><p>API key gating the /tasks API (Bearer). Empty = auth disabled (local only). For a real deploy, set via a Secret + envFrom, not inline.</p></div> <div class="opt-row" data-opt="agentsandbox.scheduler.runretentiondays ttl for task_runs in days; 0 disables the sweep (no delete)."><a href="scheduler/#agentsandboxschedulerrunretentiondays"><code>agentSandbox.scheduler.runRetentionDays</code></a><span class="opt-type">signed integer</span><p>TTL for task_runs in days; 0 disables the sweep (no DELETE).</p></div> <div class="opt-row" data-opt="agentsandbox.scheduler.tickseconds how often the scheduler loop checks for due tasks."><a href="scheduler/#agentsandboxschedulertickseconds"><code>agentSandbox.scheduler.tickSeconds</code></a><span class="opt-type">signed integer</span><p>How often the scheduler loop checks for due tasks.</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.enable whether to enable the warm /nix/store pvc pool controller."><a href="warmStore/#agentsandboxwarmstoreenable"><code>agentSandbox.warmStore.enable</code></a><span class="opt-type">boolean</span><p>Whether to enable the warm /nix/store PVC pool controller.</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.goldenexpr the golden seed: a nix expression / installable spec the warm job builds into the overlay upper (via the sandbox image's nix, landing in `upper/` + registere…"><a href="warmStore/#agentsandboxwarmstoregoldenexpr"><code>agentSandbox.warmStore.goldenExpr</code></a><span class="opt-type">string</span><p>The golden seed: a Nix expression / installable spec the warm Job builds into the overlay upper (via the sandbox image's nix, landing in `upper/` + registere…</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.image oci ref of the warm-store-controller image."><a href="warmStore/#agentsandboxwarmstoreimage"><code>agentSandbox.warmStore.image</code></a><span class="opt-type">string</span><p>OCI ref of the warm-store-controller image.</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.leaseseconds leader-election lease duration; the holder must renew within this window."><a href="warmStore/#agentsandboxwarmstoreleaseseconds"><code>agentSandbox.warmStore.leaseSeconds</code></a><span class="opt-type">signed integer</span><p>Leader-election Lease duration; the holder must renew within this window.</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.maxtotal cap total `ready` pool pvcs for the current tag (lru-evict the coldest past this)."><a href="warmStore/#agentsandboxwarmstoremaxtotal"><code>agentSandbox.warmStore.maxTotal</code></a><span class="opt-type">signed integer</span><p>Cap total `ready` pool PVCs for the current tag (LRU-evict the coldest past this).</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.minready keep at least this many `ready` pool pvcs warmed for the current image tag."><a href="warmStore/#agentsandboxwarmstoreminready"><code>agentSandbox.warmStore.minReady</code></a><span class="opt-type">signed integer</span><p>Keep at least this many `ready` pool PVCs warmed for the current image tag.</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.reconcileinterval seconds between reconcile passes (also the lease renew cadence; < leaseseconds)."><a href="warmStore/#agentsandboxwarmstorereconcileinterval"><code>agentSandbox.warmStore.reconcileInterval</code></a><span class="opt-type">signed integer</span><p>Seconds between reconcile passes (also the Lease renew cadence; < leaseSeconds).</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.replicas controller replicas. default 1: the controller is leader-elected (only the leader reconciles), so a 2nd replica only buys faster failover — not worth it for…"><a href="warmStore/#agentsandboxwarmstorereplicas"><code>agentSandbox.warmStore.replicas</code></a><span class="opt-type">signed integer</span><p>Controller replicas. Default 1: the controller is leader-elected (only the leader reconciles), so a 2nd replica only buys faster failover — not worth it for…</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.storage size of each pool pvc (the overlay upper). match the per-conversation scooter-rw size."><a href="warmStore/#agentsandboxwarmstorestorage"><code>agentSandbox.warmStore.storage</code></a><span class="opt-type">string</span><p>Size of each pool PVC (the overlay upper). Match the per-conversation scooter-rw size.</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.storageclass storageclass for pool volumes. must have `reclaimpolicy: retain`: on a delete class removing a pvc destroys its pv, so nothing is ever recycled and the pool…"><a href="warmStore/#agentsandboxwarmstorestorageclass"><code>agentSandbox.warmStore.storageClass</code></a><span class="opt-type">string</span><p>StorageClass for POOL volumes. MUST have `reclaimPolicy: Retain`: on a Delete class removing a PVC destroys its PV, so nothing is ever recycled and the pool…</p></div> <div class="opt-row" data-opt="agentsandbox.warmstore.storageprovisioner provisioner backing the pool storageclass — a retain variant of the cluster's normal one, so no new csi driver is needed (e.g. `ebs.csi.aws.com` on eks). nul…"><a href="warmStore/#agentsandboxwarmstorestorageprovisioner"><code>agentSandbox.warmStore.storageProvisioner</code></a><span class="opt-type">null or string</span><p>Provisioner backing the pool StorageClass — a Retain variant of the cluster's normal one, so no new CSI driver is needed (e.g. `ebs.csi.aws.com` on EKS). nul…</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.enable deploy the webhooks service."><a href="webhooks/#agentsandboxwebhooksenable"><code>agentSandbox.webhooks.enable</code></a><span class="opt-type">boolean</span><p>Deploy the webhooks service.</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.githubenabled enable the github webhook handler (/webhooks/github)."><a href="webhooks/#agentsandboxwebhooksgithubenabled"><code>agentSandbox.webhooks.githubEnabled</code></a><span class="opt-type">boolean</span><p>Enable the GitHub webhook handler (/webhooks/github).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.gitlabenabled enable the gitlab webhook handler (/webhooks/gitlab)."><a href="webhooks/#agentsandboxwebhooksgitlabenabled"><code>agentSandbox.webhooks.gitlabEnabled</code></a><span class="opt-type">boolean</span><p>Enable the GitLab webhook handler (/webhooks/gitlab).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.image oci ref of the webhooks image."><a href="webhooks/#agentsandboxwebhooksimage"><code>agentSandbox.webhooks.image</code></a><span class="opt-type">string</span><p>OCI ref of the webhooks image.</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.ingress.annotations annotations on the webhooks ingress — controller/cert config without auth (the endpoint must accept unauthenticated provider posts)."><a href="webhooks/#agentsandboxwebhooksingressannotations"><code>agentSandbox.webhooks.ingress.annotations</code></a><span class="opt-type">attribute set of string</span><p>Annotations on the webhooks Ingress — controller/cert config WITHOUT auth (the endpoint must accept unauthenticated provider POSTs).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.ingress.classname spec.ingressclassname (the controller). empty = cluster default."><a href="webhooks/#agentsandboxwebhooksingressclassname"><code>agentSandbox.webhooks.ingress.className</code></a><span class="opt-type">string</span><p>spec.ingressClassName (the controller). Empty = cluster default.</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.ingress.enable expose the webhooks receiver via a standard ingress."><a href="webhooks/#agentsandboxwebhooksingressenable"><code>agentSandbox.webhooks.ingress.enable</code></a><span class="opt-type">boolean</span><p>Expose the webhooks receiver via a standard Ingress.</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.ingress.host public hostname for the webhooks receiver (path /webhooks)."><a href="webhooks/#agentsandboxwebhooksingresshost"><code>agentSandbox.webhooks.ingress.host</code></a><span class="opt-type">string</span><p>Public hostname for the webhooks receiver (path /webhooks).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.ingress.tls add a spec.tls entry for `host` (cert-manager / controllers that read spec.tls)."><a href="webhooks/#agentsandboxwebhooksingresstls"><code>agentSandbox.webhooks.ingress.tls</code></a><span class="opt-type">boolean</span><p>Add a spec.tls entry for `host` (cert-manager / controllers that read spec.tls).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.ingress.tlssecretname tls secret for `host` (empty + tls=true emits spec.tls without a secretname)."><a href="webhooks/#agentsandboxwebhooksingresstlssecretname"><code>agentSandbox.webhooks.ingress.tlsSecretName</code></a><span class="opt-type">string</span><p>TLS Secret for `host` (empty + tls=true emits spec.tls without a secretName).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.labeltrigger issue/pr label name that triggers a conversation (github/gitlab)."><a href="webhooks/#agentsandboxwebhookslabeltrigger"><code>agentSandbox.webhooks.labelTrigger</code></a><span class="opt-type">string</span><p>Issue/PR label name that triggers a conversation (GitHub/GitLab).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.loglevel root log level (log_level) — debug for verbose tracing."><a href="webhooks/#agentsandboxwebhooksloglevel"><code>agentSandbox.webhooks.logLevel</code></a><span class="opt-type">string</span><p>Root log level (LOG_LEVEL) — DEBUG for verbose tracing.</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.managerurl public ui base url for the 'view conversation' deep-links (agent_manager_url)."><a href="webhooks/#agentsandboxwebhooksmanagerurl"><code>agentSandbox.webhooks.managerUrl</code></a><span class="opt-type">string</span><p>Public UI base URL for the 'View conversation' deep-links (AGENT_MANAGER_URL).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.mentionpattern text the agent looks for to treat a comment/message as a request. github @<name> does not autocomplete for non-users, so a sigil like "!scooter" reads better…"><a href="webhooks/#agentsandboxwebhooksmentionpattern"><code>agentSandbox.webhooks.mentionPattern</code></a><span class="opt-type">string</span><p>Text the agent looks for to treat a comment/message as a request. GitHub @<name> does not autocomplete for non-users, so a sigil like "!scooter" reads better…</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.secretname name of a secret (same namespace) envfrom-mounted for provider creds."><a href="webhooks/#agentsandboxwebhookssecretname"><code>agentSandbox.webhooks.secretName</code></a><span class="opt-type">string</span><p>Name of a Secret (same namespace) envFrom-mounted for provider creds.</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.slackenabled enable the slack events handler (/webhooks/slack)."><a href="webhooks/#agentsandboxwebhooksslackenabled"><code>agentSandbox.webhooks.slackEnabled</code></a><span class="opt-type">boolean</span><p>Enable the Slack events handler (/webhooks/slack).</p></div> <div class="opt-row" data-opt="agentsandbox.webhooks.testwebhook enable /webhooks/test for the spawn-from-webhook e2e."><a href="webhooks/#agentsandboxwebhookstestwebhook"><code>agentSandbox.webhooks.testWebhook</code></a><span class="opt-type">boolean</span><p>Enable /webhooks/test for the spawn-from-webhook e2e.</p></div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type="button" class="md-top md-icon" data-md-component="top" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class="md-footer"> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.sections", "navigation.top", "content.code.copy", "search.suggest"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> <script src="../../assets/javascripts/bundle.d7400e89.min.js"></script> <script src="../../assets/options.js"></script> </body> </html>