OXYGENHUB
# de1d7926185f oxygenflow / docs / spec.md
28.7 KiB · Markdown · last changed feat(cache): directories keep their times too; FLOW_HEADS only without OXY_BUILD (refs #52) 23 days ago renderedsource blame history raw
a083cc80 Andy McCall ↶ 1
# OxygenFlow (flow) — Deterministic Execution & Provenance Pipeline Specification
2
3
| | |
4
|---|---|
5
| **Format version** | 1 |
6
| **Date** | 2026-09-28 |
7
| **Status** | Draft 0.1 |
8
| **Target VCS** | Oxygen (oxy) Draft 0.8i |
9
| **Audience** | Implementers, Security Architects, and Systems Engineers |
10
11
12
The key words MUST, MUST NOT, SHOULD, SHOULD NOT, and MAY are to be
13
interpreted as described in RFC 2119.
14
15
## 1. Overview and Core Invariants
16
17
OxygenFlow (flow) is a content-addressed, hermetic execution engine, runner system,
18
and pipeline language designed natively for the Oxygen (oxy) version control
19
system.
20
21
Existing runner engines (GitHub Actions, GitLab CI, Forgejo Runner) suffer from
22
structural flaws:
23
1. Workspace Bloat: Full clones, index unpacks, and checkout scans dominate I/O.
24
2. String Injection: Shell interpolation within untyped YAML files produces
25
   expression injection and command execution exploits.
26
3. Decoupled Supply Chain: Attestations (SLSA, in-toto, Cosign) exist outside
27
   the VCS, relying on external registries rather than native repository trust.
28
4. Coarse Caching: Opaque tarballs keyed by arbitrary string hashes fail to
29
   leverage commutative history or granular dependency graphs.
30
31
OxygenFlow solves these liabilities through direct integration with Oxygen:
32
- Zero-Copy Workspaces: Jobs mount workspaces directly from Oxygen's FastCDC-
33
  chunked, BLAKE3-addressed Content-Addressable Store (CAS) using Copy-on-Write
34
  (COW) overlays.
35
- Commutative History & Impact Trees: Pipelines evaluate over change closures
36
  rather than linear snapshot sequences. Commuting changes automatically reuse
37
  cached execution receipts without redundant re-execution.
38
- Micro-Engine Sandboxing: Jobs run inside isolated environments (WASM, gVisor,
39
  or MicroVMs) with strict, deny-by-default capabilities and no ambient
40
  network egress.
41
- Native Cryptographic Provenance: Provenance and execution receipts are
42
  generated outside the untrusted guest, encoded as deterministic CBOR, and
43
  signed using composite Ed25519 + ML-DSA-65 keys as native Oxygen Attest
44
  objects governed by in-repository Policy rules.
45
46
## 2. Threat Model and Security Architecture
47
48
### 2.1 Adversaries
49
- Untrusted Proposal Author: Submits code to an open repository containing
50
  malicious build configurations intended to escape the runner, exfiltrate
51
  secrets, or corrupt shared worker caches.
52
- Malicious Dependency / Upstream: Third-party dependencies invoked during
53
  build time attempting out-of-band network calls or host file modification.
54
- Compromised Runner / Malicious Worker: An execution node attempting to
55
  forge successful build receipts or inject backdoors into published artifacts.
56
57
### 2.2 Security Invariants
58
- I1 Deny-by-Default Execution: Sandboxes possess no network interfaces
59
  (excluding loopback when requested) and no host filesystem access unless
60
  explicitly granted in policy-signed configuration.
61
- I2 Injection-Free Invocation: Configuration parsing directly yields an argv
62
  string vector executed via execve(). Shell interpretation (/bin/sh -c) does
63
  not exist.
64
- I3 Host-Enforced Provenance: The running payload cannot author, inspect, or
65
  alter its own provenance statement. Provenance is emitted solely by the
66
  isolation hypervisor boundary.
67
- I4 Cryptographic Identity & Authorization: Runners execute using an Oxygen
68
  Identity whose KeyId is enrolled as a delegate in the repository's Policy.
69
  Unenrolled runners cannot publish recognized attestations or advance gates.
70
71
## 3. The OxygenFlow Configuration Language (.flow)
72
73
Pipelines are declared in KDL syntax within .flow/pipeline.kdl at the
74
repository root. KDL provides strict typing, structured nesting, and rejects
75
arbitrary text macro expansion.
76
b647ab72 Andy McCall ↶ 77
Strings follow KDL 2.0, which has no `\033`, `\e` or `\x` escapes: ESC,
78
for ANSI colours in a job's output, is `\u{1b}` (`"\u{1b}[32mok\u{1b}[0m"`),
79
and `flow check` says so when it meets one of the others. Inside the
80
guest, `/dev/fd` and `/dev/stdin|stdout|stderr` link to `/proc/self/fd`
81
as on any Linux system, so bash process substitution works.
82
a083cc80 Andy McCall ↶ 83
### 3.1 Pipeline Specification Schema
84
85
```kdl
86
schema-version 1
87
88
// Define the hermetic execution boundary
89
sandbox "rust-builder" {
90
    runtime "microvm"       // Options: "wasm" | "gvisor" | "microvm"
91
    rootfs "cas://blob/9b5c2a1e8f3d4e7a6b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a"
92
    memory-limit "4GiB"
93
    cpu-limit 4
94
    network "isolated"      // Options: "isolated" | "loopback" | "egress"
95
}
96
97
// Job evaluated based on Oxygen change closure
98
job "compile-core" {
99
    sandbox "rust-builder"
100
101
    // Commutation boundary: runs only if change closure touches these paths
102
    scope "crates/oxy-core/**" "crates/oxy-server/**" "Cargo.*"
103
104
    // Zero-copy workspace mount backed by Oxygen CAS
105
    mount {
106
        source "oxy://workspace"
107
        target "/src"
108
        include "crates/oxy-core" "crates/oxy-server" "Cargo.toml" "Cargo.lock"
109
        readonly #true
110
    }
111
112
    // Ephemeral scratch space
113
    mount {
114
        source "ephemeral://tmpfs"
115
        target "/src/target"
116
        size "8GiB"
117
    }
118
119
    env {
120
        RUSTFLAGS "-Dwarnings"
121
        CARGO_INCREMENTAL "0"
122
    }
123
124
    // Direct argv execution vector (no subshell)
125
    exec "cargo" "build" "--release" "--package" "oxy-core"
126
127
    output {
128
        artifact "oxy-core-lib" {
129
            path "/src/target/release/liboxy_core.rlib"
130
            format "blob"
131
        }
132
    }
133
}
134
135
job "unit-tests" {
136
    sandbox "rust-builder"
137
    depends-on "compile-core"
138
139
    mount {
140
        source "oxy://workspace"
141
        target "/src"
142
        readonly #true
143
    }
144
145
    mount {
146
        source "artifact://compile-core/oxy-core-lib"
147
        target "/src/target/release/liboxy_core.rlib"
148
    }
149
150
    exec "cargo" "test" "--release" "--package" "oxy-core"
151
}
152
153
publish "release-provenance" {
154
    depends-on "unit-tests"
155
156
    attest {
157
        kind "provenance"
158
        bind-ref "bookmarks/main"
159
        include-artifacts "compile-core/oxy-core-lib"
160
    }
161
}
162
163
bf7bb1b8 Andy McCall ↶ 164
**What starts a job.** An `on` block, at the top of the pipeline or in a job (the job's wins), names the events that run it: `push` with bookmark globs (none: any bookmark), `tag` with tag globs (none: any tag), `manual` ("Run pipeline", `oh run start`) and `schedule` with five-field cron lines on the hub's clock (UTC), run on the default bookmark. Without `on`, a job runs on every push and by hand, as before. A run has only the jobs its event starts (and what they depend on); an event that starts no job starts no run. A rerun repeats its run's event.
165
166
```kdl
167
on {
168
    push "main" "feature/*"
169
    manual
170
}
171
job "dist" {
172
    on {
173
        tag "v*"
174
        manual
175
    }
176
    …
177
}
178
```
179
02b127d2 Andy McCall ↶ 180
**Time limits.** A job may say how long it may run with `timeout "90m"` (hours, minutes and seconds, as `"2h"`, `"1h30m"` or `"45s"`, from a minute to a day); a sandbox's `timeout` is the default for its jobs. Without one, the hub's default applies, and the hub caps every job at the site's maximum (both set by an administrator on Admin → Runners). The runner stops a job at its limit, and the hub ends one its runner stopped reporting a few minutes after it. A timeout is part of the compiled job, so a job without one compiles as before.
181
e576e086 Andy McCall ↶ 182
**Runner labels.** A sandbox or a job may say `runs-on "LABEL" ...`: lower-case letters, digits, `-`, `_` and `.`, at most 64 bytes each, given on one or more lines. A job needs a runner that has every label its sandbox and it name. A runner reports its labels and architecture when it registers and on each claim (`flow runner register --label`). The hub hands a job only to a runner with all of them, within the runner's scope (OxygenHub spec 13.2), and a job no runner can take waits, saying so on the queue. Labels are part of the compiled job, so a job that asks for none compiles as before.
183
a083cc80 Andy McCall ↶ 184
### 3.2 Canonical Compilation
185
Upon commit, .flow/pipeline.kdl is validated and compiled into a deterministic
186
CBOR job-graph blob. Runners evaluate the canonical CBOR to prevent syntax or
187
parser ambiguities across varying client platforms.
188
189
## 4. Sandbox Execution Engine
190
191
OxygenFlow implements three distinct isolation tiers depending on the workload:
192
193
### 4.1 Level 0: WASM Component Sandbox
194
- Intended for static linters, formatters, doc generators, and policy checks.
195
- Runs on a standard WebAssembly System Interface (WASI) runtime.
196
- Startup latency: < 5 ms.
197
- Zero host I/O; virtualized file system presented in-memory.
198
199
### 4.2 Level 1: Intercepted Syscall Isolation (gVisor / Landlock + seccomp-bpf)
200
- Intended for standard compilation and hermetic test suites.
201
- Emulates or filters Linux system call interfaces in user space.
202
- Blocks access to raw network sockets, real-time hardware clocks, and device
203
  nodes.
204
- Memory and execution CPU quotas are strictly bounded via cgroups v2.
205
206
### 4.3 Level 2: MicroVM Isolation (Firecracker / Cloud-Hypervisor)
207
- Intended for kernel tests, multi-container integration, and untrusted code.
208
- Ephemeral Linux microVM booting in < 80 ms.
209
- The root filesystem is presented as a read-only virtio-block device mapped
210
  directly to FastCDC chunks stored in Oxygen's CAS.
211
- Guest VM memory is cleared upon termination.
212
213
## 5. Content-Addressable Storage (CAS) & Zero-Copy Mounting
214
215
OxygenFlow runners bypass traditional clone operations. Repositories are accessed
216
directly via the local object store (.oxy/objects/) or streamed on demand
217
using Oxygen's wire protocol.
218
219
### 5.1 FUSE Overlay Mounting (flow-casfs)
220
1. The runner receives a task targeting an Oxygen State ObjectRef (a sorted
221
   list of maximal heads).
222
2. The nearest Checkpoint is resolved. Uncommitted changes between the
223
   checkpoint and heads are replayed into a virtual tree in-memory.
224
3. The virtual tree is exposed to the sandbox via flow-casfs:
225
   - File reads resolve chunks using the FastCDC gear table (32 KiB to 256 KiB,
226
     mean 64 KiB) pinned in Oxygen Spec Section 13.2.
227
   - Missing chunks are fetched lazily using the POST /objects protocol.
228
   - To prevent FUSE context-switch bottlenecks on many small reads, flow-casfs aggressively mmaps chunk data and utilizes host page caching.
229
   - All guest mutations are diverted to a scratch tmpfs layer; base objects
230
     remain immutable.
231
232
### 5.2 Artifact Capture
233
1. At task completion, flow-casfs scans the paths declared in the output block.
234
2. Modified outputs are chunked with FastCDC, hashed via BLAKE3-256, and
235
   written as canonical Blob and Chunk objects.
236
3. Output ObjectRefs are stored directly in the Oxygen repository.
9a6fac2b Andy McCall ↶ 237
4. Outputs are read when the job passes. An artifact with `when "always"`
238
   (default `when "passed"`) is also read when the job fails or is stopped
239
   at its time limit, so a test report survives the failure it describes.
240
   From a job that did not pass it is kept and shown, but its receipt never
241
   names it, and one that cannot be read is only noted in the log.
a083cc80 Andy McCall ↶ 242
9a6fac2b Andy McCall ↶ 243
```kdl
244
output {
245
    artifact "junit" {
246
        path "/src/target/junit.xml"
247
        when "always"
248
    }
249
}
250
```
251
6d53fb7d Andy McCall ↶ 252
5. A `report` output (OxygenHub `docs/reports.md`) names a directory
253
   holding `report.toml` at its top. The runner reads its regular files
254
   (links and anything else are left out, never followed; file names hold
255
   letters, digits, `.`, `_`, `-` and `+`; at most 2000 files and 512 MiB),
256
   uploads each to `POST /api/v1/flow/jobs/{job}/reports/{name}/files` with
257
   its path in `X-Flow-Report-Path`, then uploads a manifest,
258
   `{"version":1,"files":[{"path","blob","size"}]}`, as the output under
259
   the report's name, checking every blob the hub answers. The receipt
260
   names the manifest. Reports and artifacts share names; a report's kind
261
   is part of the job's hash (`[name, path, "report"]`).
262
263
```kdl
264
output {
265
    report "frame-timing" {
266
        path "/src/out/report"
267
        when "always"
268
    }
269
}
270
```
271
d60aac6c Andy McCall ↶ 272
### 5.4 The Build Cache (oxygenflow#28)
273
274
An `ephemeral://disk` mount may name a `cache`, and the files that key it:
275
276
```kdl
277
mount {
278
    source "ephemeral://disk"
279
    target "/src/target"
280
    size "24GiB"
281
    cache "target"
282
    key "Cargo.lock" "rust-toolchain.toml"
283
}
284
```
285
286
Such a disk is not always empty at the start. Each runner keeps a pool of
287
the disks of passing jobs, by repository, job, cache name and bookmark,
288
named by the **key**: the BLAKE3 of the sandbox image, the job's name, the
289
cache name, and each key file's content in the job's state. A job's disk
290
starts as, in order: its bookmark's disk with the same key (moved), its
291
bookmark's newest disk (moved), another bookmark's with the same key and
292
then another's newest (copied, so a proposal never takes the default
293
bookmark's), and otherwise an empty disk. A disk must be the size the
294
mount asks for.
295
296
- **Only passing jobs keep a disk.** When the job and its outputs pass,
297
  its cached disks go back into the pool under their key; otherwise they
298
  are discarded with the scratch directory, so nothing a failing job wrote
299
  reaches a later one.
300
- **The receipt says so.** The job's environment gains `cache TARGET` with
301
  the key and what the disk started from, so the receipt's environment
302
  hash differs from a cold build's.
303
- **Bounded.** The pool keeps under `cache_gb` in the runner's config
304
  (default 64 GiB) by dropping the disks used longest ago.
82cf6e91 Andy McCall ↶ 305
- **Unchanged sources keep their times** (oxygenflow#52). Beside each kept
306
  disk the pool keeps its sources: each workspace file's content hash and
307
  the mtime it had, in whole seconds (what the workspace image keeps). A
308
  job that takes the disk gives each file whose content is unchanged that
309
  mtime back before the workspace is imaged; a changed or new file keeps
310
  the time of its checkout, newer than anything on the disk. A build tool
311
  that judges freshness by time, such as cargo, then rebuilds exactly the
312
  crates whose sources changed, where a fresh checkout would make every
de1d7926 Andy McCall ↶ 313
  path crate look changed. Directories are kept the same way, by their
314
  listing (the names in them): an unchanged one gets its old time back,
315
  one that gained or lost an entry keeps its new time, so a build
316
  script's `rerun-if-changed` on a directory sees exactly what changed.
317
  The log says how many files and directories kept their times. A build
318
  script that reads a per-state value (the Oxygen crates' `FLOW_HEADS`)
319
  reruns on every state; those crates read it only when `OXY_BUILD` is
320
  unset, so a pipeline that sets `OXY_BUILD` keeps them fresh.
82cf6e91 Andy McCall ↶ 321
- **Jobs go where their cache is** (oxygenflow#51). Each claim lists the
322
  caches the runner holds a disk of (`caches`, each
323
  `flow_core::api::cache_slot(repo, job)`), and the hub ranks a runner
324
  holding a job's cache above one holding its image (§11.4): a job another
325
  free runner holds the cache for is held for it for up to 15 seconds, and
326
  `placed` says "holds its build cache".
d60aac6c Andy McCall ↶ 327
- The syscall tier keeps its disks empty for now.
328
- A cache is a speed-up, never a source of truth: jobs must build
329
  correctly from an empty disk, which a key change or an eviction gives
330
  them at any time.
331
a083cc80 Andy McCall ↶ 332
## 6. Commutative Execution & Change Caching
333
334
In Oxygen, changes that do not share scopes (referenced atoms, placements, or
335
nodes) commute. OxygenFlow exploits this invariant to provide granular caching.
336
337
### 6.1 Execution Receipt Object
338
Every successful or failed job run emits an immutable Receipt:
339
340
```cbor
341
Receipt {
342
  version        [0]: 1
343
  job_name       [1]: text
344
  pipeline_hash  [2]: ObjectRef
345
  scope_tree_hash [3]: ObjectRef     // BLAKE3 tree hash of the materialized scope
346
  inputs         [4]: [ObjectRef]   // Artifacts and input files consumed
347
  environment    [5]: ObjectRef     // Hash of rootfs, compiler flags, and argv
348
  outputs        [6]: [ObjectRef]   // Produced artifact blobs
349
  exit_code      [7]: u32
350
  duration_ms    [8]: u64
351
}
352
```
353
354
A Receipt is hashed as an Oxygen object with type name "receipt":
355
ObjectRef = BLAKE3-256("oxy1 receipt " || decimal(len) || 0x00 || body)
356
357
### 6.2 Cache Re-use Invariant
358
Let Scope(J) be the file paths and tree nodes declared by job J.
359
Because changes that do not share scopes commute, we do not need to track lists of ChangeHashes. Instead, we hash the materialized tree of Scope(J).
360
361
If an existing Receipt R exists such that:
362
  R.job_name == J.name &&
363
  R.pipeline_hash == Hash(J) &&
364
  R.scope_tree_hash == TreeHash(Scope(J)) &&
365
  R.environment == CurrentEnvironmentHash
366
367
Then the job execution is bypassed. R.outputs are mapped into downstream
368
dependents immediately as a cached-commuted hit.
369
370
## 7. Native Provenance Specification
371
372
OxygenFlow formalizes build provenance as a native, tamper-evident Oxygen Attest
373
object (kind: "attest"). Provenance is generated exclusively by the runner
374
hypervisor, not the guest payload.
375
376
### 7.1 Provenance Object Schema
377
378
```json
379
Attest {
380
  version [0]: 1
381
  kind    [1]: "attest"
382
  repo    [2]: bytes(16)               // Oxygen Repository ID
383
  hlc     [3]: HLC                     // Hybrid Logical Clock
384
  body    [4]: {
385
    "type": "flow/provenance/v1",
386
    
387
    // Subject artifacts produced by the build
388
    "subjects": [
389
      {
390
        "name": text,
391
        "ref": ObjectRef,              // BLAKE3 hash of output blob
392
        "media_type": text
393
      }
394
    ],
395
396
    // Builder platform and execution identity
397
    "builder": {
398
      "runner_id": KeyId,              // ObjectRef of runner's Oxygen Identity
399
      "isolation_level": text,         // "wasm" | "gvisor" | "microvm"
400
      "hypervisor_image": ObjectRef    // Rootfs blob digest
401
    },
402
403
    // Exact input materials
404
    "materials": {
405
      "state_heads": [ChangeHash],     // Oxygen heads of the state built
406
      "scope_tree_hash": ObjectRef,        // Captures exact state without O(N) array bloat
407
      "inputs": [
408
        {
409
          "name": text,
410
          "ref": ObjectRef             // Content hash of locked dependencies
411
        }
412
      ]
413
    },
414
415
    // Structured execution arguments
416
    "invocation": {
417
      "job": text,
418
      "pipeline_spec": ObjectRef,      // ObjectRef of .flow/pipeline.kdl
419
      "argv": [text],                  // Unmodified execution vector
420
      "env": map<text, text>           // Explicitly whitelisted environment
421
    },
422
423
    // Environment observations
424
    "metadata": {
425
      "started_on": u64,               // Wallclock milliseconds
426
      "finished_on": u64,
427
      "hermetic": bool,                // Verified zero outbound network access
428
      "reproducible": bool
429
    }
430
  }
431
}
432
```
433
434
### 7.2 Composite Signatures
435
All provenance attestations are signed using Oxygen's composite signature
436
construction (Ed25519 and ML-DSA-65):
437
438
```cbor
439
Signature {
440
  key [0]: KeyId
441
  alg [1]: 1                           // 1 = Ed25519 + ML-DSA-65
442
  ed  [2]: bytes(64)                   // Classical signature
443
  ml  [3]: bytes(3309)                 // Post-quantum signature
444
}
445
```
446
447
Both signatures are computed over:
448
  "oxy1 sig attest\0" || KeyId || ObjectRef
449
450
## 8. Policy Integration & Bookmark Gates
451
452
Oxygen repositories enforce branch and bookmark protections via signed Policy
453
objects (Oxygen Spec Section 14.5). OxygenFlow integrates provenance directly into
454
policy evaluation during push validation.
455
456
### 8.1 Policy Gate Definition
457
A Policy rule governing a bookmark MAY demand valid OxygenFlow attestations. To mitigate a compromised authorized worker, high-security repositories can require **Consensus Builds** by setting the threshold > 1. This requires multiple independent runner identities to arrive at the exact same output hashes and both sign it.
458
459
```json
460
PolicyRule {
461
  pattern: "bookmarks/production"
462
  keys: [ KeyId ]
463
  threshold: 1
464
  require: "signed"
465
  allow_conflicts: false
466
  require_attestations: [
467
    {
468
      type: "flow/provenance/v1",
469
      job: "release-provenance",
470
      require_hermetic: true,
471
      signer_roles: [ "official-worker" ]
472
    }
473
  ]
474
}
475
476
### 8.2 Push Verification Sequence (VCS Engine Enforcement)
477
When a push request arrives at an Oxygen server attempting to update a
478
protected bookmark:
479
1. Object Integrity: Validate that all changes, chunks, and blobs exist and match
480
   their BLAKE3 hashes.
481
2. Attestation Resolution: Verify that an Attest object of type
482
   "flow/provenance/v1" is present, referencing the exact heads of the new
483
   State.
484
3. Identity Verification: Validate that the attestation's composite signature
485
   resolves to a KeyId listed as an authorized delegate of the repository
486
   policy roots.
487
4. Invariant Checking: Confirm that the provenance statement records
488
   "hermetic: true" and exit code 0.
489
5. Atomic Update: If validation fails at any point, the entire push is refused
490
   with ok = false.
491
492
## 9. Zero-Environment Secret Brokering
493
494
OxygenFlow forbids the injection of raw secret strings into process environment
495
tables to eliminate accidental leaking via child process dumping, procfs
496
reads, and verbose compiler logging.
497
498
### 9.1 Ephemeral Secret Broker
499
1. If a job requires a credential (e.g., signing key, cloud deployment token),
500
   it declares a secret mount:
501
     secret "deploy-token" {
502
         vault-ref "infra/tokens/prod"
503
         mount-path "/run/secrets/token"
504
     }
505
2. The runner negotiates a short-lived token lease from the configured vault.
506
3. The secret is mounted onto an ephemeral, in-memory ramfs location inside
507
   the sandbox with access mode 0400, owned exclusively by the worker process.
508
4. Upon process termination, the memory pages are zeroized and the token is
509
   marked for immediate revocation at the vault.
510
511
## 10. Conformance and Verification Requirements
512
513
A conforming OxygenFlow implementation MUST pass the following tests:
514
515
1. Injection Immunity: Attempting to supply unescaped shell metacharacters
516
   (; && | ` $() \n) in any job field MUST pass those characters as literal
517
   bytes to argv; subshells MUST NOT be spawned.
518
2. FastCDC Determinism: Chunks produced by artifact extraction MUST match
519
   the gear table cuts and BLAKE3 hashes generated by Oxygen's core chunker.
520
3. Commutation Hit Invariance: For any two commuting changes A and B, running
521
   a pipeline on State(A, B) MUST reuse cached receipts generated on State(A)
522
   for any job whose scope does not intersect the touched paths of B.
523
4. Non-Downgrade Attestation: An attestation missing the ML-DSA-65 component
524
   MUST be rejected by policy verification.
525
5. Hermetic Network Isolation: Jobs configured with network "isolated" MUST
fd2d4822 Andy McCall ↶ 526
   have outgoing TCP SYN and UDP packets dropped at the hypervisor boundary.
630ee660 Andy McCall ↶ 527
## 11. Runner Capabilities and Placement (proposed 2026-10-04; §11.2 and `arch` of §11.3 done the same day; tiers of §11.1, §11.5 and the waiting reasons of §11.4 done 2026-10-05, oxygenflow#36)
fd2d4822 Andy McCall ↶ 528
529
A runner MUST never take a job it cannot run or cannot finish well: the
530
wrong architecture, no hardware virtualisation for the MicroVM tier, too
531
little memory, an image it does not hold, or a machine too slow for the
532
job's time limit. Today a runner reports its architecture, OS, labels,
533
job slots, memory and vCPUs when it registers and on each claim, and a
534
claim carries the tiers it can run, the memory and vCPUs free now, and
535
the images it holds; the hub matches tier, room, labels, scope and image.
536
What is missing: architecture is reported but never matched (an image's
537
architecture is implicit in its bytes), a pipeline cannot say which
538
architecture it needs or offer a rootfs per architecture, speed and load
539
play no part, and a runner cannot decline a job it was handed.
540
541
### 11.1 Capability Profile
542
543
At registration and on every claim a runner sends its profile:
544
545
| Field | Meaning |
546
|---|---|
547
| `arch`, `os`, `kernel` | `x86_64`, `aarch64`, `riscv64`, …; the kernel release |
548
| `tiers` | The sandbox tiers it can honour: `microvm` only with `/dev/kvm` usable (a board without KVM, such as an OrangePi RV2, offers `syscall`, §4.2, and `wasm`) |
549
| `memory_mib`, `cpus`, `max_jobs` | What its jobs share |
550
| `images` | The rootfs images it holds, each with the architecture its manifest records (§11.2) |
551
| `labels` | As §3.1 |
62829d15 Andy McCall ↶ 552
| `speed` | A score and a class from 1 (slow) to 5 (fast), measured by the runner at start, again every 15 minutes while it runs no job, and by `flow runner bench`: a fixed one-thread workload (BLAKE3 over 256 MiB, and a sort of 4 Mi words, where a C compiler cannot be assumed) whose time on the reference machine (Earth, about 225 ms) scores 100; class 3 is 70–139, each class a factor of two (done 2026-10-11, `facts` on the claim) |
553
| `load` | The 1-minute load average (×100), and the free disk where jobs' disks are made, sent with every claim (`facts`); memory free and jobs running as before |
fd2d4822 Andy McCall ↶ 554
555
### 11.2 Image Manifests Carry the Architecture
556
557
`flow rootfs import` reads the ELF header of the image's `/bin/sh` and
558
records its architecture in the CAS manifest beside the hash. A runner
559
refuses to import an image for another architecture (there is no
560
emulation tier). An image imported before this section has no recorded
561
architecture and is treated as the importing runner's.
562
563
### 11.3 Job Requirements
564
565
Hard requirements, all of which a runner MUST satisfy to be offered the
566
job: the sandbox's tier, its rootfs (hence the image's architecture),
567
`memory-limit`, `cpus`, every `runs-on` label of the job and its sandbox,
568
and the runner's scope (OxygenHub spec §13.2). Two additions to the
569
language:
570
571
- `arch "riscv64"` on a sandbox pins the architecture; without it the
572
  architecture is the rootfs image's.
573
- A rootfs per architecture: `rootfs { x86_64 "cas://blob/…"; riscv64 "cas://blob/…" }`.
574
  The job runs on whichever architecture takes it; the receipt and the
575
  provenance record the architecture and image used, and a check's
576
  description names them.
577
578
Soft requirements guide placement but never block it: a job's `timeout`
579
against the runner's speed class. The hub keeps, per job hash and speed
580
class, the median duration of past runs; a runner whose class predicts a
581
duration over the limit is offered the job only when no better runner
582
is free.
583
584
### 11.4 Placement
585
586
The hub filters by the hard requirements, then ranks the runners that
587
remain: idle before busy (`load`), a higher speed class first, a runner
588
already holding the image before one that must fetch it (§5), fewer jobs
589
waiting on it first. A job no runner can satisfy waits and the queue
590
says what it waits for: tier, architecture, image, memory, labels or
591
scope, so the gap is visible rather than a silent stall.
592
593
### 11.5 Declining
594
595
A runner double-checks a claim before it starts: the architecture, that
596
`/dev/kvm` opens for the MicroVM tier, that the image's blob is present
597
and verifies, that the memory is free. If any check fails it answers the
598
hub with `declined` and a reason instead of running and failing; the hub
599
re-queues the job, never offers it to that runner again until its
600
profile changes, records the decline on the runner's page, and after
601
three declines by different runners marks the job `unplaceable` with the
602
reasons. A decline is never a failed check on the state.
603
630ee660 Andy McCall ↶ 604
As built: the runner sends `POST /api/v1/flow/jobs/{id}/decline` with
605
`{"reason": …}` before it fetches anything. The profile is a hash of the
606
tiers, images, architecture, labels and capacity a runner claims with.
607
A decline also lapses after ten minutes, so a passing reason such as
608
memory in use does not bar a runner for good. An unplaceable job ends
609
with status `error` and an error beginning `unplaceable:`. The hub
610
works out why each ready job waits every 15 seconds, and the run page and
611
the API (`waiting`) show it.
612
89171fca Andy McCall ↶ 613
### 11.5.1 Restarts (oxygenflow#49, #50)
614
615
Neither a hub restart nor a runner restart costs a job anything.
616
617
- **The hub away.** A job's uploads (artifacts, report files) and declines
618
  are tried again through refused connections and server errors (5xx,
619
  as a proxy answers while the hub restarts) for three minutes, waiting
620
  1, 2, 4, 8 and then 15 seconds; a refusal (4xx) is final. Log lines
621
  the hub could not take are kept and sent with the next batch, 200 lines
622
  at a time, up to 50,000 (beyond that the oldest go, and the log says how
623
  many). A job's result is kept on disk and offered for two hours, as
624
  before. Claims are not retried through a lost connection, so a job is
625
  never claimed twice; the runner simply asks again.
626
- **The runner restarted.** The first SIGTERM or SIGINT drains the runner:
627
  it claims nothing more and stops once every job it holds has ended and
628
  been reported. A second signal stops it at once. Its systemd unit says
629
  `KillMode=mixed`, so only the runner is signalled and its microVMs run
630
  on, and `TimeoutStopSec` longer than the longest job, after which
631
  systemd kills what is left. A new binary is installed by replacing it
632
  and restarting the unit (`systemctl restart --no-block`): the old runner
633
  finishes its job, and `Restart=always` starts the new one.
634
fd2d4822 Andy McCall ↶ 635
### 11.6 Conformance
636
637
1. Architecture Safety: a job whose image is `x86_64` MUST never be
638
   offered to a `riscv64` runner, with or without the image copied there.
639
2. Tier Safety: a runner without `/dev/kvm` MUST NOT be offered a
640
   MicroVM job, and MUST decline one if handed it.
641
3. Room: a job whose `memory-limit` exceeds the runner's free memory
642
   MUST wait, not be killed.
643
4. Visibility: a job nobody can take MUST say why on the queue within
644
   one scheduling pass.
645
5. Preference: with two idle runners that both satisfy a job, the hub
646
   MUST offer it to the higher speed class, and to the one holding the
647
   image when classes tie.