Billy D.
b4e608f002
All checks were successful
Update README with ADR Index / update-readme (push) Successful in 6s
Diagrams
This directory contains additional architecture diagrams beyond the main C4 diagrams.
Available Diagrams
| File | Description | Related ADR |
|---|---|---|
| gpu-allocation.mmd | GPU workload distribution | ADR-0005 |
| data-flow-chat.mmd | Chat request data flow | ADR-0003 |
| data-flow-voice.mmd | Voice request data flow | ADR-0003 |
| gitops-flux.mmd | GitOps reconciliation loop | ADR-0006 |
| dual-workflow-engines.mmd | Argo vs Kubeflow decision flow | ADR-0009 |
| kuberay-unified-backend.mmd | RayService endpoints and GPU allocation | ADR-0011 |
| secrets-management.mmd | SOPS bootstrap vs Vault runtime | ADR-0017 |
| security-policy-enforcement.mmd | Gatekeeper admission + Trivy scanning | ADR-0018 |
| handler-deployment.mmd | Ray cluster platform layers | ADR-0019 |
| internal-registry.mmd | Internal vs external registry paths | ADR-0020 |
| notification-architecture.mmd | ntfy hub with sources and consumers | ADR-0021 |
| ntfy-discord-bridge.mmd | ntfy to Discord message flow | ADR-0022 |
| ray-repository-structure.mmd | Ray package build and loading | ADR-0024 |
| observability-stack.mmd | Prometheus + ClickStack telemetry flow | ADR-0025 |
| storage-strategy.mmd | Longhorn + NFS dual-tier storage | ADR-0026 |
| database-strategy.mmd | CloudNativePG cluster management | ADR-0027 |
| authentik-sso.mmd | Authentik authentication flow | ADR-0028 |
| user-registration-workflow.mmd | User registration and approval | ADR-0029 |
| velero-backup.mmd | Velero backup and restore flow | ADR-0032 |
| analytics-lakehouse.mmd | Data analytics lakehouse architecture | ADR-0033 |
| volcano-scheduling.mmd | Volcano batch scheduler and queues | ADR-0034 |
| cluster-topology.mmd | Node topology (x86/ARM64/GPU) | ADR-0035 |
| renovate-workflow.mmd | Renovate dependency update cycle | ADR-0036 |
| node-naming.mmd | D&D-themed node naming conventions | ADR-0037 |
Rendering Diagrams
VS Code
Install the "Markdown Preview Mermaid Support" extension.
CLI
# Using mmdc (Mermaid CLI)
npx @mermaid-js/mermaid-cli mmdc -i diagram.mmd -o diagram.png
Online
Diagram Conventions
- Use
.mmdextension for Mermaid diagrams - Include title as comment at top of file
- Use consistent styling classes
- Keep diagrams focused (one concept per diagram)