docs(explainers): a plain-language entry point for the homelab stack - #253
Open
openbao-service-broker[bot] wants to merge 1 commit into
Open
docs(explainers): a plain-language entry point for the homelab stack#253openbao-service-broker[bot] wants to merge 1 commit into
openbao-service-broker[bot] wants to merge 1 commit into
Conversation
Every architecture page on this site assumes the reader already knows what a hypervisor is. Six pages that do not, sitting directly after Start here so a newcomer meets them before the technical sections. The arc is dependency-ordered: hypervisor, then clusters and quorum, then what actually happens when a machine dies, then the two things people ask about most once they see a self-hosted stack — one login across everything, and where the passwords live. Each page leads with the misconception rather than the definition, because the misconceptions are load-bearing: - Adding a second host for redundancy makes a two-node cluster strictly worse, not better. Quorum needs more than half, and two of two is not a majority. - Backup, replication and failover solve three different problems. Replication copies a mistake faithfully and instantly; only a backup survives one. And a replicated guest that nothing promotes is a copy, not a recovery. - A failover target must already hold the data, so a guest is pinned to the hosts that replicate it. Getting that wrong is worse than no automation, because the automation confidently does something broken. - Single sign-on is safer than per-app logins for the reason it looks riskier: exactly one system ever handles a password. - The identity header a proxy injects must be stripped from inbound requests first. Strip-then-authenticate and authenticate-then-strip look nearly identical and differ by a total authentication bypass. Names are placeholders throughout, per the site's scrubbing convention: the structure is the teachable part and a real map of a private network is not. Verification: mermaid validator renders all six diagrams (exit 0), the init directive is byte-identical to the site's single canonical line, every diagram is 4-6 nodes against the 12 cap, all eleven internal links resolve, and jq parses docs.json. The nav edit is 11 insertions and no deletions. Assisted-by: Claude:claude-opus-5[1m]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A plain-language entry point for the homelab stack
Every architecture page on this site assumes the reader already knows what a
hypervisor is. These six do not.
They sit directly after Start here in the Overview dropdown, so someone
arriving cold meets them before the technical sections rather than after.
The arc
Dependency-ordered, each page assuming only the one before it: what a
hypervisor is, then clusters and quorum, then what actually happens when a
machine dies, then the two questions people ask as soon as they see a
self-hosted stack — one login across everything, and where the passwords live.
Each page leads with the misconception rather than the definition, because in
this subject the misconceptions are the load-bearing part:
worse. A majority is more than half, and two of two is not one.
copies a mistake faithfully and instantly; only a backup survives one. And a
replicated guest that nothing promotes is a copy, not a recovery — "it's
replicated" and "it recovers" are different claims.
hosts that replicate it. Getting that wrong is worse than having no
automation, because the automation confidently does something broken.
riskier: exactly one system ever handles a password.
first. Strip-then-authenticate and authenticate-then-strip look nearly
identical and differ by a complete authentication bypass.
Placement and scope
New content, not a duplicate — nothing on the site currently explains
virtualization, quorum, hypervisor-level HA, or SSO to a general audience.
Where an existing page already owns a topic concretely it is linked rather than
restated; the node-loss page points at
infrastructure/data-platform-resilienceinstead of re-explaining it for the database tier.
Names are placeholders throughout, following the site's existing scrubbing
convention. The structure is the teachable part; a real map of a private
network is not.
Verification
./scripts/validate-mermaid.shrenders every diagram on the site — exit 0%%{init …}%%directive is byte-identical to the site's single canonicalline (the uniqueness count CI asserts stays at 1)
self-check comment above the fence
jq empty docs.jsonpasses; the navigation edit is 11 insertions, 0 deletionsAccordion,TabsorFrame