Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
burrow
command
Command burrow is the Burrow CLI: the human-facing way to operate Burrow.
|
Command burrow is the Burrow CLI: the human-facing way to operate Burrow. |
|
burrow-agent
command
Command burrow-agent is the coding agent's control channel to Burrow: a capability-reduced, JSON-first command-line surface the agent invokes directly (ADR-0049).
|
Command burrow-agent is the coding agent's control channel to Burrow: a capability-reduced, JSON-first command-line surface the agent invokes directly (ADR-0049). |
|
burrowd
command
Command burrowd is the Burrow control plane: the component that holds the cluster credentials, runs the deploy/rollout/rollback/logs/scale orchestration, enforces the guardrails, and records who deployed what (ADR-0002).
|
Command burrowd is the Burrow control plane: the component that holds the cluster credentials, runs the deploy/rollout/rollback/logs/scale orchestration, enforces the guardrails, and records who deployed what (ADR-0002). |
|
Package connect reaches the in-cluster Burrow control plane from a developer's machine using their ambient kubeconfig and the Kubernetes API server's service proxy — no port-forward, no ingress (ADR-0014).
|
Package connect reaches the in-cluster Burrow control plane from a developer's machine using their ambient kubeconfig and the Kubernetes API server's service proxy — no port-forward, no ingress (ADR-0014). |
|
Package controlplane is the Burrow control plane: the product.
|
Package controlplane is the Burrow control plane: the product. |
|
api
Package api is the control plane's HTTP front end: it exposes the deploy engine's operations over JSON and authenticates its callers with a bearer token (ADR-0005).
|
Package api is the control plane's HTTP front end: it exposes the deploy engine's operations over JSON and authenticates its callers with a bearer token (ADR-0005). |
|
dns
Package dns is the production controlplane.DNSFactory and the per-vendor DNS adapters (ADR-0018, ADR-0023).
|
Package dns is the production controlplane.DNSFactory and the per-vendor DNS adapters (ADR-0018, ADR-0023). |
|
e2e
Package e2e holds end-to-end tests that drive the deploy engine through its real adapters — the client-go Kubernetes adapter against a live cluster and the registry resolver against a real registry — proving the whole vertical slice composes (ADR-0010).
|
Package e2e holds end-to-end tests that drive the deploy engine through its real adapters — the client-go Kubernetes adapter against a live cluster and the registry resolver against a real registry — proving the whole vertical slice composes (ADR-0010). |
|
internal
Package internal holds the control plane's implementation guts: the deploy state machine, the Kubernetes/registry/database seam adapters, and the guardrail policy.
|
Package internal holds the control plane's implementation guts: the deploy state machine, the Kubernetes/registry/database seam adapters, and the guardrail policy. |
|
internal/fake
Package fake provides in-memory implementations of the control-plane seams (controlplane.Clock, Kubernetes, Registry, Database) for tests.
|
Package fake provides in-memory implementations of the control-plane seams (controlplane.Clock, Kubernetes, Registry, Database) for tests. |
|
kube
Package kube is the production controlplane.Kubernetes adapter, built on the official client-go SDK (ADR-0011).
|
Package kube is the production controlplane.Kubernetes adapter, built on the official client-go SDK (ADR-0011). |
|
logs
Package logs holds the production controlplane.LogsQuerier adapters — the seam burrowd uses to query an installed or connected logs backing service (ADR-0026).
|
Package logs holds the production controlplane.LogsQuerier adapters — the seam burrowd uses to query an installed or connected logs backing service (ADR-0026). |
|
metrics
Package metrics holds the adapters that query a metrics backing service (an installed or connected add-on) for the agent's metrics-query path (ADR-0026).
|
Package metrics holds the adapters that query a metrics backing service (an installed or connected add-on) for the agent's metrics-query path (ADR-0026). |
|
objectstore
Package objectstore is the production controlplane.ObjectStoreFactory: a small S3-compatible client for the ONE thing Burrow does with object storage, which is own the seam between a bucket and the backups written to it (ADR-0063).
|
Package objectstore is the production controlplane.ObjectStoreFactory: a small S3-compatible client for the ONE thing Burrow does with object storage, which is own the seam between a bucket and the backups written to it (ADR-0063). |
|
postgres
Package postgres is the production controlplane.Database adapter, backed by Postgres running in the cluster (ADR-0012).
|
Package postgres is the production controlplane.Database adapter, backed by Postgres running in the cluster (ADR-0012). |
|
registry
Package registry holds the adapter that lists a container image repository's tags over the Docker Registry HTTP API v2, so burrowd can see which versions exist and compute what auto-deploy would take (ADR-0052).
|
Package registry holds the adapter that lists a container image repository's tags over the Docker Registry HTTP API v2, so burrowd can see which versions exist and compute what auto-deploy would take (ADR-0052). |
|
sys
Package sys holds the production implementations of the control plane's system seams — the wall Clock, a crypto/rand ID source, the DNS Resolver, and the publish pre-flight's authoritative resolver and HTTP probe — the concrete values cmd/burrowd injects in place of the test fakes (ADR-0010).
|
Package sys holds the production implementations of the control plane's system seams — the wall Clock, a crypto/rand ID source, the DNS Resolver, and the publish pre-flight's authoritative resolver and HTTP probe — the concrete values cmd/burrowd injects in place of the test fakes (ADR-0010). |
|
Package internal is the root of Burrow's module-private shared helpers, licensed Apache-2.0.
|
Package internal is the root of Burrow's module-private shared helpers, licensed Apache-2.0. |
|
agentconn
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). |
|
agentsurface
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. |
|
ambienttest
Package ambienttest isolates a test binary from the machine it is running on.
|
Package ambienttest isolates a test binary from the machine it is running on. |
|
cloudcred
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. |
|
clustercred
Package clustercred is where the credential a self-hosted Burrow issued lives on disk (ADR-0084 §1).
|
Package clustercred is where the credential a self-hosted Burrow issued lives on disk (ADR-0084 §1). |
|
credfile
Package credfile writes a credential to disk safely, and is the one place that decides what "safely" means for every credential Burrow stores locally.
|
Package credfile writes a credential to disk safely, and is the one place that decides what "safely" means for every credential Burrow stores locally. |
|
jointoken
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. |
|
targetname
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). |
|
Package localconfig models Burrow's client-side selector state: the human-edited ~/.burrow/config file that names environment handles and records which one a command targets (ADR-0036).
|
Package localconfig models Burrow's client-side selector state: the human-edited ~/.burrow/config file that names environment handles and records which one a command targets (ADR-0036). |
|
Package operator is the Burrow Kubernetes operator: the CRD types and the reconcile loops that drive the cluster toward the control plane's desired state.
|
Package operator is the Burrow Kubernetes operator: the CRD types and the reconcile loops that drive the cluster toward the control plane's desired state. |
|
internal
Package internal holds the operator's implementation guts: the reconcile loops and their helpers.
|
Package internal holds the operator's implementation guts: the reconcile loops and their helpers. |
Click to show internal directories.
Click to hide internal directories.