Skip to content

docs: add Mermaid architecture diagrams#1485

Open
ixxeL2097 wants to merge 4 commits into
mainfrom
docs/mermaid-diagrams
Open

docs: add Mermaid architecture diagrams#1485
ixxeL2097 wants to merge 4 commits into
mainfrom
docs/mermaid-diagrams

Conversation

@ixxeL2097

Copy link
Copy Markdown
Member

Summary

  • Enables Mermaid diagram support in MkDocs via pymdownx.superfences custom fences
  • Adds architecture diagrams to 7 existing docs and creates a new vault.md page
  • Updates ArgoCD doc to reflect current common/ + beelink//genmachine/ directory structure

Diagrams added

File Diagram(s)
index.md Global homelab architecture (clusters, GitHub, key services)
argocd/argocd.md GitOps reconciliation loop, App-of-Apps pattern, Helm value hierarchy
cluster/talos.md Talos cluster topology (3 VMs, etcd, Cilium)
certificates/certmanager.md PKI chain: Vault Root CA → Intermediate → cert-manager → TLS Secret
secrets/externalsecrets.md ESO → Vault Kubernetes auth flow
secrets/vault.md (new) Cross-cluster transit auto-unseal, seal migration, deadlock recovery, K8s auth
authentication/oidc.md OIDC authorization code flow + group claim injection
authentication/proxy-auth.md Traefik forward-auth with Authentik outpost

Test plan

  • MkDocs builds without errors (mkdocs build)
  • Mermaid diagrams render correctly in both light and dark mode
  • New vault.md page appears in nav under Secrets

🤖 Generated with Claude Code

ixxeL2097 and others added 4 commits April 26, 2026 09:30
- Enable Mermaid support in mkdocs.yml via pymdownx.superfences custom_fences
- index.md: global homelab architecture overview (two clusters, GitHub, key services)
- argocd.md: GitOps reconciliation loop, App-of-Apps pattern, Helm value hierarchy;
  update directory structure to reflect current common/beelink/genmachine layout
- talos.md: Talos cluster topology (3 control-plane VMs on Proxmox, etcd, Cilium)
- certmanager.md: PKI chain from Vault Root CA to TLS Secret via cert-manager
- externalsecrets.md: ESO → Vault Kubernetes auth flow; fix incomplete intro sentence
- oidc.md: OIDC authorization code flow and group claim injection via scope mappings
- proxy-auth.md: Traefik forward-auth flow with Authentik outpost and header passthrough
- vault.md (new): Vault cross-cluster transit auto-unseal, seal migration, deadlock recovery,
  Kubernetes auth flow; added to mkdocs.yml nav under Secrets

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…table

- Full page redesign: hero section, tabbed badges per cluster, stack table
- Two Mermaid diagrams: infrastructure topology (layered TB graph with all
  components grouped by plane) and request flow (DNS → Traefik → ForwardAuth → app)
- Badges reorganized into pymdownx.tabbed tabs (beelink vs genmachine)
- Stack table listing every major component with its role

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
mise manages all CLI tools (kubectl, helm, vault, sops, talosctl, etc.)
and Python/Node runtimes. uv manages Python packages declared in
pyproject.toml; the .venv is auto-activated via mise's _.python.venv.

First-time setup: mise install && task setup (or uv sync + helm/krew plugins)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…agrams

- vault.md: remove Transit Auto-Unseal and Seal Migration sections; keep
  PKI/KV overview and Kubernetes auth flow
- index.md: remove transit auto-unseal arrow from architecture diagram
- README.md: replace Excalidraw SVG images with native GitHub Mermaid diagrams;
  fix traefik beelink badge URL (was pointing to old k0s path); reorganize
  badges by cluster; add GitOps flow diagram and stack table

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ixxeL2097 ixxeL2097 force-pushed the main branch 10 times, most recently from 99be2b4 to 0ff926a Compare April 26, 2026 19:16
@ixxeL2097 ixxeL2097 force-pushed the main branch 3 times, most recently from 5248ff3 to 5c29049 Compare May 14, 2026 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant