730c923a97
The deletion PR removed the types but left ~10 sites still describing
them. Two are real breakage rather than staleness: rustdoc intra-doc
links to deleted items ([NodeView::kind] and [Self::snapshot] in
job_queue/mod.rs). Neither clippy --all-targets -D warnings nor cargo
test resolves intra-doc links, so the tree was green with both already
dangling.
The rest reassert facts the deletion made false: docs/coordinator.md
documented the event as RebuildQueueChanged { seq, queue: [DagView...] }
with a per-node field list, and three sites pointed at the removed
/api/state.rebuild_queue endpoint.
One is pointer rot rather than a rename, and no grep for a deleted name
finds it: SchedulesChanged justified itself as "same snapshot-shape
rationale as RebuildQueueChanged" -- which the deletion turned into the
one event that is not a snapshot. Repointed at TombstonesChanged /
MetaInputsChanged, in both the Rust doc and the dashboard doc.
Two are pre-existing and strictly out of scope, swept under the
pfadfinderregel because the same grep surfaced them: hive-sh4re/README
advertised a jobs module that crate has not had since the host-sock
split, and hive-host-sock/README claimed its own payload types live in
hive-sh4re.
Docs and comments only -- no behaviour, no API, no test changes.
30 lines
1.3 KiB
Markdown
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 types some variants reference (`Approval`, `AgentStatusRow`)
|
|
stay 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 (`Source`, `State`, `PermPayload`, `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/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.
|