Platform documentatie (architectuur & uitvoering)
Index op het platform-bouwplan (telematics + user platform, self-hosted edge, roadmap MVP → Enterprise).
Master (altijd eerst bij grote wijzigingen)
| Document | Inhoud |
|---|---|
../PLATFORM-MASTER.md | Schaaldoelen (o.a. 40M gebruikers, 600k trackers), principes, append-only wijzigingslog, workflow voor agents/ontwikkelaars |
../../documentation/README.md | Docusaurus: publieke statische site uit deze docs/-Markdown (lokaal npm run docs:start vanaf repo-root) |
Roadmap & capacity
| Document | Inhoud |
|---|---|
phase-1-mvp.md | MVP-scope, DoD, auth-keuze |
phase-2-v1.md | Kafka, ClickHouse, Redis, worker, JWT, API’s |
metrics-baseline.md | Hoe ontwerpcijfers te gebruiken |
capacity-baseline.csv | Invulbare metrieken (spreadsheet) |
load-test-plan.md | Load/stress outline |
Grenzen & ADR’s
| Document | Inhoud |
|---|---|
identity-and-network-boundary.md | Keycloak, zones, geen public CDN |
adr/0002-network-and-identity-boundaries.md | ADR netwerk/identity |
adr/0003-mvp-ingest-api-boundary.md | Geen sync user→ingest |
adr/0004-data-plane-and-event-backbone.md | Stores + Kafka |
adr/0005-rbac-roles-scopes-permissions.md | RBAC: rollen, scopes, permissies |
adr/0006-in-app-support-desk.md | In-app supportdesk: tickets, SLA, e-mail, macro’s, KB |
Data & backbone
| Document | Inhoud |
|---|---|
data-plane.md | Postgres, ClickHouse, Redis, Kafka, OpenSearch, S3 |
backup-restore.md | Postgres dump/restore |
backup-dr-policy-template.md | RTO/RPO, retentie, alle stores |
Deployment & netwerk
| Document | Inhoud |
|---|---|
deployment-kubernetes.md | K8s namespaces, omgevingen |
examples/nginx-lb-example.conf | HTTP + TCP stream |
iraq-apn-operator-requirements.md | Private APN / operator checklist |
Docker Compose (optioneel)
| Bestand repo-root | Inhoud |
|---|---|
docker-compose.yml | App, db, telematics-gateway |
docker-compose.platform-stack.yml | Redis, Kafka+ZK, ClickHouse, MinIO (--profile platform) |
docker-compose.keycloak.yml | Keycloak start-dev op :8081 (evaluatie) |
Telematics (bestaand)
Zie ../telematics/README.md voor gateway, Codec 8, commands.