Watch
0
0
Fork
You've already forked hyperhive
0
hyperhive/hive-host-sock/README.md
iris 0e84fe8bc4 docs: the handbook follows the three layers: swarm, hives, agents
The handbook's sections were agent-lifecycle, integrations, swarm, tools,
trust-boundary and web-ui, which do not follow how the system is built, so a
reader could not tell which layer a page is about. Its pages now sit in
swarm/, hives/ and agents/, with the accounts an agent can hold outside the
system in external-accounts/.

- swarm/: forge, matrix and the knowledge repo join the swarm pages, and so
  does the swarmctl reference.
- hives/: the dashboard, hivectl and its reference, and the operator/agent
  boundary, with a README that takes over the old web-ui and tools pages.
- agents/: the roster, persistence, config changes, the agent's own web page
  (was web-ui/agent) and the security model, with a README.
- external-accounts/: GitHub and GitLab.

Pages are moved whole; none is split yet. Every reference follows: relative
links in the docs, `docs/2-handbook/...` paths in code comments, the nix
checks that regenerate the CLI references and the ignore list, and docs/README.md,
whose handbook section is now by layer.
2026-11-07 12:19:36 +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/hives/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.