diff --git a/docs/deployment.md b/docs/deployment.md index 631957a..c82de46 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -264,6 +264,200 @@ in-cluster is itself planned: today it is a host process, and its state director | Reconciler running in-cluster with Secrets injected into its environment | **planned** | | `AX_SNAPSHOTS_BUCKET` on your own bucket, worker pool sized to the cluster | your deployment's setting; documented, nothing to change in this repository | +## Production topology: ax on a Kubernetes cluster + +The maintainer's questions, answered from the code and the upstream checkouts under +`~/.cache/ousast/ax-src/`: how is it hosted in ax, is there one container, how does ax relate to +Kubernetes, and what scaling the pre-push hook would take. The decisions of 2026-10-02 set the +target: **two profiles of one code base**, `kind` (this laptop, kept as a first-class local +execution mode, where every change is proven first) and `k3s` (production). Everything marked +**planned** is not built; the rest is what runs on this host today. + +```mermaid +flowchart LR + subgraph dev ["Laptop or CI job"] + hook["ousast pre-push: local, 30 s deadline"] + cli["ousast plane run, remote mode (planned)"] + end + subgraph k3s ["k3s cluster (the kind profile is the same picture on one laptop)"] + subgraph axns ["Namespace ax-system"] + axs["ax-server Deployment + Redis"] + end + subgraph atens ["Namespace ate-system: Agent Substrate"] + ctl["ate-api-server, ate-controller, atelet"] + rt["atenet-router"] + eg["atenet-egress gateway"] + wp["WorkerPool: gVisor workers, runsc RuntimeClass, HPA (planned)"] + ewp["Engine WorkerPool: Joern as a task (planned)"] + end + end + ghcr["GHCR: runner and engine images by digest (planned)"] + s3[("S3 memory store: memory rows, task artifacts (planned)")] + llm["Model provider"] + hook -. "calls the CLI in remote mode (planned)" .-> cli + cli -- "ax apply, resume, delete: ingress or kubeconfig" --> axs + axs -- "ActorTemplate per Task" --> ctl + ctl --> wp + ctl --> ewp + cli -- "start request" --> rt + rt --> wp + wp -- "PUT artifacts, presigned" --> eg + eg --> s3 + eg -- "TLS passthrough" --> llm + ghcr -. "pull by digest" .-> wp + cli -- "polls: status, attribution" --> s3 +``` + +No inbound path exists in this picture: the CLI reaches ax-server and the router from outside, the +tasks push their artifacts to the store through the egress gateway, and the CLI reads the store. +Today's EndpointSlice back to a laptop (`ops/ax/receiver-service.yaml.tmpl`) is the kind profile's +device and does not appear in production. + +### ax, Kubernetes and Agent Substrate in three sentences + +**ax is a Kubernetes application**: a Deployment `ax-server` with a Redis beside it in the +namespace `ax-system` (`ax/deploy/ax-server.yaml` in the ax checkout; its controller runs with +`--template=default-template --template-atespace=ax-system`), and the `ax` CLI reaches it through a +`kubectl port-forward` to `svc/ax-server` (`ax/internal/tunnel/tunnel.go`), so `ousast plane run` +needs a kube context or an ingress, not a public endpoint. **ax does not run containers itself**: +it turns every Task into an ActorTemplate on Agent Substrate (`ax/internal/substrate/client.go`, +`CreateActorTemplate`), built from the Task's image and environment, and the image must be pinned +by digest (Substrate's `SandboxConfig` validation rejects tags: "All images must include a +digest"). **Agent Substrate is the layer that owns the machines**: in the namespace `ate-system` +it runs `ate-api-server`, `ate-controller`, the `atelet` DaemonSet, `atenet-router`, the +`atenet-egress` gateway, a Postgres and a RustFS (`substrate/manifests/ate-install/`), and three +CRDs under `ate.dev/v1alpha1`, `WorkerPool`, `SandboxConfig` and `CSIDriverConfig`; a +`WorkerPool` keeps warm worker pods (`ko://.../cmd/ateom-gvisor`), and an actor is one gVisor +sandbox inside one of those workers, booted from the golden snapshot that +[The plane on ax](plane.md) describes, suspended and resumed by the controller. Names are limited +to 63 bytes (`MaxNameLength` in `ax/pkg/apis/v1alpha1/types.go`), which is why the generated Task +names are short. + +**What k3s changes** (planned; nothing has been applied to a k3s cluster): k3s runs containerd +with no Docker socket, so the host-Docker path of `ousast plane alerts-engine` does not exist +there and the engine must become a task (below); Substrate's gVisor workers need `runsc` and a +`RuntimeClass` on the nodes they are scheduled to; k3s ships Traefik (the ingress the CLI can use +instead of a kubeconfig) and local-path storage. Images are built by GitHub Actions from tagged +commits, published to GitHub Container Registry and digest-pinned in the manifests; a private +package needs an `imagePullSecret` on the worker ServiceAccount. Substrate's and ax's own images +are built with `ko` from their checkouts and pushed to the same registry. The kind profile keeps +`localhost:5001` and `ops/ax/up.sh`. + +### One image, and what concurrency equals + +There is **one container image** for every Task: `plane/Dockerfile.runner` (`python:3.12-slim` +plus this package, PID 1 `/usr/local/bin/ax-task-runner`, which is +`openultrasast.plane.runner`). Each Task manifest under `plane/tasks/` names the same image by +digest (the pin is kept in `~/.cache/ousast/ax-src/runner-image`) and selects its work with +`spec.command`: the runner starts `python -m openultrasast.plane.tasks.` +(`runner.py`, `task_module`). `repo-facts`, `verify`, `agree`, `features`, `remember`, `alerts`, +`loop` and `roles` are modules in that image, not images of their own; the engine would be the +second image (planned). So the production answer to "how many containers" is: one image, one +actor per Task, and **an actor occupies a whole worker** (its limits are the ActorTemplate's, the +worker holds one actor at a time). Concurrency is therefore the number of workers in the +`WorkerPool`, nothing else: `ops/ax/workerpool.yaml.tmpl` declares `replicas: 2` of 1 CPU / +1.5 GiB, so at most two Tasks run at once on this host, and `ousast plane run --workers` must not +exceed the pool. Substrate ships an autoscaled pool +(`substrate/demos/autoscaled-workerpool/README.md`: an HPA on the external metric +`ate_workerpool_workers{state=at_capacity}` through prometheus-adapter, writing +`WorkerPool.spec.replicas`; its README says the demo is kind-only today) and request parking +(`substrate/demos/parking/`: the router holds a resume until a worker frees up). Neither is +applied by `ops/ax/up.sh`; the production profile's pool manifests and autoscaling rule are +**planned**. + +### The three components that are bound to the host today + +| Component | Today (the kind profile) | Production (the k3s profile, planned) | +| --- | --- | --- | +| Reconciler (`ousast plane run`, `src/openultrasast/plane/reconciler.py`) | a process on the operator's host; calls `ax` and `kubectl` against `kind-ousast`, holds the Run's state under `OUSAST_RESULTS` | **the reconciler stays the CLI.** An execution mode `local` or `remote`: in `remote`, the same `ousast plane run` from a laptop or a CI job submits the Run to ax-server in k3s (over the cluster's ingress or a kubeconfig), sends the start requests, then polls the store and prints the same `status` and attribution table. Credentials come from the caller's environment as today (CI secrets in a job; B.8's rule, no value in a manifest). An unattended in-cluster reconciler (a Deployment with a submit API, or a Job per Run) is a **later option**, not the first step | +| Artifact receiver (`plane/egress.py`, the `Receiver` thread inside the reconciler) | reached through the Service `ousast-receiver.ax-system` whose EndpointSlice points at the kind gateway address on the host (`ops/ax/receiver-service.yaml.tmpl`) | **no receiver in remote mode.** Tasks deliver their artifacts and fetch their inputs through presigned URLs on the S3 memory store (B.5, path 3; the store's hostname enters each Task's EgressPolicy, B.7), and the CLI reads completion from the store. The kind profile keeps the receiver thread; an in-cluster receiver Deployment (B.5, path 2) is not the chosen direction | +| Joern engine (`plane/engine_alerts.py`, the host's `openultrasast:dev` container, run with `--memory 3g`) | `ousast plane alerts-engine` runs it on the host, one container at a time, and marks the Run's `alerts` tasks done | **an `engine` task on a second, larger `WorkerPool`** (the engine does not fit a 1.5 GiB worker, and k3s has no Docker socket), from an engine image digest-pinned in GHCR, emitting the same `alerts.jsonl` rows and coverage; `alerts-engine` on the host stays as the development path | + +The S3 memory store (RustFS tested) is already external; in remote mode it is also the artifact +path, so it must be reachable from the CLI's host and, through the egress gateway, from the +workers. + +### Scaling the pre-push hook in production + +**Today** `ousast pre-push` is a local, deterministic check: it materialises base and head, +discovers the changed regions, runs the evidence ranker and arbiter on head and compares with base, +all within `--deadline` (30 s by default) and in `--mode advisory` unless blocking is opted into +([Pre-push: the delta check](scanning.md#pre-push-the-delta-check-experimental), +`src/openultrasast/push/`, [Engine and pre-push](ops/README.md#experimental-pre-push-integration)). +**The plane is not in that path**: no hook submits a Run, no model is called without an explicit +`--model-config`, and nothing leaves the developer's machine. + +**The production shape** (planned, none of it built) splits the work by latency: + +1. **Blocking, inside the hook's deadline**: what runs today, the quick rules and the delta + engine on the changed regions. It stays local and deterministic, so the push is never held for + a model or a cluster. +2. **Asynchronous, on the plane**: the hook or the CI job calls the CLI in remote mode with a + *delta Run* whose candidates are the functions the push changed; the Run is the per-case chain + of [The plane on ax](plane.md#per-case) (`facts`, `verify` a and b, `agree`, `verify` c on the + disputed only, `final`). The caller either waits, with its own deadline, for the CLI to print + the status and attribution table, or returns at once and a later `ousast plane status ` + reports from the store; a commit status check or a review comment would be built on that. The + worker pool is sized to the push rate or autoscaled on `at_capacity` workers. An unattended + in-cluster reconciler that accepts submissions without a CLI session is the later option named + above. + +**Cost per push, estimated from measured rates.** Two measured per-candidate rates exist for one +model verdict: `$0.003215` (`spend.cost_per_candidate_evaluate_usd` in +`benchmarks/measurements/2026-10-01-decision-engine-injection-slice/record.json`) and `$0.0021` +(exp-002 arm A, `overall.usd_per_candidate.A` in +`benchmarks/measurements/2026-10-02-exp-002/record.json`). A push that changes five functions needs +two verify passes per candidate: 5 x 2 x $0.0021 = $0.021, or 5 x 2 x $0.003215 = $0.032 at the +higher rate, plus a third pass on the disputed candidates only. That is where "about two cents per +push" comes from; it is arithmetic over the decision engine's measured rates, not a measurement of +a push Run, and `ousast plane status` would print the real figure per Task. + +**What is not built** (each is a named gap, not a configuration): + +- The delta-Run command. `ousast plane scan --base --head ` **does not + exist**; `ousast plane` has `run`, `status`, `doctor`, `remember`, `memory-normalise`, + `workspaces`, `harvest` and `alerts-engine` (`src/openultrasast/cli.py`). +- A candidates task for an arbitrary repository. `repo-facts` takes its candidates from a + population's validation set; a step that derives them from a diff is not written. +- Workspace generation from a URL and a commit outside a population. `plane/generate.py` is + population-driven (`read_cases` reads a validation set and a population TOML), so a Run for a + repository that is not in a population cannot be generated today. +- The remote execution mode itself: the `local`/`remote` switch, configurable cluster context, + ax-server and router addresses (the `kind-` prefix is hard-coded, B.4), presigned delivery from + the runner to the store, and the CLI reading completion and `summary.json` from the store + instead of its receiver thread. +- The engine task and its WorkerPool, the GHCR build, the production pool and autoscaling + manifests, and the k3s runbook and checklist. +- The check or comment that carries the asynchronous verdict back to the push. + +### Sizing + +The worker is the unit. Every Task's `limits` fit the 1 CPU / 1.5 GiB worker of +`ops/ax/workerpool.yaml.tmpl`; the requests are what the Task declares, the worker is what it +occupies. + +| Task (`plane/tasks/*.yaml`) | Requests | Limits | Per push | +| --- | --- | --- | --- | +| `repo-facts` | 250m / 512Mi | 1 CPU / 1280Mi | 1 (`facts`) | +| `verify` | 250m / 384Mi | 1 CPU / 1Gi | 2 (`va`, `vb`), plus 1 (`vc`) on disputed candidates | +| `agree` | 100m / 256Mi | 1 CPU / 512Mi | 1 (`agree`; `final` reuses it after `vc`) | +| `features`, `remember` | 250m / 512Mi; 100m / 256Mi | 1 CPU / 1Gi; 1 CPU / 512Mi | optional, for the decision engine and the memory | +| `alerts`, `loop` | 250m / 512Mi | 1 CPU / 1280Mi | not in a push Run (loop Runs only) | +| `roles` | 250m / 384Mi | 1 CPU / 1Gi | not in a push Run (harvest Runs only) | +| `engine` (planned) | from a measured run | above 3 GiB (the host run uses `--memory 3g`) | its own pool, not the default one | + +- **Actors per push**: 4 (`facts`, `va`, `vb`, `agree`), 6 with a tie-break (`vc`, `final`); + `features` and `remember` add two more when the verdict is to be kept. +- **Critical path**: `facts` then `va` and `vb` side by side, then `agree`, then (sometimes) `vc` + and `final`: three to five Task boots in series, each a golden-snapshot restore plus the model + calls of the verify passes. +- **One actor per worker**: `agree` asks for 256Mi and still holds a 1.5 GiB worker while it runs, + because the worker's capacity, not the Task's request, is the unit. A pool of `W` workers runs + at most `W/2` pushes through their verify phase at once; on this host (`W = 2`) that is one + push at a time, and every further push waits (the reconciler's `--workers` bound, or Substrate's + request parking if the pool is saturated). Autoscaling the pool on `at_capacity` workers is the + upstream answer and is **planned** here. + ## C. The manifests under `plane/` | Path | Moves unchanged? | What changes | diff --git a/docs/plane.md b/docs/plane.md index 50d275a..11276f4 100644 --- a/docs/plane.md +++ b/docs/plane.md @@ -131,6 +131,14 @@ flowchart LR model `roles`); `ousast plane alerts-engine` produces a Run's `alerts` from the Joern engine image on the host for PHP and other languages quick mode does not cover. +## Where this runs in production + +ax is a Kubernetes application over Agent Substrate, every Task runs the one runner image as an actor that +occupies a whole worker, and two profiles of this code base are the target: `kind` on a laptop (today) and `k3s` +in production (planned), where the same CLI submits Runs remotely and the tasks deliver to the S3 store: +[Production topology: ax on a Kubernetes cluster](deployment.md#production-topology-ax-on-a-kubernetes-cluster) +draws it and sizes the pre-push hook at scale. + ## Tasks | Task | Model | Does |