a083cc80 Andy McCall 1 month ago ↶
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 1 month ago ↶
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 1 month ago ↶
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
ea81796b Andy McCall 20 days ago ↶
94
network "isolated" // Options: "isolated" | "loopback" | "egress" { allow "host"... } (§4.3.1)
a083cc80 Andy McCall 1 month ago ↶
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 1 month ago ↶
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 1 month ago ↶
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 1 month ago ↶
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 1 month ago ↶
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
ea81796b Andy McCall 20 days ago ↶
213
#### 4.3.1 Allow-listed egress (oxygenflow#55)
214
215
A sandbox reaches the network only by naming its hosts:
216
217
``` kdl
218
sandbox "deploy" {
219
runtime "microvm"
220
network "egress" { allow "*.googleapis.com" "registry.opentofu.org" }
221
}
222
```
223
224
The VM still has no network device. ` flow-init` serves a proxy on the
225
guest's ` 127.0.0.1:3128` (the job gets ` HTTPS_PROXY` , ` HTTP_PROXY` and
226
their lower-case forms, unless it sets them) and relays each connection,
227
unread, over Firecracker's vsock to the runner. The runner accepts only
228
` CONNECT host:443` for a host the list allows (a name exactly, or any
229
name under a ` *.` domain, never the domain itself; never an address),
230
resolves it itself (the guest does not resolve), refuses any name that
231
resolves to an address that is not public, and relays the bytes without
232
opening the TLS. Every decision, allowed or refused, is a ` flow` line in
233
the job's log. Patterns are lower-case host names of two or more labels,
234
at most 32 per sandbox, and part of the sandbox's hash.
235
236
Egress is off unless a runner turns it on (` egress = true` under
237
` [runner]` in ` flow.toml` ); such a runner offers the ` egress` label, and
238
an egress sandbox needs it, so the hub hands its jobs only to runners
239
that allow it, and a runner without it refuses one anyway. The syscall
240
runtime has no egress yet.
241
a083cc80 Andy McCall 1 month ago ↶
242
## 5. Content-Addressable Storage (CAS) & Zero-Copy Mounting
243
244
OxygenFlow runners bypass traditional clone operations. Repositories are accessed
245
directly via the local object store (.oxy/objects/) or streamed on demand
246
using Oxygen's wire protocol.
247
248
### 5.1 FUSE Overlay Mounting (flow-casfs)
249
1. The runner receives a task targeting an Oxygen State ObjectRef (a sorted
250
list of maximal heads).
251
2. The nearest Checkpoint is resolved. Uncommitted changes between the
252
checkpoint and heads are replayed into a virtual tree in-memory.
253
3. The virtual tree is exposed to the sandbox via flow-casfs:
254
- File reads resolve chunks using the FastCDC gear table (32 KiB to 256 KiB,
255
mean 64 KiB) pinned in Oxygen Spec Section 13.2.
256
- Missing chunks are fetched lazily using the POST /objects protocol.
257
- To prevent FUSE context-switch bottlenecks on many small reads, flow-casfs aggressively mmaps chunk data and utilizes host page caching.
258
- All guest mutations are diverted to a scratch tmpfs layer; base objects
259
remain immutable.
260
261
### 5.2 Artifact Capture
262
1. At task completion, flow-casfs scans the paths declared in the output block.
263
2. Modified outputs are chunked with FastCDC, hashed via BLAKE3-256, and
264
written as canonical Blob and Chunk objects.
265
3. Output ObjectRefs are stored directly in the Oxygen repository.
9a6fac2b Andy McCall 1 month ago ↶
266
4. Outputs are read when the job passes. An artifact with ` when "always"`
267
(default ` when "passed"` ) is also read when the job fails or is stopped
268
at its time limit, so a test report survives the failure it describes.
269
From a job that did not pass it is kept and shown, but its receipt never
270
names it, and one that cannot be read is only noted in the log.
a083cc80 Andy McCall 1 month ago ↶
271
9a6fac2b Andy McCall 1 month ago ↶
272
``` kdl
273
output {
274
artifact "junit" {
275
path "/src/target/junit.xml"
276
when "always"
277
}
278
}
279
```
280
6d53fb7d Andy McCall 25 days ago ↶
281
5. A ` report` output (OxygenHub ` docs/reports.md` ) names a directory
282
holding ` report.toml` at its top. The runner reads its regular files
283
(links and anything else are left out, never followed; file names hold
284
letters, digits, ` .` , ` _` , ` -` and ` +` ; at most 2000 files and 512 MiB),
285
uploads each to ` POST /api/v1/flow/jobs/{job}/reports/{name}/files` with
286
its path in ` X-Flow-Report-Path` , then uploads a manifest,
287
` {"version":1,"files":[{"path","blob","size"}]}` , as the output under
288
the report's name, checking every blob the hub answers. The receipt
289
names the manifest. Reports and artifacts share names; a report's kind
290
is part of the job's hash (` [name, path, "report"]` ).
291
292
``` kdl
293
output {
294
report "frame-timing" {
295
path "/src/out/report"
296
when "always"
297
}
298
}
299
```
300
46fe2c81 Andy McCall 20 days ago ↶
301
### 5.3.1 Artifacts between jobs (oxygenflow#58)
302
303
A job takes an artifact of a job it depends on:
304
305
``` kdl
306
job "apply" {
307
depends-on "plan"
308
input {
309
artifact "tfplan" from "plan"
310
path "/src/tfplan"
311
}
312
}
313
```
314
315
The producer must be named in ` depends-on` and declare that name as an
316
artifact (not a report); paths are clean absolute paths under ` /src` , at
317
most 8 inputs, and they are part of the job's hash (` [artifact, from,
318
path]` , field 10). Since the producer has passed when the job is handed
319
out, the hub puts each input in the claim with the blob the producer's
320
receipt names (a passing job's receipt names exactly the artifacts it
321
uploaded). Before the job starts, the runner fetches each from
322
` GET /api/v1/flow/jobs/{job}/inputs/{index}` , checks its Oxygen blob
323
reference against that blob, refuses the job if they differ, and writes it
324
at its path in the workspace (not part of the scope hash: it belongs to the
325
run, not the repository). The job's receipt lists the blobs as its
326
` inputs` , so an apply job's receipt proves which plan it applied.
327
e2089721 Andy McCall 20 days ago ↶
328
### 5.3.2 Approval gates (oxygenflow#57)
329
330
A job can wait for a person:
331
332
``` kdl
333
job "apply" {
334
depends-on "plan"
335
approval {
336
by "maintain" // the least role: "write", "maintain" (default) or "admin"
337
others-only #true // not the person whose push started the run
338
expires "24h" // from when the jobs it depends on are done; up to 720h
339
}
340
}
341
```
342
343
The hub hands such a job to no runner until someone with that role on the
344
repository approves it, on the run page or through the API; others-only
345
leaves out whoever pushed. Approving or rejecting is recorded on the job
346
(who, when) and in the audit log. A rejected or expired job ends as
347
cancelled and the jobs after it are skipped; a newer push to the
348
bookmark cancels the run as before, so a stale plan is never applied. The
349
approval is part of the job's hash (field 11).
350
d60aac6c Andy McCall 23 days ago ↶
351
### 5.4 The Build Cache (oxygenflow#28)
352
353
An ` ephemeral://disk` mount may name a ` cache` , and the files that key it:
354
355
``` kdl
356
mount {
357
source "ephemeral://disk"
358
target "/src/target"
359
size "24GiB"
360
cache "target"
361
key "Cargo.lock" "rust-toolchain.toml"
362
}
363
```
364
365
Such a disk is not always empty at the start. Each runner keeps a pool of
366
the disks of passing jobs, by repository, job, cache name and bookmark,
367
named by the ** key** : the BLAKE3 of the sandbox image, the job's name, the
368
cache name, and each key file's content in the job's state. A job's disk
369
starts as, in order: its bookmark's disk with the same key (moved), its
370
bookmark's newest disk (moved), another bookmark's with the same key and
371
then another's newest (copied, so a proposal never takes the default
372
bookmark's), and otherwise an empty disk. A disk must be the size the
373
mount asks for.
374
375
- ** Only passing jobs keep a disk.** When the job and its outputs pass,
376
its cached disks go back into the pool under their key; otherwise they
377
are discarded with the scratch directory, so nothing a failing job wrote
378
reaches a later one.
379
- ** The receipt says so.** The job's environment gains ` cache TARGET` with
380
the key and what the disk started from, so the receipt's environment
381
hash differs from a cold build's.
382
- ** Bounded.** The pool keeps under ` cache_gb` in the runner's config
383
(default 64 GiB) by dropping the disks used longest ago.
384
- The syscall tier keeps its disks empty for now.
385
- A cache is a speed-up, never a source of truth: jobs must build
386
correctly from an empty disk, which a key change or an eviction gives
387
them at any time.
388
a083cc80 Andy McCall 1 month ago ↶
389
## 6. Commutative Execution & Change Caching
390
391
In Oxygen, changes that do not share scopes (referenced atoms, placements, or
392
nodes) commute. OxygenFlow exploits this invariant to provide granular caching.
393
394
### 6.1 Execution Receipt Object
395
Every successful or failed job run emits an immutable Receipt:
396
397
``` cbor
398
Receipt {
399
version [0]: 1
400
job_name [1]: text
401
pipeline_hash [2]: ObjectRef
402
scope_tree_hash [3]: ObjectRef // BLAKE3 tree hash of the materialized scope
403
inputs [4]: [ObjectRef] // Artifacts and input files consumed
404
environment [5]: ObjectRef // Hash of rootfs, compiler flags, and argv
405
outputs [6]: [ObjectRef] // Produced artifact blobs
406
exit_code [7]: u32
407
duration_ms [8]: u64
408
}
409
```
410
411
A Receipt is hashed as an Oxygen object with type name "receipt":
412
ObjectRef = BLAKE3-256("oxy1 receipt " || decimal(len) || 0x00 || body)
413
414
### 6.2 Cache Re-use Invariant
415
Let Scope(J) be the file paths and tree nodes declared by job J.
416
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).
417
418
If an existing Receipt R exists such that:
419
R.job_name == J.name & &
420
R.pipeline_hash == Hash(J) & &
421
R.scope_tree_hash == TreeHash(Scope(J)) & &
422
R.environment == CurrentEnvironmentHash
423
424
Then the job execution is bypassed. R.outputs are mapped into downstream
425
dependents immediately as a cached-commuted hit.
426
427
## 7. Native Provenance Specification
428
429
OxygenFlow formalizes build provenance as a native, tamper-evident Oxygen Attest
430
object (kind: "attest"). Provenance is generated exclusively by the runner
431
hypervisor, not the guest payload.
432
433
### 7.1 Provenance Object Schema
434
435
``` json
436
Attest {
437
version [0]: 1
438
kind [1]: "attest"
439
repo [2]: bytes(16) // Oxygen Repository ID
440
hlc [3]: HLC // Hybrid Logical Clock
441
body [4]: {
442
"type": "flow/provenance/v1",
443
444
// Subject artifacts produced by the build
445
"subjects": [
446
{
447
"name": text,
448
"ref": ObjectRef, // BLAKE3 hash of output blob
449
"media_type": text
450
}
451
],
452
453
// Builder platform and execution identity
454
"builder": {
455
"runner_id": KeyId, // ObjectRef of runner's Oxygen Identity
456
"isolation_level": text, // "wasm" | "gvisor" | "microvm"
457
"hypervisor_image": ObjectRef // Rootfs blob digest
458
},
459
460
// Exact input materials
461
"materials": {
462
"state_heads": [ChangeHash], // Oxygen heads of the state built
463
"scope_tree_hash": ObjectRef, // Captures exact state without O(N) array bloat
464
"inputs": [
465
{
466
"name": text,
467
"ref": ObjectRef // Content hash of locked dependencies
468
}
469
]
470
},
471
472
// Structured execution arguments
473
"invocation": {
474
"job": text,
475
"pipeline_spec": ObjectRef, // ObjectRef of .flow/pipeline.kdl
476
"argv": [text], // Unmodified execution vector
477
"env": map<text, text> // Explicitly whitelisted environment
478
},
479
480
// Environment observations
481
"metadata": {
482
"started_on": u64, // Wallclock milliseconds
483
"finished_on": u64,
484
"hermetic": bool, // Verified zero outbound network access
485
"reproducible": bool
486
}
487
}
488
}
489
```
490
491
### 7.2 Composite Signatures
492
All provenance attestations are signed using Oxygen's composite signature
493
construction (Ed25519 and ML-DSA-65):
494
495
``` cbor
496
Signature {
497
key [0]: KeyId
498
alg [1]: 1 // 1 = Ed25519 + ML-DSA-65
499
ed [2]: bytes(64) // Classical signature
500
ml [3]: bytes(3309) // Post-quantum signature
501
}
502
```
503
504
Both signatures are computed over:
505
"oxy1 sig attest\0" || KeyId || ObjectRef
506
507
## 8. Policy Integration & Bookmark Gates
508
509
Oxygen repositories enforce branch and bookmark protections via signed Policy
510
objects (Oxygen Spec Section 14.5). OxygenFlow integrates provenance directly into
511
policy evaluation during push validation.
512
513
### 8.1 Policy Gate Definition
514
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.
515
516
``` json
517
PolicyRule {
518
pattern: "bookmarks/production"
519
keys: [ KeyId ]
520
threshold: 1
521
require: "signed"
522
allow_conflicts: false
523
require_attestations: [
524
{
525
type: "flow/provenance/v1",
526
job: "release-provenance",
527
require_hermetic: true,
528
signer_roles: [ "official-worker" ]
529
}
530
]
531
}
532
533
### 8.2 Push Verification Sequence (VCS Engine Enforcement)
534
When a push request arrives at an Oxygen server attempting to update a
535
protected bookmark:
536
1. Object Integrity: Validate that all changes, chunks, and blobs exist and match
537
their BLAKE3 hashes.
538
2. Attestation Resolution: Verify that an Attest object of type
539
"flow/provenance/v1" is present, referencing the exact heads of the new
540
State.
541
3. Identity Verification: Validate that the attestation's composite signature
542
resolves to a KeyId listed as an authorized delegate of the repository
543
policy roots.
544
4. Invariant Checking: Confirm that the provenance statement records
545
"hermetic: true" and exit code 0.
546
5. Atomic Update: If validation fails at any point, the entire push is refused
547
with ok = false.
548
549
## 9. Zero-Environment Secret Brokering
550
551
OxygenFlow forbids the injection of raw secret strings into process environment
552
tables to eliminate accidental leaking via child process dumping, procfs
553
reads, and verbose compiler logging.
554
555
### 9.1 Ephemeral Secret Broker
556
1. If a job requires a credential (e.g., signing key, cloud deployment token),
557
it declares a secret mount:
558
secret "deploy-token" {
559
vault-ref "infra/tokens/prod"
560
mount-path "/run/secrets/token"
561
}
562
2. The runner negotiates a short-lived token lease from the configured vault.
563
3. The secret is mounted onto an ephemeral, in-memory ramfs location inside
564
the sandbox with access mode 0400, owned exclusively by the worker process.
565
4. Upon process termination, the memory pages are zeroized and the token is
566
marked for immediate revocation at the vault.
567
568
## 10. Conformance and Verification Requirements
569
570
A conforming OxygenFlow implementation MUST pass the following tests:
571
572
1. Injection Immunity: Attempting to supply unescaped shell metacharacters
573
(; && | ` $() \n) in any job field MUST pass those characters as literal
574
bytes to argv; subshells MUST NOT be spawned.
575
2. FastCDC Determinism: Chunks produced by artifact extraction MUST match
576
the gear table cuts and BLAKE3 hashes generated by Oxygen's core chunker.
577
3. Commutation Hit Invariance: For any two commuting changes A and B, running
578
a pipeline on State(A, B) MUST reuse cached receipts generated on State(A)
579
for any job whose scope does not intersect the touched paths of B.
580
4. Non-Downgrade Attestation: An attestation missing the ML-DSA-65 component
581
MUST be rejected by policy verification.
582
5. Hermetic Network Isolation: Jobs configured with network "isolated" MUST
fd2d4822 Andy McCall 1 month ago ↶
583
have outgoing TCP SYN and UDP packets dropped at the hypervisor boundary.
630ee660 Andy McCall 1 month ago ↶
584
## 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 1 month ago ↶
585
586
A runner MUST never take a job it cannot run or cannot finish well: the
587
wrong architecture, no hardware virtualisation for the MicroVM tier, too
588
little memory, an image it does not hold, or a machine too slow for the
589
job's time limit. Today a runner reports its architecture, OS, labels,
590
job slots, memory and vCPUs when it registers and on each claim, and a
591
claim carries the tiers it can run, the memory and vCPUs free now, and
592
the images it holds; the hub matches tier, room, labels, scope and image.
593
What is missing: architecture is reported but never matched (an image's
594
architecture is implicit in its bytes), a pipeline cannot say which
595
architecture it needs or offer a rootfs per architecture, speed and load
596
play no part, and a runner cannot decline a job it was handed.
597
598
### 11.1 Capability Profile
599
600
At registration and on every claim a runner sends its profile:
601
602
| Field | Meaning |
603
|---|---|
604
| `arch`, `os`, `kernel` | `x86_64`, `aarch64`, `riscv64`, …; the kernel release |
605
| `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`) |
606
| `memory_mib`, `cpus`, `max_jobs` | What its jobs share |
607
| `images` | The rootfs images it holds, each with the architecture its manifest records (§11.2) |
608
| `labels` | As §3.1 |
62829d15 Andy McCall 24 days ago ↶
609
| `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) |
610
| `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 1 month ago ↶
611
612
### 11.2 Image Manifests Carry the Architecture
613
614
`flow rootfs import` reads the ELF header of the image's `/bin/sh` and
615
records its architecture in the CAS manifest beside the hash. A runner
616
refuses to import an image for another architecture (there is no
617
emulation tier). An image imported before this section has no recorded
618
architecture and is treated as the importing runner's.
619
620
### 11.3 Job Requirements
621
622
Hard requirements, all of which a runner MUST satisfy to be offered the
623
job: the sandbox's tier, its rootfs (hence the image's architecture),
624
`memory-limit`, `cpus`, every `runs-on` label of the job and its sandbox,
625
and the runner's scope (OxygenHub spec §13.2). Two additions to the
626
language:
627
628
- `arch "riscv64"` on a sandbox pins the architecture; without it the
629
architecture is the rootfs image's.
630
- A rootfs per architecture: `rootfs { x86_64 "cas://blob/…"; riscv64 "cas://blob/…" }`.
631
The job runs on whichever architecture takes it; the receipt and the
632
provenance record the architecture and image used, and a check's
633
description names them.
634
635
Soft requirements guide placement but never block it: a job's `timeout`
636
against the runner's speed class. The hub keeps, per job hash and speed
637
class, the median duration of past runs; a runner whose class predicts a
638
duration over the limit is offered the job only when no better runner
639
is free.
640
641
### 11.4 Placement
642
643
The hub filters by the hard requirements, then ranks the runners that
644
remain: idle before busy (`load`), a higher speed class first, a runner
645
already holding the image before one that must fetch it (§5), fewer jobs
646
waiting on it first. A job no runner can satisfy waits and the queue
647
says what it waits for: tier, architecture, image, memory, labels or
648
scope, so the gap is visible rather than a silent stall.
649
650
### 11.5 Declining
651
652
A runner double-checks a claim before it starts: the architecture, that
653
`/dev/kvm` opens for the MicroVM tier, that the image's blob is present
654
and verifies, that the memory is free. If any check fails it answers the
655
hub with `declined` and a reason instead of running and failing; the hub
656
re-queues the job, never offers it to that runner again until its
657
profile changes, records the decline on the runner's page, and after
658
three declines by different runners marks the job `unplaceable` with the
659
reasons. A decline is never a failed check on the state.
660
630ee660 Andy McCall 1 month ago ↶
661
As built: the runner sends `POST /api/v1/flow/jobs/{id}/decline` with
662
`{"reason": …}` before it fetches anything. The profile is a hash of the
663
tiers, images, architecture, labels and capacity a runner claims with.
664
A decline also lapses after ten minutes, so a passing reason such as
665
memory in use does not bar a runner for good. An unplaceable job ends
666
with status `error` and an error beginning `unplaceable:`. The hub
667
works out why each ready job waits every 15 seconds, and the run page and
668
the API (`waiting`) show it.
669
89171fca Andy McCall 23 days ago ↶
670
### 11.5.1 Restarts (oxygenflow#49, #50)
671
672
Neither a hub restart nor a runner restart costs a job anything.
673
674
- **The hub away.** A job's uploads (artifacts, report files) and declines
675
are tried again through refused connections and server errors (5xx,
676
as a proxy answers while the hub restarts) for three minutes, waiting
677
1, 2, 4, 8 and then 15 seconds; a refusal (4xx) is final. Log lines
678
the hub could not take are kept and sent with the next batch, 200 lines
679
at a time, up to 50,000 (beyond that the oldest go, and the log says how
680
many). A job's result is kept on disk and offered for two hours, as
681
before. Claims are not retried through a lost connection, so a job is
682
never claimed twice; the runner simply asks again.
683
- **The runner restarted.** The first SIGTERM or SIGINT drains the runner:
684
it claims nothing more and stops once every job it holds has ended and
685
been reported. A second signal stops it at once. Its systemd unit says
686
`KillMode=mixed`, so only the runner is signalled and its microVMs run
687
on, and `TimeoutStopSec` longer than the longest job, after which
688
systemd kills what is left. A new binary is installed by replacing it
689
and restarting the unit (`systemctl restart --no-block`): the old runner
690
finishes its job, and `Restart=always` starts the new one.
691
fd2d4822 Andy McCall 1 month ago ↶
692
### 11.6 Conformance
693
694
1. Architecture Safety: a job whose image is `x86_64` MUST never be
695
offered to a `riscv64` runner, with or without the image copied there.
696
2. Tier Safety: a runner without `/dev/kvm` MUST NOT be offered a
697
MicroVM job, and MUST decline one if handed it.
698
3. Room: a job whose `memory-limit` exceeds the runner's free memory
699
MUST wait, not be killed.
700
4. Visibility: a job nobody can take MUST say why on the queue within
701
one scheduling pass.
702
5. Preference: with two idle runners that both satisfy a job, the hub
703
MUST offer it to the higher speed class, and to the one holding the
704
image when classes tie.