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