Skip to content

docs(architecture): split unreadable §3 infra diagram into master + 3 focus - #89

Merged
GMartin-Data merged 2 commits into
mainfrom
docs/architecture-infra-diagrams
Jun 2, 2026
Merged

GMartin-Data merged 2 commits into
mainfrom
docs/architecture-infra-diagrams

Conversation

@GMartin-Data

Copy link
Copy Markdown
Owner

Contexte

Le diagramme « Infrastructure et déploiement » (§3 de docs/architecture.md) était illisible : un seul plan portait 7 préoccupations orthogonales (runtime + sécurité + monitoring + IaC + CI/CD + storage + secrets), avec 18 arêtes dont la moitié pointillées qui se croisaient.

Cette PR le décompose en quatre vues lisibles qui partagent le même squelette runtime — un lecteur reconnaît les mêmes nœuds (Job ingestion / Job dbt / BigQuery) d'un diagramme à l'autre.

Décisions techniques

Point Choix
Principe 1 diagramme = 1 préoccupation, au lieu d'un plan fourre-tout
§3.1 MASTER Flux runtime nominal pur (Scheduler → ingestion → GCS → BQ → dbt → marts → dashboard)
§3.2/3.3/3.4 Focus sécurité / monitoring / déploiement, chacun sur le squelette runtime
Texte « Points clés » existant conservé (toujours cohérent avec les nouveaux schémas)
Dark mode linkStyle default stroke:#888 ajouté — les arêtes étaient invisibles sur fond sombre

Changements

  • docs/architecture.md §3 : remplacement du graph TD dense par 4 blocs flowchart LR (§3.1 à §3.4). §1 et §2 inchangés.

Validation

```
$ grep -c '### 3.' docs/architecture.md
4 # 4 sous-sections §3.1 à §3.4
$ grep -n 'graph TD' docs/architecture.md
17:graph TD # = §1 Acquisition (légitime, intact)
```

Diff : +119 / −66. Aucune ressource modifiée → pas d'impact infra. Pre-commit + Conventional Commit verts. Rendu Mermaid vérifié (GitHub + preview).

NB : le fichier hors-repo datatalent_docs/architecture/architecture-datatalent-details.md a reçu la même refonte en miroir (cohérence des deux sources).

Décisions liées

Refs : D60 (SA distincts), D105/D106/D109 (monitoring + trou scheduler), D70 (CI/CD), D72/D108 (orchestration), D113 (env vars).

Add a root Makefile exposing four lightweight targets for the soutenance
demo gestures: trigger (Scheduler), last-run, logs, fresh. Commands are
kept deliberately light (--limit=1, table format) for live readability,
distinct from the richer diagnostic variants in docs/runbook.md.

The runbook gains a cross-reference note pointing to make for quick checks
while keeping all its diagnostic commands (jq triggerName, raw/marts
asymmetry, Knative v1 paths) — no double source of truth, different intents.

Refs: D114
… focus

The single "Infrastructure et déploiement" diagram carried 7 orthogonal
concerns (runtime + security + monitoring + IaC + CI/CD + storage + secrets,
18 edges half of them dashed and crossing), making it unreadable.

Replace it with four readable views sharing the same runtime skeleton:
- 3.1 nominal execution flow (Scheduler → ingestion → GCS → BQ → dbt → dashboard)
- 3.2 focus security & identity (sa-ingestion / sa-dbt / Secret Manager)
- 3.3 focus monitoring & robustness (2 alerts + assumed scheduler gap, D109)
- 3.4 focus deployment (Terraform 6 modules + CI/CD)

Existing "Points clés" prose preserved (still consistent). linkStyle added
for edge visibility in dark mode.
@ESNAULTQ
ESNAULTQ self-requested a review June 2, 2026 07:14

@ESNAULTQ ESNAULTQ left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je t'autorise car je suis le grand validateur

@GMartin-Data
GMartin-Data merged commit cf2b4c8 into main Jun 2, 2026
6 checks passed
@GMartin-Data
GMartin-Data deleted the docs/architecture-infra-diagrams branch June 2, 2026 07:18
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.

2 participants