Directories
¶
| Path | Synopsis |
|---|---|
|
Package budget decides whether another stack fits into the memory the machine has for siding.
|
Package budget decides whether another stack fits into the memory the machine has for siding. |
|
Package buildslot limits how many siding processes build images at the same time: N lock files under ~/.siding/builds, held with flock.
|
Package buildslot limits how many siding processes build images at the same time: N lock files under ~/.siding/builds, held with flock. |
|
Package cli holds siding's commands: flags, arguments and output.
|
Package cli holds siding's commands: flags, arguments and output. |
|
Package compose runs docker compose and reads the normalised configuration it prints.
|
Package compose runs docker compose and reads the normalised configuration it prints. |
|
Package docker reads the state of stacks from the Docker Engine API.
|
Package docker reads the state of stacks from the Docker Engine API. |
|
Package fail holds the error type every siding command fails with: a stable code that agents may branch on, a message, and an optional hint on what to do next.
|
Package fail holds the error type every siding command fails with: a stable code that agents may branch on, a message, and an optional hint on what to do next. |
|
Package gc decides which stacks can go: a pure function from what Docker and git know about each stack to the actions siding gc takes.
|
Package gc decides which stacks can go: a pure function from what Docker and git know about each stack to the actions siding gc takes. |
|
Package git answers what siding needs to know about a worktree by running the git CLI: where it is, which branch it is on, and whether removing its stack's data could lose work.
|
Package git answers what siding needs to know about a worktree by running the git CLI: where it is, which branch it is on, and whether removing its stack's data could lose work. |
|
Package idle tells when a stack was last requested through the proxy, from the proxy's access log: one JSON line per request with only the router and the time (phase 4 design D3, D4).
|
Package idle tells when a stack was last requested through the proxy, from the proxy's access log: one JSON line per request with only the router and the time (phase 4 design D3, D4). |
|
Package lint finds what in a compose file breaks parallel stacks or weakens siding's verdict.
|
Package lint finds what in a compose file breaks parallel stacks or weakens siding's verdict. |
|
Package overview holds what siding ui needs besides the page: the route file through which siding-proxy reaches it, and the addresses it listens on.
|
Package overview holds what siding ui needs besides the page: the route file through which siding-proxy reaches it, and the addresses it listens on. |
|
Package probe asks the proxy whether a routed service answers, without DNS: the request goes to 127.0.0.1 on the proxy's port with the stack's host in the Host header.
|
Package probe asks the proxy whether a routed service answers, without DNS: the request goes to 127.0.0.1 on the proxy's port with the stack's host in the Host header. |
|
Package proxy describes siding-proxy: one Traefik with the Docker provider, run as its own Compose project, through which every stack is reached by host and path.
|
Package proxy describes siding-proxy: one Traefik with the Docker provider, run as its own Compose project, through which every stack is reached by host and path. |
|
Package queue is the line of up --wait processes waiting for memory.
|
Package queue is the line of up --wait processes waiting for memory. |
|
Package seed decides how a stack's first up fills it with data: which volumes come from a snapshot, and which services run a seed command.
|
Package seed decides how a stack's first up fills it with data: which volumes come from a snapshot, and which services run a seed command. |
|
Package snapshot names, labels and groups snapshots: copies of a stack's named volumes, kept as Docker volumes.
|
Package snapshot names, labels and groups snapshots: copies of a stack's named volumes, kept as Docker volumes. |
|
Package stack derives everything about a stack that follows from its worktree and its compose file without asking Docker: names, labels, routes and the override siding writes.
|
Package stack derives everything about a stack that follows from its worktree and its compose file without asking Docker: names, labels, routes and the override siding writes. |
|
Package testutil holds helpers shared by tests.
|
Package testutil holds helpers shared by tests. |
|
Package verdict decides whether a stack runs: Ready only when every service is up, healthy where it has a healthcheck, and answering through the proxy where it has a route path.
|
Package verdict decides whether a stack runs: Ready only when every service is up, healthy where it has a healthcheck, and answering through the proxy where it has a route path. |
Click to show internal directories.
Click to hide internal directories.