@wardby/cli 0.5.2 → 0.6.0

package/docs/native-sandbox.md

@@ -0,0 +1,635 @@
+# Native sandbox
+
+> **Requires Wardby 0.5.4 or later.**
+
+By default a native agent runs inside the Wardby server process: its turn loop
+and any user tool code you attach execute next to the database connection, the
+LLM credentials, and every other agent's runs. **Sandbox mode** moves the whole
+turn loop and the agent's user tools into a single-use worker that holds no
+credentials, no database access, no container-runtime access, and no network
+except one path to a separate **native gateway**. The worker is a Docker
+container or, on a Kubernetes cluster, a pod; you choose with
+`NATIVE_SANDBOX_LAUNCHER`.
+
+Use it when a native agent runs tool code or prompts you do not fully trust, for
+example tools written by people other than the operators, or agents that fetch
+and process untrusted content. Leave agents in the default `control-plane` mode
+when you trust the tools and want the simplest deployment.
+
+Sandbox mode applies to native agents only. Coding agents have their own
+isolation model; see [Coding-worker isolation](coding-worker-isolation.md).
+
+## What is isolated and what is not
+
+| Component                 | Trusted? | Where it runs                            |
+| ------------------------- | -------- | ---------------------------------------- |
+| Wardby server / scheduler | Yes      | Your host, VM, or cluster                |
+| Native gateway            | Yes      | A separate container or Deployment       |
+| Postgres, LLM provider    | Yes      | Reachable only from server/gateway       |
+| Agent turn loop (worker)  | No       | Single-use container or pod, one per run |
+| User tool code (worker)   | No       | The same worker                          |
+
+The Docker worker container:
+
+- has no LLM keys, secrets, database URL, or Docker socket, and receives only a
+  run-scoped capability on its standard input (never in its environment,
+  arguments, labels, or `docker inspect` output);
+- runs as non-root (uid 10001) on a read-only root filesystem with a
+  size-capped `/tmp` (no exec), all Linux capabilities dropped,
+  `no-new-privileges`, and CPU, memory, and PID limits;
+- sits on an internal Docker network created for that run alone, shared only
+  with the gateway container, with no route to the internet, the host, or any
+  other run.
+
+On Kubernetes the worker is a pod with the same posture; see
+[Set up with Kubernetes](#set-up-with-kubernetes) for what the pod and its
+NetworkPolicy contain and how the isolation is proven before the run starts.
+
+Everything the worker needs from the outside world (model calls, the built-in
+tools, and tool access to datastores, secrets, and outbound fetch) goes through
+the gateway, which enforces each tool attachment's grants. A worker can only
+ask for what the agent's attachments already allow.
+
+Containers are defense in depth, not a virtual-machine boundary. On Kubernetes,
+set a sandboxing runtime class such as gVisor where you have one. Run the Docker
+host on a machine that holds no production credentials beyond what the server
+and gateway need.
+
+## Topology (Docker)
+
+```
+              Docker host
+ +---------------------------------------------------------+
+ |  wardby serve  (server + scheduler)                     |
+ |     |  docker run / network create / network connect    |
+ |     v                                                   |
+ |  per-run internal network  (no external route)          |
+ |   +--------------------+        +--------------------+  |
+ |   | native worker      |  HTTP  | native gateway     |  |
+ |   | (no credentials)   +------->| wardby-native-     |--+--> LLM provider
+ |   | single-use         |        | gateway :8790      |--+--> Postgres
+ |   +--------------------+        | (credentials, DB)  |  |
+ |                                 +--------------------+  |
+ +---------------------------------------------------------+
+```
+
+For each run the server creates a new internal network, connects the gateway
+container to it under the alias `wardby-native-gateway`, and starts the worker
+on it. When the run ends the worker, the network, and the gateway's membership
+of it are removed.
+
+The gateway is stateless: all state is in Postgres. You can restart it while
+runs are in flight; workers retry their calls. It must not be given the Docker
+socket, because workers can reach it.
+
+## Requirements
+
+- **Docker launcher:** Docker on the host that runs `wardby serve` (or
+  `wardby scheduler`). The server launches workers with the `docker` CLI, so its
+  user must be able to use the Docker daemon. A running native gateway container
+  (below) on the same Docker host, with access to the same Postgres database as
+  the server.
+- **Kubernetes launcher:** a cluster whose CNI enforces `NetworkPolicy`, a
+  namespace holding the native gateway, and a server identity with the
+  permissions in [Server permissions](#server-permissions).
+- The `wardby-native-worker` image, pinned by digest (Docker also accepts a
+  local image id; Kubernetes requires a registry digest).
+- A running `wardby serve` or `wardby scheduler`. Sub-agents of a sandboxed run
+  are started by the scheduler leader (see [Sub-agents](#sub-agents)).
+
+## Set up with Docker
+
+### 1. Choose the worker image
+
+Releases publish the image to the GitHub Container Registry as
+`ghcr.io/<org>/wardby-native-worker`. The exact digest-pinned reference for the
+installed version is listed as `nativeWorker` in `dist/quickstart-images.json`
+inside the npm package. Use that reference as-is:
+
+```dotenv
+NATIVE_SANDBOX_WORKER_IMAGE=ghcr.io/your-org/wardby-native-worker@sha256:replace-with-digest
+```
+
+The image must be immutable: a `repo@sha256:...` digest or a local image id.
+A mutable tag such as `:latest` is refused with
+[`native_sandbox_image_not_pinned`](../help/errors/native-sandbox-image-not-pinned.md).
+
+To build it yourself from a repository checkout:
+
+```bash
+npm run native-worker:image:local
+docker image inspect --format '{{.Id}}' wardby-native-worker:local
+```
+
+Use the printed `sha256:...` image id as `NATIVE_SANDBOX_WORKER_IMAGE`. A local
+id must already exist on the Docker host; a digest reference is pulled once if
+missing.
+
+### 2. Run the native gateway
+
+The gateway is the same Wardby build as the server, started with the
+`native-gateway` command. It needs the server's database, LLM, secrets, and
+integration settings, and **no Docker access**.
+
+| Gateway variable        | Purpose                                                                                                                                                                                                                                                    |
+| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `NATIVE_GATEWAY_LISTEN` | `host:port` to listen on. Default `0.0.0.0:8790`.                                                                                                                                                                                                          |
+| `DATABASE_URL`          | The same database the server uses. With `DATABASE_AUTH=rds-iam` the gateway also needs `DATABASE_AUTH`, `AWS_REGION` (or `DATABASE_AWS_REGION`) and the CA bundle file named by `sslrootcert` ([details](security-deployment.md#database-authentication)). |
+| LLM provider keys       | The same provider settings as the server (for example `OPENAI_API_KEY`).                                                                                                                                                                                   |
+| `SECRET_APP_KEY`        | Same value as the server, so tools can read their bound secrets or send brokered ones ([details](tool-secrets.md)).                                                                                                                                        |
+| Integration settings    | The same repository-host and issue-tracker settings as the server.                                                                                                                                                                                         |
+
+If sandboxed agents delegate to coding agents, give the gateway the same
+coding image settings as the server (for example `CODING_WORKER_IMAGE`); the
+gateway only resolves them, it never starts coding workers.
+
+For local development, the repository ships a compose overlay
+(`deploy/local/docker-compose.native-sandbox.yml`) that runs the gateway next to
+the local Postgres from `deploy/local/docker-compose.yml`:
+
+```bash
+docker compose -f deploy/local/docker-compose.yml -f deploy/local/docker-compose.native-sandbox.yml --env-file .env.local up -d --build native-gateway
+```
+
+The overlay names the container `wardby-native-gateway`, passes the database
+URL for the compose network and your LLM keys from the environment file. It
+runs with a read-only root filesystem and all capabilities dropped, and mounts
+no Docker socket.
+It defines its own health check against `/healthz`.
+
+For other deployments, run `wardby native-gateway` in a container built from
+the same image as the server, on the same Docker host, with any container
+name you choose, and give that name to the server in the next step. Do not
+publish its port to the internet; only the per-run networks and your own
+health checks need to reach it.
+
+### 3. Configure the server
+
+Add these to the server's environment (`wardby serve` or `wardby scheduler`),
+then restart it:
+
+```dotenv
+NATIVE_SANDBOX_LAUNCHER=docker
+NATIVE_SANDBOX_WORKER_IMAGE=ghcr.io/your-org/wardby-native-worker@sha256:replace-with-digest
+NATIVE_GATEWAY_CONTAINER=wardby-native-gateway
+```
+
+See [Configuration reference](#configuration-reference) for every variable,
+including the Kubernetes ones. A missing required variable, or a launcher other
+than `docker` or `kubernetes`, stops the server at startup with a message naming the variable. When
+`NATIVE_SANDBOX_LAUNCHER` is unset, sandbox mode is off and any sandbox-mode
+run fails closed (see [Failure modes](#failure-modes)).
+
+`JOB_LAUNCHER` (coding agents) is a separate setting; you can enable either,
+both, or neither.
+
+### 4. Set an agent's mode
+
+Each native agent has a `nativeExecutionMode` setting:
+
+- `control-plane` (default): the run executes in the server process.
+- `sandbox`: the run executes in a worker container as described above.
+
+Set it with the MCP tools `create_agent` or `update_agent` (field
+`nativeExecutionMode`, native agents only), or in an import bundle. Setting
+`sandbox` is refused while the server has no native sandbox configured.
+
+From the command line, with the same environment as the server:
+
+```bash
+wardby agent create --name <n> --model <m> --prompt <p> --budget <usd> --native-execution-mode sandbox
+```
+
+```bash
+wardby agent mode <name> sandbox
+```
+
+The CLI refuses `sandbox` with `native_sandbox_unavailable` when its own
+environment has no `NATIVE_SANDBOX_LAUNCHER`, so run it where the server's
+sandbox variables are set. `wardby agent list` marks sandbox-mode agents.
+`get_run` and `list_runs` report each run's mode as `nativeExecutionMode`
+(`control-plane`, `sandbox`, or `null` for a coding run).
+
+Each run keeps the mode it started with. Changing an agent affects only the
+runs that start afterwards.
+
+## Set up with Kubernetes
+
+With `NATIVE_SANDBOX_LAUNCHER=kubernetes` the server starts one pod per
+sandbox run in a namespace you choose and deletes it when the run ends. The
+native gateway runs in the same namespace as an ordinary Deployment.
+
+```
+ cluster namespace
+ +---------------------------------------------------------------+
+ |  wardby serve  --create pod / Secret / NetworkPolicy-->        |
+ |                                                               |
+ |   native-run pod (no credentials)      native gateway pods    |
+ |   +---------------------------+  8790  +-------------------+  |
+ |   | worker, single-use        +------->| wardby-native-    |--+--> LLM provider
+ |   | egress: gateway:8790 only |   x    | gateway Service   |--+--> Postgres
+ |   +---------------------------+  8791  +-------------------+  |
+ +---------------------------------------------------------------+
+```
+
+### 1. Choose the worker image
+
+Use the digest-pinned `nativeWorker` reference from
+`dist/quickstart-images.json`, or push your own build to a registry your
+cluster can pull from. The reference must be a registry digest,
+`repo@sha256:...`. A local image id means nothing to a cluster, and a
+mutable tag is refused; both stop the server at startup or fail the run with
+[`native_sandbox_image_not_pinned`](../help/errors/native-sandbox-image-not-pinned.md).
+
+### 2. Deploy the native gateway
+
+Run `wardby native-gateway` as a Deployment in the run namespace, from the
+same Wardby image as the server. Requirements:
+
+- **Environment:** the server's `DATABASE_URL`, `SECRET_APP_KEY` (so tools can
+  read their bound secrets or send brokered ones; see
+  [tool-secrets.md](tool-secrets.md)), the LLM provider keys, and any integration or
+  coding image settings the server has (see the gateway table in the Docker
+  setup above). Also `NATIVE_GATEWAY_LISTEN` (default `0.0.0.0:8790`) and
+  `NATIVE_GATEWAY_DENY_PORT` (default `8791`). Keep these in a Secret.
+- **No Kubernetes access:** `automountServiceAccountToken: false` and no Role
+  or RoleBinding. Workers can reach the gateway, so it must not be able to
+  touch the cluster. A read-only root filesystem with a small `/tmp`,
+  all capabilities dropped, and a non-root user all apply.
+- **Pod label:** `app.kubernetes.io/name: wardby-native-gateway`. The per-run
+  NetworkPolicy selects the gateway pods by this label.
+- **A ClusterIP Service** named `wardby-native-gateway` (or set
+  `NATIVE_GATEWAY_SERVICE`) exposing **both** port 8790 and the deny port 8791. Nothing is served on 8791; it exists only so isolation can be proven.
+- **A NetworkPolicy on the gateway pods** that admits pods labeled
+  `wardby.io/component: native-run` on **both 8790 and 8791**, with egress to
+  cluster DNS, the model providers (HTTPS), and the database. Do not drop the
+  8791 rule: the check that a worker cannot reach 8791 only means something if
+  8791 is open at the destination, so that the worker's own policy is the only
+  thing that can block it. Without it, a worker whose policy was never
+  programmed would read the port as blocked and its isolation could be
+  wrongly proven.
+- Replicas are fine; the gateway is stateless.
+
+The gateway ships in every target's manifests: the Deployment, Service, and
+NetworkPolicy are in `deploy/kind-coding/manifests/base/native-gateway.yaml`,
+and each overlay (`kind`, `gke-autopilot`) supplies its own database egress and
+the `wardby-native-gateway-env` Secret. On a cluster you manage yourself, copy
+that file and adapt it. On GKE Autopilot the gateway also gets its own Workload
+Identity and Cloud SQL database user; see
+[Getting started on GKE](getting-started-gke.md#native-sandbox).
+
+### 3. Server permissions
+
+The server (`wardby serve` or `wardby scheduler`) needs a Role in the run
+namespace that allows:
+
+| Resource                            | Verbs                             |
+| ----------------------------------- | --------------------------------- |
+| `pods`                              | `create`, `get`, `delete`, `list` |
+| `pods/exec`                         | `create`, `get`                   |
+| `secrets`                           | `create`, `delete`                |
+| `networking.k8s.io/networkpolicies` | `create`, `get`, `delete`         |
+| `services`                          | `get`                             |
+
+`list` on pods lets the startup sweep find leftover worker pods by label;
+`pods/exec` is how the server proves isolation from inside the pod; `services`
+is read once to find the gateway's ClusterIP. Coding runs on Kubernetes use a
+largely overlapping Role (`deploy/kind-coding/manifests/base/launcher-role.yaml`).
+
+### 4. Configure the server
+
+```dotenv
+NATIVE_SANDBOX_LAUNCHER=kubernetes
+NATIVE_SANDBOX_WORKER_IMAGE=registry.example.com/wardby-native-worker@sha256:replace-with-digest
+NATIVE_SANDBOX_NAMESPACE=wardby
+```
+
+Optional: `KUBERNETES_CONTEXT` (the kubeconfig context; unset uses the
+in-cluster identity or the current context), `NATIVE_SANDBOX_RUNTIME_CLASS`
+(for example a gVisor class), `NATIVE_GATEWAY_SERVICE`, the CPU and memory
+limits, `NATIVE_SANDBOX_MAX_CONCURRENT`, `NATIVE_SANDBOX_PRIORITY_CLASS`, and
+the two start-up time limits. See [Configuration reference](#configuration-reference). Then set
+agents to `sandbox` mode as described in
+[Set an agent's mode](#4-set-an-agents-mode).
+
+### What each run gets
+
+For every run the server creates, then deletes when the run ends:
+
+- A **Secret** holding the run's input and capability, immutable and mounted
+  read-only into the pod. The capability is never in the pod's environment,
+  arguments, or labels.
+- A **NetworkPolicy** selecting only that pod: no ingress, and egress only to
+  the gateway pods on port 8790.
+- The **pod**, with no service-account token, non-root (uid and fsGroup
+  10001), a read-only root filesystem with a 64 MiB `/tmp`, all capabilities
+  dropped, no privilege escalation, the runtime-default seccomp profile, CPU
+  and memory requests equal to limits, an optional priority class
+  (`NATIVE_SANDBOX_PRIORITY_CLASS`), and `activeDeadlineSeconds` set to the
+  run's deadline. Kubernetes has no per-pod process limit, so
+  `NATIVE_SANDBOX_PIDS` does not apply.
+
+Workers dial the gateway Service's ClusterIP, so they need no DNS egress. Set
+`NATIVE_GATEWAY_URL` only to override that.
+
+### How isolation is proven
+
+A NetworkPolicy takes effect a few seconds after its pod starts, so the run
+does not begin until the server has proven the isolation. A new sandbox run
+starts **not ready**: the gateway refuses every call from it with a
+`not_ready` response, and the worker keeps retrying. Meanwhile the server:
+
+1. Reads back the pod and NetworkPolicy it created and compares them with what
+   it built. If an admission controller or mutating webhook changed the
+   security-relevant parts (service-account token, host networking, runtime
+   class, priority class, image, container resources and security context,
+   extra containers, or the policy),
+   the run fails with
+   [`native_sandbox_isolation_mismatch`](../help/errors/native-sandbox-isolation-mismatch.md).
+2. Waits for the pod to run, then executes a short probe inside it. The probe
+   must reach the gateway on 8790, must fail to reach the gateway's deny port
+   8791 at the same address, and must fail to reach an outside address or any
+   cloud metadata endpoint: `169.254.169.254:80`, the EKS Pod Identity agent
+   (`169.254.170.23:80` and its IPv6 address `[fd00:ec2::23]:80`) and EC2's IPv6
+   metadata address `[fd00:ec2::254]:80`.
+3. Only when the probe passes does it mark the run ready. The gateway then
+   accepts the worker's calls.
+
+If the probe cannot pass within its time limit the run fails with
+[`native_sandbox_network_unenforced`](../help/errors/native-sandbox-network-unenforced.md)
+and the pod is removed. What operators see while this happens: a run that
+stays in its starting state for a few seconds (longer on a cold image pull),
+and nothing in the model or tool logs until it is ready. A cluster whose CNI
+does not enforce NetworkPolicy fails every sandbox run this way, by design.
+
+### Managed Kubernetes platforms
+
+Set `KUBERNETES_PLATFORM=eks` on Amazon EKS clusters that have a gVisor node
+group. It requires the same gVisor runtime class as `gke-autopilot` (the server
+refuses to start unless `NATIVE_SANDBOX_RUNTIME_CLASS` or
+`KUBERNETES_RUNTIME_CLASS` is `gvisor`) and expects a RuntimeClass `gvisor`
+(handler `runsc`) whose scheduling block selects nodes labelled
+`wardby.dev/sandbox=gvisor` and tolerates their `sandbox=gvisor:NoSchedule`
+taint.
+
+Set `KUBERNETES_PLATFORM=gke-autopilot` on GKE Autopilot. It applies to native
+worker pods as well as coding pods: pod resources are conformed to Autopilot's
+rules (CPU in 250m steps, 1 to 6.5 GiB of memory per vCPU) so admission changes
+nothing, and the attestation above then passes. Autopilot also requires a
+sandboxing runtime: with this platform the server refuses to start unless
+`NATIVE_SANDBOX_RUNTIME_CLASS` (or `KUBERNETES_RUNTIME_CLASS`) is `gvisor`
+("runs native workers only under gVisor"). A cold gVisor node can take about
+two minutes to come up, so raise `NATIVE_SANDBOX_READY_TIMEOUT_MS` (for example
+to `600000`).
+
+### Capacity
+
+`NATIVE_SANDBOX_MAX_CONCURRENT` caps how many sandbox runs may be active at
+once across all server replicas (it counts active gateway sessions). A start
+past the cap fails immediately with
+[`native_sandbox_capacity`](../help/errors/native-sandbox-capacity.md); it does
+not queue. The same code is returned when the namespace's ResourceQuota has no
+room for another worker pod. Raise the ResourceQuota together with
+`NATIVE_SANDBOX_MAX_CONCURRENT` (and `CODING_MAX_CONCURRENT`, which shares the
+namespace): each worker pod needs its CPU and memory limits from the quota.
+
+## Warm pool
+
+By default every sandbox run starts its own worker, so a run waits for the
+worker to be created and, on Kubernetes, for pod scheduling, the image pull, and
+the in-pod isolation proof. The warm pool keeps a few idle, already-isolated
+workers ready so a run can take one instead. It works with both
+`NATIVE_SANDBOX_LAUNCHER=docker` and `kubernetes`.
+
+### Enable it
+
+Set `NATIVE_SANDBOX_WARM_POOL_SIZE` on the server to the number of idle workers
+to keep (0 to 50; the default `0` means no pool and every run cold-starts as
+before). `NATIVE_SANDBOX_WARM_MAX_AGE_MS` (60000 to 21600000, default `1800000`,
+30 minutes) is how long an idle worker may wait: an older one is replaced and
+never claimed. A pool worker that nobody claims also exits by itself five
+minutes after its max age.
+
+The worker image must support pool workers: rebuild or update
+`wardby-native-worker` with the release that adds the pool. An older image still
+runs cold runs but cannot be a pool worker. The release adds a database
+migration (the `NativeWarmWorker` table); apply it with `prisma migrate deploy`
+as with any upgrade.
+
+### Sizing and idle cost
+
+`NATIVE_SANDBOX_MAX_CONCURRENT` still counts only active runs. Idle pool workers
+are extra running containers or pods on top of it. On Kubernetes the namespace
+ResourceQuota must have room for `NATIVE_SANDBOX_MAX_CONCURRENT` plus
+`NATIVE_SANDBOX_WARM_POOL_SIZE` worker pods, plus the gateway and any coding
+runs. A pool worker that does not fit is skipped and logged; it never fails a
+run.
+
+Each idle worker reserves its CPU and memory continuously. On GKE Autopilot you
+pay for each idle pod's requests (500m and 512Mi in the reference overlay). In
+return, a claimed run skips pod scheduling, the image pull, node boot, and the
+in-pod isolation probe; on Autopilot a cold gVisor node can take about two
+minutes to come up. Start with a small size and raise it if runs still
+cold-start under load.
+
+### How claims keep the isolation guarantees
+
+- A pool worker is started and its isolation proven before any run exists (on
+  Kubernetes it is attested and probed from inside the pod, the same as a cold
+  pod). It holds no run data and no gateway capability.
+- A run claims an idle worker atomically through the database, so claims are
+  safe across server replicas and processes. A worker is never given to two
+  runs.
+- The run's input, including its one-time gateway capability, is delivered by
+  exec over stdin only after the claim. It never travels in the environment,
+  the command line, labels, or a Kubernetes Secret.
+- At claim the worker is re-checked: still running, and the pod and
+  NetworkPolicy still as built (Docker: attached only to its own network). It is
+  not probed again; the max age bounds how old the isolation proof can be.
+- The worker is single-use and destroyed after the run, exactly like a cold one.
+
+### Fallback
+
+- No idle worker, or the claimed one fails the re-check: the run cold-launches
+  as if there were no pool.
+- Delivery fails: the worker is removed and, once it is confirmed gone, the run
+  cold-launches. If it cannot be confirmed gone within 30 seconds, the run fails
+  with
+  [`native_sandbox_warm_delivery_failed`](../help/errors/native-sandbox-warm-delivery-failed.md)
+  rather than risk a second worker holding the same capability.
+
+### Upkeep
+
+Every `wardby serve`, `wardby scheduler`, and `wardby mcp` process with the
+sandbox configured keeps the pool up every 15 seconds. They coordinate through
+the database, so running several never overfills it. Each pass starts workers up
+to the size, retires idle workers that are older than the max age, gone, or over
+the size (oldest first), and removes leftovers. Changing the worker image, CPU or
+memory, runtime class, priority class, platform, namespace, gateway, or max age
+retires all idle workers of the old configuration automatically, about a
+minute after they started (a grace that keeps two replicas from retiring each
+other's workers mid rolling update); they are never claimed meanwhile. Lowering the
+size to `0` retires leftover pool workers within a pass, including any that a
+replica still running the old size refills during a rolling update. A short-lived
+command such as `wardby run` claims workers but does not warm new ones.
+
+### Naming, labels, and logs
+
+Pool workers are named `wardby-nwarm-<token>`. Kubernetes pods carry
+`wardby.io/pool=warm` and `wardby.io/warm-worker=<token>`, and still carry
+`wardby.io/component=native-run`, so the gateway NetworkPolicy admits them.
+Docker containers carry `io.wardby.pool=warm`. No new RBAC is needed: the
+permissions in [Server permissions](#3-server-permissions) already cover it.
+
+List idle workers with
+`kubectl get pods -n <namespace> -l wardby.io/pool=warm` or
+`docker ps --filter label=io.wardby.pool=warm`.
+
+Pool logs use the module `native-warm-pool`, with an `event` field:
+
+| `event`    | Meaning                                                                        |
+| ---------- | ------------------------------------------------------------------------------ |
+| `warmed`   | A pool worker became ready (with the time it took, in ms).                     |
+| `claimed`  | A run took an idle worker.                                                     |
+| `miss`     | No idle worker was available; the run cold-launched.                           |
+| `fallback` | A claimed worker failed the re-check or delivery; see the run's outcome above. |
+| `retired`  | An idle worker was replaced (with the reason: `stale`, `gone`, or `excess`).   |
+| `reaped`   | An abandoned or orphaned pool worker was removed.                              |
+
+If runs keep logging `miss`, the pool is smaller than demand, workers cannot be
+started (look for "starting a warm worker failed", and check the ResourceQuota),
+or the server running upkeep is not up.
+
+## Configuration reference
+
+| Variable                                | Launcher   | Required | Default                                                                                                         | Purpose                                                                                                                                                                                             |
+| --------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `NATIVE_SANDBOX_LAUNCHER`               | both       | Yes      | unset (sandbox off)                                                                                             | `docker` or `kubernetes`. Independent of `JOB_LAUNCHER`.                                                                                                                                            |
+| `NATIVE_SANDBOX_WORKER_IMAGE`           | both       | Yes      |                                                                                                                 | Pinned worker image. Docker: `repo@sha256:...` or a local image id. Kubernetes: a registry digest `repo@sha256:...` only.                                                                           |
+| `NATIVE_GATEWAY_CONTAINER`              | Docker     | Yes      |                                                                                                                 | Name of the running gateway container the server connects to each run's network.                                                                                                                    |
+| `NATIVE_SANDBOX_NAMESPACE`              | Kubernetes | No       | `KUBERNETES_NAMESPACE`, else `wardby-coding`                                                                    | Namespace for run pods and the gateway.                                                                                                                                                             |
+| `KUBERNETES_CONTEXT`                    | Kubernetes | No       | in-cluster or current context                                                                                   | Kubeconfig context the server uses.                                                                                                                                                                 |
+| `NATIVE_SANDBOX_RUNTIME_CLASS`          | Kubernetes | No       | `KUBERNETES_RUNTIME_CLASS`, else none                                                                           | RuntimeClass for run pods (for example gVisor).                                                                                                                                                     |
+| `NATIVE_GATEWAY_SERVICE`                | Kubernetes | No       | `wardby-native-gateway`                                                                                         | Name of the gateway Service in the run namespace.                                                                                                                                                   |
+| `NATIVE_GATEWAY_URL`                    | both       | No       | Docker: `http://wardby-native-gateway:8790/native-gateway/v1/call`; Kubernetes: the Service's ClusterIP on 8790 | What workers dial. Change only if the gateway is reachable another way. Must be an `http(s)` URL.                                                                                                   |
+| `NATIVE_SANDBOX_CPUS`                   | both       | No       | `1`                                                                                                             | CPU limit per worker (Kubernetes: request and limit).                                                                                                                                               |
+| `NATIVE_SANDBOX_MEMORY_MB`              | both       | No       | `512`                                                                                                           | Memory limit per worker (Docker: swap disabled; Kubernetes: request and limit).                                                                                                                     |
+| `NATIVE_SANDBOX_PIDS`                   | Docker     | No       | `128`                                                                                                           | Process limit per worker. Docker only: Kubernetes has no per-pod process limit.                                                                                                                     |
+| `NATIVE_SANDBOX_MAX_CONCURRENT`         | both       | No       | unset (no cap)                                                                                                  | At most this many sandbox runs at once across all replicas (counts active gateway sessions). A start past it fails with `native_sandbox_capacity`.                                                  |
+| `NATIVE_SANDBOX_WARM_POOL_SIZE`         | both       | No       | `0` (no pool; range 0-50)                                                                                       | Idle, already-isolated workers kept ready for runs to claim. See [Warm pool](#warm-pool). On Kubernetes, size the ResourceQuota for this many extra pods. Must be `0` when `WARDBY_LOW_POWER=1`.    |
+| `NATIVE_SANDBOX_WARM_MAX_AGE_MS`        | both       | No       | `1800000` (range 60000-21600000)                                                                                | An idle pool worker older than this is replaced and never claimed.                                                                                                                                  |
+| `NATIVE_SANDBOX_READY_TIMEOUT_MS`       | Kubernetes | No       | `120000` (range 1000-1800000)                                                                                   | How long a worker pod may take to start running. Use about `600000` on GKE Autopilot, where a cold gVisor node takes about two minutes.                                                             |
+| `NATIVE_SANDBOX_ENFORCEMENT_TIMEOUT_MS` | Kubernetes | No       | `30000` (range 1000-600000)                                                                                     | How long the in-pod isolation proof may take.                                                                                                                                                       |
+| `NATIVE_SANDBOX_PRIORITY_CLASS`         | Kubernetes | No       | `KUBERNETES_RUN_PRIORITY_CLASS`, else none                                                                      | PriorityClass for worker pods. Must not be a `system-` class.                                                                                                                                       |
+| `KUBERNETES_PLATFORM`                   | Kubernetes | No       | none                                                                                                            | `gke-autopilot` conforms worker pod resources to Autopilot's rules and requires the gVisor runtime class; `eks` targets EKS with a gVisor node group and also requires it. Shared with coding runs. |
+
+Gateway-side variables (`NATIVE_GATEWAY_LISTEN`, `NATIVE_GATEWAY_DENY_PORT`) are
+set on the gateway, not the server.
+
+## Limits and deadline
+
+- Each worker is limited by `NATIVE_SANDBOX_CPUS`, `NATIVE_SANDBOX_MEMORY_MB`,
+  and (Docker only) `NATIVE_SANDBOX_PIDS`, with a 64 MiB `/tmp`. Raise the
+  limits if tools run out of memory or processes.
+- A sandbox run has a maximum lifetime of 60 minutes. Past it the worker is
+  stopped and the run fails with `native_sandbox_deadline_exceeded`.
+- The agent's own turn and budget limits still apply as for any native agent.
+
+## Sub-agents
+
+A sandboxed run can delegate to sub-agents, including several in parallel.
+Sub-agents of a sandboxed run are always **managed runs**: the gateway records
+the delegation, and the server's scheduler leader starts the child on its next
+tick (about every 10 seconds). Each delegation therefore adds up to about ten
+seconds of start-up latency, and `wardby serve` or `wardby scheduler` must be
+running or the child never starts.
+
+A child runs in its own configured mode (a `control-plane` child runs in the
+server, a `sandbox` child in its own worker). Cancelling a parent run stops its
+open children.
+
+## Budget behavior
+
+The gateway is the budget authority for sandboxed runs. Before each model call
+it reserves that call's worst-case cost against the run's budget (and any
+budget group), calls the provider, then settles at the actual usage. A call the
+remaining budget cannot cover is refused and the run ends `budget_exhausted`
+instead of overspending. The worker cannot raise or bypass its budget because it
+never talks to the provider directly.
+
+## Failure modes
+
+| Error code                                                                                     | Meaning                                                                                                               | What to do                                                                                           |
+| ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| [`native_sandbox_unavailable`](../help/errors/native-sandbox-unavailable.md)                   | Agent is in `sandbox` mode but the server has no native sandbox. Fails before any spend.                              | Configure the sandbox (steps above) or set the agent back to `control-plane`.                        |
+| [`native_sandbox_worker_exited`](../help/errors/native-sandbox-worker-exited.md)               | The worker ended without producing a result.                                                                          | Check the tool code and the worker's memory and PID limits; run again.                               |
+| [`native_sandbox_deadline_exceeded`](../help/errors/native-sandbox-deadline-exceeded.md)       | The run passed its 60-minute maximum; the worker was stopped.                                                         | Split the work into smaller runs or sub-agents.                                                      |
+| [`native_sandbox_worker_lost`](../help/errors/native-sandbox-worker-lost.md)                   | The worker container or pod disappeared (for example its host or node restarted). It is never relaunched.             | Trigger the run again; check the Docker host or node stability.                                      |
+| [`native_sandbox_image_not_pinned`](../help/errors/native-sandbox-image-not-pinned.md)         | `NATIVE_SANDBOX_WORKER_IMAGE` is a mutable tag.                                                                       | Use a `repo@sha256:...` digest or a local image id.                                                  |
+| [`native_sandbox_docker_failed`](../help/errors/native-sandbox-docker-failed.md)               | A Docker command (pull, network create, connect, run) failed.                                                         | Read the message, then check the Docker daemon, image availability, and gateway name.                |
+| [`native_sandbox_network_unenforced`](../help/errors/native-sandbox-network-unenforced.md)     | Kubernetes: the pod's egress isolation could not be proven in time; the pod was removed.                              | Check that the CNI enforces NetworkPolicy and the gateway Service exposes 8790 and 8791.             |
+| [`native_sandbox_isolation_mismatch`](../help/errors/native-sandbox-isolation-mismatch.md)     | Kubernetes: the stored pod or NetworkPolicy differs from what Wardby built (an admission change).                     | Exempt the run namespace's native-run pods from mutating policies.                                   |
+| [`native_sandbox_gateway_unavailable`](../help/errors/native-sandbox-gateway-unavailable.md)   | Kubernetes: the gateway Service is missing or has no ClusterIP.                                                       | Create the Service (ClusterIP, not headless) or fix `NATIVE_GATEWAY_SERVICE`.                        |
+| [`native_sandbox_worker_unready`](../help/errors/native-sandbox-worker-unready.md)             | Kubernetes: the worker pod did not reach Running in time.                                                             | Check image pull, quotas, and scheduling with `kubectl describe pod`.                                |
+| [`native_sandbox_capacity`](../help/errors/native-sandbox-capacity.md)                         | `NATIVE_SANDBOX_MAX_CONCURRENT` runs are already active, or the namespace ResourceQuota is full. Not queued.          | Wait and retry, or raise the cap together with the ResourceQuota.                                    |
+| [`native_sandbox_warm_delivery_failed`](../help/errors/native-sandbox-warm-delivery-failed.md) | A claimed warm worker could not receive the run's input and could not be confirmed stopped within 30 seconds.         | Trigger the run again; check the node or Docker host and pod exec access.                            |
+| [`native_sandbox_requires_catalog`](../help/errors/native-sandbox-requires-catalog.md)         | No model catalog entry was recorded for the run: the process running it does not use the catalog-backed model router. | Run it on a standard `wardby serve`/`scheduler`/`mcp` process, or keep the agent on `control-plane`. |
+
+A run's error appears in its `error` field in `get_run` and `list_runs`.
+
+## Roll back
+
+Set the agent back to `control-plane` with `update_agent` or
+`wardby agent mode <name> control-plane`. Only new runs are
+affected: runs already started in sandbox mode finish there. To switch sandbox mode off for the whole
+deployment, unset `NATIVE_SANDBOX_LAUNCHER`; sandbox-mode agents then fail
+closed with `native_sandbox_unavailable` rather than running unisolated, so move
+them back to `control-plane` first if they should keep running.
+
+## Acceptance tests
+
+Three opt-in checks exercise the real isolation against a real runtime. Each is
+skipped unless its script sets its flag:
+
+- `npm run test:native-docker`: the Docker launcher on the local Docker host.
+- `npm run test:native-kind`: the Kubernetes launcher on a kind cluster
+  (`NATIVE_TEST_KIND_WORKER_IMAGE`).
+- `npm run test:native-cluster`: launcher-only isolation checks against the
+  deployed gateway of any cluster. It needs no database or model. Set
+  `NATIVE_TEST_WORKER_IMAGE` (required, a registry digest) and, as needed,
+  `NATIVE_TEST_CONTEXT`, `NATIVE_TEST_NAMESPACE`, `NATIVE_TEST_PLATFORM`,
+  `NATIVE_TEST_RUNTIME_CLASS`, `NATIVE_TEST_PRIORITY_CLASS`, and
+  `NATIVE_TEST_FORBIDDEN`, a comma-separated list of `host:port` addresses that
+  must be unreachable from a worker (for example the database's private IP on
+  port 3307).
+
+## Troubleshooting
+
+- **Gateway health.** `GET /healthz` on the gateway returns `{"ok":true}` when
+  its database answers and 503 otherwise. From the Docker host:
+  `docker exec wardby-native-gateway node -e "fetch('http://127.0.0.1:8790/healthz').then(r => r.text()).then(console.log)"`.
+- **List worker containers.** Workers and networks carry the label
+  `io.wardby.component=native-worker`:
+  `docker ps --all --filter label=io.wardby.component=native-worker`.
+  The server removes finished workers and, at startup, sweeps leftovers whose
+  runs have ended or passed their deadline.
+- **Kubernetes: list worker pods.** Run pods carry the label
+  `wardby.io/component=native-run`:
+  `kubectl get pods -n <namespace> -l wardby.io/component=native-run`.
+  The server removes finished pods (with their Secret and NetworkPolicy) and,
+  at startup, sweeps leftovers whose runs have ended or passed their deadline.
+- **Kubernetes: gateway health.** `kubectl get deploy,svc,endpoints -n <namespace> wardby-native-gateway`;
+  the Service must list ports 8790 and 8791 and have ready endpoints.
+- **Check a run.** Call `get_run` for the run's status and error code, then use
+  the matching error article from `search_help` or `get_help_article`.
+- **Workers cannot reach the gateway.** Confirm `NATIVE_GATEWAY_CONTAINER`
+  matches the running container's name exactly and that the gateway listens on
+  the port in `NATIVE_GATEWAY_URL` (default 8790).
+- **Sub-agents never start.** Confirm `wardby serve` or `wardby scheduler` is
+  running; the scheduler leader starts them.
+- **Tool code fails inside the sandbox.** The worker has no network except the
+  gateway and a read-only filesystem apart from `/tmp`; tools must use the
+  provided fetch, datastore, and secret functions.
+
+See also [Security deployment](security-deployment.md) and the
+[runtime architecture](architecture-runtime.md).

package/docs/release-verification.md

@@ -40,6 +40,15 @@ repository-scoped GitHub App installation, and a deliberately small budget.
 Verify the requested diff, terminal outcome, cost, resource cleanup, and branch
 cleanup. See [local coding-agent setup](coding-agent-setup.md).
 
+The bundled help catalog is built for the version in `package.json`.
+`appliesTo` on each help article must name its minimum release; later articles
+stay in source but are omitted from that release's CLI and MCP help. The build
+fails when an included article links to an omitted one. When adding a newer
+feature to an older article, move its guidance into a suitably versioned
+article or update the older article so it remains accurate for its stated
+minimum release. Mark newer features in the public `docs/` guides with their
+minimum release as well.
+
 Before production deployment, review [runtime architecture](architecture-runtime.md),
 [coding-worker isolation](coding-worker-isolation.md), and the
 [security deployment guide](security-deployment.md). A self-hosted operator is