Documentation
¶
Overview ¶
Package internal is the root of Burrow's module-private shared helpers, licensed Apache-2.0. It holds only small, cross-cutting utilities shared across the module that carry no license restriction.
The licensed product code does NOT live here: the control plane lives under controlplane/ and the operator under operator/, kept out of this top-level internal/ precisely so the separate private managed module can import them. See LICENSING.md, ADR-0001, and CLAUDE.md for the package layout, and docs/PLAN.md for what the v0.1 slice adds.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agentconn resolves the credential-free, agent-layer control-plane client the scoped agent binary uses (ADR-0005, ADR-0038).
|
Package agentconn resolves the credential-free, agent-layer control-plane client the scoped agent binary uses (ADR-0005, ADR-0038). |
|
Package agentsurface is the single source of truth for which Burrow capabilities the `burrow-agent` binary carries and which ones it deliberately does not.
|
Package agentsurface is the single source of truth for which Burrow capabilities the `burrow-agent` binary carries and which ones it deliberately does not. |
|
Package cloudcred is where the two Burrow Cloud credentials live on disk, and the only place that decides which file is which.
|
Package cloudcred is where the two Burrow Cloud credentials live on disk, and the only place that decides which file is which. |
|
Package jointoken is the codec for the compact join token that carries admin access to a freshly bootstrapped single-VPS k3s cluster from `burrow bootstrap` (run once on the VPS) to `burrow join` (run on the laptop) — ADR-0044.
|
Package jointoken is the codec for the compact join token that carries admin access to a freshly bootstrapped single-VPS k3s cluster from `burrow bootstrap` (run once on the VPS) to `burrow join` (run on the laptop) — ADR-0044. |
|
Package targetname names the target a command acted on, so a command that changes something can say where it changed it ([ADR-0078](../../docs/adr/0078-the-cli-points-at-a-target.md) §4).
|
Package targetname names the target a command acted on, so a command that changes something can say where it changed it ([ADR-0078](../../docs/adr/0078-the-cli-points-at-a-target.md) §4). |
Click to show internal directories.
Click to hide internal directories.