mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity

docs: sort the top-level directories into five sections by what the reader wants

Browse source 
Every docs directory moves under 1-getting-started, 2-handbook,
4-implementation or 5-project; the options reference (section 3) comes from
the website and has no directory here. trust-boundary stays whole under the
handbook for now. web-ui, swarm and tools split between handbook and
implementation, and the command-line references move to
2-handbook/reference. Links, path references in code and nix, and the docs
index follow the moves; no page content changes.
This commit is contained in:
iris 2026-11-06 18:30:12 +01:00 • committed by mara
commit 6739bb903d
1 changed files with 736 additions and 701 deletions
Download patch file Download diff file Expand all files Collapse all files

12
swarm-builder/README.md
View file

@ -2,7 +2,7 @@
The swarm builder's build service, in the `swarm-builder` container on the
host that sets `deploy.builder.enable`. The design is
[`docs/swarm/builder.md`](../docs/swarm/builder.md).
[`docs/4-implementation/swarm/builder.md`](../docs/4-implementation/swarm/builder.md).
swarm-controller sends one request per config PR head: an agent, a commit and
the PR. This service builds that agent config on the agent base this host was
@ -29,19 +29,19 @@ a commit of the repo. It runs `nix build` of
with every input at the flake's own lock, and answers with the store path and
the platform it builds for. The controller records the answer; the service
writes nothing. It takes the same one-build slot as the PR checks. See
[`docs/swarm/builder.md`](../docs/swarm/builder.md#deploy-gate).
[`docs/4-implementation/swarm/builder.md`](../docs/4-implementation/swarm/builder.md#deploy-gate).
Where `services.hyperhive.swarm.attic.{domain,cache}` are not null (they default
to the swarm's own cache), it first pushes a green build's closure to that cache with `attic push`, and the answer says
whether that worked. A failed push leaves the build green. See
[`docs/swarm/builder.md`](../docs/swarm/builder.md#binary-cache).
[`docs/4-implementation/swarm/builder.md`](../docs/4-implementation/swarm/builder.md#binary-cache).
## Metrics
The service exports build counts, durations, queue depth and wait, and reply
publish failures through its container's forwarder to the swarm collector. The
names and attributes are in
[`docs/scheduler/observability.md`](../docs/scheduler/observability.md#swarm-builder-metrics).
[`docs/4-implementation/scheduler/observability.md`](../docs/4-implementation/scheduler/observability.md#swarm-builder-metrics).
## Credentials
@ -60,11 +60,11 @@ The service also answers archetype evaluations: `nix eval` of the `meta` of
every `hyperhiveArchetypes` entry in this host's hyperhive source, with
nixpkgs pointed at this host's. It fetches nothing and uses no token, and it
doesn't wait for a running build. See
[`docs/swarm/archetypes.md`](../docs/swarm/archetypes.md).
[`docs/2-handbook/swarm/archetypes.md`](../docs/2-handbook/swarm/archetypes.md).
## Meta-flake lock
The service also locks the swarm meta flake on request: `nix flake lock` of
the `flake.nix` it was sent, in a scratch directory, with the build's forge
credential. It answers with the lock and commits nothing. See
[`docs/swarm/builder.md`](../docs/swarm/builder.md#meta-flake-lock).
[`docs/4-implementation/swarm/builder.md`](../docs/4-implementation/swarm/builder.md#meta-flake-lock).