vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs(gateway): remove stale TCP loopback fallback section

Browse source 
The TCP fallback was removed from gateway_nginx.rs in the previous
commit. Update docs/gateway.md to match:
- Step 4: remove 'TCP loopback for agents not yet rebuilt' — always UDS now
- Remove the 'TCP loopback fallback' subsection entirely
This commit is contained in:
atlas 2026-07-04 22:16:06 +02:00 • committed by mara
commit 32e4c687b8
1 changed files with 4 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/gateway.md
View file

@ -103,10 +103,10 @@ now set unconditionally for every agent. The mechanism:
(Legacy name `.bound` also accepted during the transition window.) (Legacy name `.bound` also accepted during the transition window.)
4. **Gateway side**. `gateway_nginx::write` generates 4. **Gateway side**. `gateway_nginx::write` generates
`/var/lib/hyperhive/gateway/agents.conf` — a plain nginx include `/var/lib/hyperhive/gateway/agents.conf` — a plain nginx include
file with one `location /agent/<name>/` block per agent. UDS file with one `location /agent/<name>/` block per agent. Always
upstream (`http://unix:/run/hive-agent/<name>/web.sock:/`) when a UDS upstream (`http://unix:/run/hive-agent/<name>/web.sock:/`);
`hyperhive-socket-bound` marker present; TCP loopback for agents if the socket is not yet bound, nginx returns 502 caught by the
that haven't yet been rebuilt under the new config. `error_page 502 503 504 = /__hive_agent_unreachable` directive.
The gateway container bind-mounts `/var/lib/hyperhive/gateway/` at The gateway container bind-mounts `/var/lib/hyperhive/gateway/` at
`/run/hive-state/`; nginx includes `/run/hive-state/agents.conf`. `/run/hive-state/`; nginx includes `/run/hive-state/agents.conf`.
After each write, c0re triggers the appropriate nginx action inside After each write, c0re triggers the appropriate nginx action inside
@ -127,17 +127,6 @@ idempotent — skips the rename when content is unchanged. Failed reloads
are retried automatically on subsequent poll ticks via are retried automatically on subsequent poll ticks via
`gateway_nginx::reload_if_pending`. `gateway_nginx::reload_if_pending`.
## TCP loopback fallback
While an agent's unix-socket marker is absent, the gateway routes its
`/agent/<name>/` traffic to a TCP loopback upstream in `agents.conf`. The
port is derived on the fly from `lifecycle::agent_web_port(name)` — a pure
FNV-1a hash of the name, reproducible from the name alone, no name
special-cased (so no on-disk port map is needed). Once the agent binds its
unix socket — every agent does, via `HIVE_WEB_SOCKET` — the gateway
switches to the socket upstream from `agent-sockets.json`. The root agent's
UI is routed at `/agent/root/`.
`agents.conf` uses atomic `<path>.tmp` + `rename()` writes so a crashing `agents.conf` uses atomic `<path>.tmp` + `rename()` writes so a crashing
c0re process never leaves a partial or unparseable file behind. c0re process never leaves a partial or unparseable file behind.