Watch
0
0
Fork
You've already forked hyperhive
0
hyperhive/hive-host-sock/README.md
iris 6739bb903d docs: sort the top-level directories into five sections by what the reader wants
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.
2026-11-06 18:46:57 +01:00

30 lines
1.3 KiB
Markdown

# hive-host-sock
Wire types for the **host admin socket** (`/run/hyperhive/host.sock`) — the
host-control protocol spoken between the `hivectl` operator CLI and the
`hive-c0re` daemon.
## Why it's its own crate
Re-homed out of `hive-sh4re` so a standalone `hivectl` depends on **just this
protocol crate** instead of the whole daemon-shared crate. `hivectl` drives the
full hive (spawn / kill / destroy / rebuild / deploy) over this socket without
linking `hive-c0re`; keeping the request/response shapes here is what makes that
thin dependency possible.
## Shape
Serde-derived request/response enums for the host admin protocol. The larger
shared payload type some variants reference (`AgentStatusRow`) stays in
`hive-sh4re` — this crate is only the protocol envelope, no server or
client implementation.
Its own `jobs` module is the exception: the job-queue vocabulary `hivectl`
needs (`State`, `NodeId`) is protocol-local. The typed
`DagView`/`NodeView` projection that used to live there is gone — the queue is
served as a generic graph (`hive-jobq-wire`), not as a second hand-written
view.
See `docs/2-handbook/trust-boundary/boundary.md` (host admin socket access) for the trust model around who
may connect to the socket, and `hive-priv-sock` for the sibling split on the
privileged-helper socket.