infraweaver/docs
Documentation
The documentation lives in the repository, next to the code it describes, so it moves when the code moves. This page is the index.
Start here
README.mdWhat the platform is, what it deploys, the quick start, and the alpha warning in the maintainer's own words.ENTRY
DEPLOYMENT.mdThe local-only deployment model in detail: what runs where, and why GitHub stops mattering after the clone.MODEL
PROJECT_STRUCTURE.mdA deep dive on the repository layout — which directory owns which concern, and where to add things.MAP
.env.exampleThe complete configuration reference. Every variable the platform reads, with defaults and comments.CONFIG
Reference
Under docs/ in the platform repository.
| Document | Covers |
|---|---|
| ARCHITECTURE.md | Component responsibilities, boundaries, and the reasoning behind the layering |
| CATALOG.md | How a catalog app is structured and what each file in it is for |
| MIDDLEWARES.md | Every Traefik middleware, what it does, and which routes should carry it |
| RUNBOOK.md | Routine operations: adding nodes, rotating credentials, planned maintenance |
| TROUBLESHOOTING.md | Symptoms and their real causes, written after the incident that produced them |
| sealed-mode.md | Running the platform air-gapped, and what changes when it cannot reach the internet |
| node-placement-and-reservations.md | Pinning workloads to nodes and reserving capacity for them |
Operations
Under docs/ in the infrastructure repository, written as runbooks rather than essays.
| Runbook | When you need it |
|---|---|
| BACKUP-AND-RESTORE-RUNBOOK.md | Setting backups up, and the restore rehearsal that proves they work |
| BREAK-GLASS.md | SSO is down, or nobody can log in. The path back in, and its cost. |
| NODE-OPS-READINESS.md | Before draining, resizing, adding or retiring a node |
| OPENBAO-OPERATIONS.md | Unsealing, rotating, and the Kubernetes auth migration |
| SCHEDULING-ZONES.md | Placement across sites, and why a singleton on the wrong side of a link is slow |
| SECURITY-REMEDIATION-RUNBOOK.md | Working through a finding without breaking the cluster |
| CAPACITY-PLAN.md | Sizing the next node before the current ones are full |
| PRIVATE-PUBLIC-GITOPS-AND-DR.md | How the private infra repo and the public template stay separate, and disaster recovery |
| gitops-operating-model.md | The rules of engagement for changing a GitOps-managed cluster |
| cluster-builder.md | Node topology: control, worker and hybrid roles |