Files
ENI-projet-piscine/docs/architecture/00-vue-ensemble.md
T
Johan LEROY 9ee0de9d55 docs: réaligne la documentation sur l'état livré au gel
Trois environnements et un frontal SNI au lieu de deux, certificats Let's
Encrypt par DNS-01, sept DAGs, index des ADR complété jusqu'à 0020. Les
exemples de l'ETL passent en bash et n'utilisent plus l'option --limit,
retirée. L'adresse de la machine est masquée dans l'arbre, les ADR 0009 et
0014 portent une note datée sur l'approbation de la production.
2026-09-24 15:55:08 +02:00

18 KiB

Vue d'ensemble

EnerVision collecte, stocke, analyse et restitue des séries temporelles énergétiques, sur une machine on-premise.

Cadre du projet

Quatre jalons ont été posés à l'ouverture du projet. Ils ont disparu du README.md lors de la réécriture de l'arborescence (2670483) et ne subsistaient que sur main. Ils sont repris ici parce qu'ils disent ce que le projet doit prouver, et donc à quoi sert chaque décision technique.

Jalon Intitulé Ce que la documentation apporte
J1 Valider la préparation de l'environnement et du repo 10-infra.md décrit la stack du poste de développement et la commande qui la démarre
J2 Valider le périmètre retenu et les choix technologiques Les ADR (../adr/) portent les choix ; 40-data.md liste les questions de périmètre encore ouvertes
J3 Ingestion & backend 20-backend.md
J4 Architecture, sécurité & frontend Les cinq vues, et la section « Sécurité » ci-dessous qui consolide les surfaces exposées
J5 Valider la robustesse et assurer les livrables 20-backend.md et 30-frontend.md renvoient aux conventions de tests de chaque application

Contexte

Statut : Fait. Les sources de mesures ont été arrêtées au jalon J2 : le dataset historique fourni par l'école (CSV et métadonnées JSON, 2023 et 2024) et l'API Mock, interrogée chaque heure.

flowchart LR
  exploitant["Exploitant<br/>consulte les courbes"]
  admin["Administrateur<br/>exploite la plateforme"]
  sources["Sources de mesures<br/>dataset CSV et API Mock"]

  subgraph systeme["EnerVision"]
    plateforme["Collecte, stockage,<br/>analyse et restitution<br/>de séries temporelles"]
  end

  sources --> plateforme
  exploitant --> plateforme
  admin --> plateforme

Conteneurs

Trait plein pour ce qui tourne, pointillé pour ce qui est cible.

flowchart TB
  navigateur["Navigateur"]

  subgraph machine["Machine on-premise"]
    frontal["Frontal SNI<br/>:80 et :443"]
    proxy["Reverse proxy Nginx<br/>un par environnement"]
    front["Frontend Angular 22<br/>apps/frontend"]
    api["API FastAPI<br/>apps/backend"]
    db[("PostgreSQL 17<br/>TimescaleDB")]
    airflow["Airflow<br/>etl/airflow"]
    prom["Prometheus<br/>profil monitoring"]
    grafana["Grafana<br/>profil monitoring"]
  end

  navigateur --> frontal
  frontal --> proxy
  proxy --> front
  proxy --> api
  front --> api
  api --> db
  airflow --> db
  prom --> api
  grafana --> db
  grafana --> prom

Le lien front --> api est en trait plein : les fixtures sont coupées (useMockFixtures: false dans les deux fichiers d'environnement Angular), et chaque service HTTP du frontend interroge l'API réelle. Voir 30-frontend.md. Sur la machine, un frontal SNI reçoit les ports 80 et 443 et aiguille chaque nom vers le proxy de son environnement (ADR 0018).

Le lien airflow --> db est maintenant en trait plein : sept DAGs tournent, deux pour l'entraînement et le scoring du modèle ML (issue #115), un pour la détection d'alertes et la génération des recommandations (issue #116), un pour la surveillance de dérive (issue #45), historical_import pour le dataset historique (issue #119), mock_api_import pour l'ingestion horaire de l'API Mock (issue #15) et retention, qui exporte les chunks anciens de reading vers Garage avant de les supprimer (issue #36). La réconciliation entre les deux sources de lectures (issue #15) est tranchée : le trou entre la fin de l'historique (31/12/2024) et le début de l'ingestion API Mock est accepté comme définitivement perdu, aucune mesure réelle n'existant pour cette période. mock_api_import refuse toute fenêtre qui recouvrirait des lectures déjà importées du CSV plutôt que de laisser les deux sources dupliquer silencieusement un même instant, et le pipeline ML déduplique par construction (DISTINCT ON, source csv préférée) au cas où un recouvrement se produirait malgré tout, voir 40-data.md.

Les liens de la supervision sont en trait plein depuis le 23/09 (issue #26) : Prometheus scrute /metrics avec un jeton, Grafana lit Prometheus et, par un rôle en lecture seule, les tables métier de TimescaleDB. Ils tournent en prod sous le profil Compose monitoring, à la demande ailleurs (ADR 0016, 60-observabilite.md).

État de la stack

Domaine Technologie Emplacement Statut Ce qui existe réellement
Backend FastAPI, Python 3.14 apps/backend En cours Factory, configuration, journalisation, 2 sondes de santé, /metrics, contrat OpenAPI versionné, routes sites, alerts, recommendations, stats/summary, readings, sensors/status et predictions en lecture (endpoints → services → repositories → models)
Frontend Angular 22, Node 26 apps/frontend En cours Tableau de bord sur route /dashboard, authentification complète (garde de route, intercepteur de jeton), huit services HTTP, graphiques Chart.js, vues sites, recommandations et supervision des capteurs. Tous branchés sur l'API réelle (useMockFixtures: false) ; l'intercepteur de fixtures ne sert plus qu'au développement hors ligne
Base PostgreSQL 17 + TimescaleDB db Fait Bootstrap de l'extension, base de test, chaîne Alembic. Schéma applicatif créé (site, dataset, reading en hypertable, prediction, alert, recommendation)
ML LightGBM, MLflow ml En cours Pipeline d'entraînement et de scoring (enervision_ml.train/.score, features par lags/moyennes glissantes partagées entre les deux, baseline de persistance saisonnière, suivi MLflow local), exposé en lecture via GET /predictions, orchestré par Airflow (ml_train/ml_score). Voir ADR 0005 et ML-START.md. Surveillance de dérive livrée côté backend (app.monitoring.drift, table drift_report, GET /monitoring/drift, DAG derive), voir ADR 0013
Infra Docker Compose, Nginx, Terraform, k3s single-node infra, docker-compose.prod.yml En cours Reverse proxy et overlay de déploiement en service sur la machine, un proxy par environnement derrière un frontal SNI (ADR 0007, ADR 0018). Provisionnement de la VM par Terraform, appliqué : Docker installé, trois environnements préparés, runner enregistré ; le coffre LUKS n'est pas appliqué, la machine étant un conteneur LXC (ADR 0010, ADR 0020). Module d'installation k3s jamais appliqué, aucune ressource Kubernetes déclarée
Stockage objet Garage, S3 infra/garage, docker-compose.yml Fait Un Garage par environnement, --single-node --default-bucket, secrets par l'environnement, ports sur 127.0.0.1, fumée S3 et SSE-C en CI. Reçoit les archives CSV gzip du DAG retention, chiffrées SSE-C, avant drop_chunks (ADR 0019, ADR 0020)
Monitoring Prometheus, Grafana, Alertmanager monitoring Fait Profil Compose monitoring, actif en prod : Prometheus et trois exporteurs (PostgreSQL, hôte, conteneurs), neuf règles d'alerte testées par promtool, Alertmanager vers Mailpit, trois tableaux de bord Grafana provisionnés. Voir 60-observabilite.md
ETL Apache Airflow etl/airflow En cours Webserver et scheduler avec LocalExecutor via Docker Compose, sur une base PostgreSQL dédiée. Sept DAGs en sous-processus uv run : ml_train, ml_score, alertes, historical_import, mock_api_import, derive (quotidien, surveillance de dérive) et retention (quotidien, export vers Garage puis suppression). L'import historique reste manuel et l'import API Mock s'exécute chaque heure. Réconciliation entre les deux sources (issue #15) : trou temporel accepté, recouvrement refusé à l'ingestion et dédupliqué en défense côté ML, voir 40-data.md.
CI/CD GitHub Actions .github/workflows Fait Un orchestrateur ci.yml qui n'appelle que les composants modifiés (ADR 0014) : lint, typage, tests avec seuil de couverture bloquant, tests d'intégration sur TimescaleDB réel, audit de dépendances, SAST Bandit, quality gate SonarCloud, intégrité des DAGs Airflow, Terraform, Compose et supervision, parcours Playwright et tirs k6 contre la stack de prod (ADR 0015). Déploiement vers la VM ENI par deploy.yml, appelé une fois « CI ok » vert, dev en recette et main en production (ADR 0009), et toute autre branche à la demande dans dev (ADR 0017). Sept déploiements de production réussis, le dernier sur le commit gelé ; l'environnement prod n'exige aucun relecteur (relevé du 24/09). Détail dans 50-cicd.md

Flux bout en bout

Statut : En cours. Le chemin de lecture tourne entre la base, l'API et le frontend. Le chemin d'ingestion est maintenant orchestré par Airflow : historical_import charge le dataset CSV/JSON sur déclenchement manuel et mock_api_import collecte chaque heure les mesures de l'API Mock. Les DAGs ml_train et ml_score (issue #115), alertes (issue #116) et derive (issue #45) portent le pipeline ML, la détection d'alertes et la surveillance de dérive. La réconciliation entre les deux sources de lectures (issue #15) est close : voir 40-data.md pour le détail du garde-fou d'ingestion et de la déduplication ML.

sequenceDiagram
  participant S as Source de mesures
  participant A as Airflow
  participant T as TimescaleDB
  participant API as FastAPI
  participant U as Angular

  S->>A: mesures horodatées
  A->>T: insertion dans l'hypertable
  U->>API: GET /api/v1/...
  API->>T: agrégation sur la fenêtre demandée
  T-->>API: lignes
  API-->>U: JSON

Sécurité

Section rattachée au jalon J3. Le détail par brique est dans chaque document ; voici la vue consolidée.

En place

  • Authentification et autorisation. JWT d'accès de 15 minutes, jeton de rafraîchissement opaque en cookie HttpOnly avec rotation et détection de réutilisation, mots de passe en Argon2id, RBAC à trois rôles. Détail dans 20-backend.md, décisions dans les ADR 0002 et 0003.
  • Chiffrement au repos. Les archives de mesures déposées sur Garage sont chiffrées par clé client (SSE-C). Le coffre LUKS des volumes Docker (scripts/coffre-luks.sh) est prêt pour une vraie VM, mais la machine ENI est un conteneur LXC sans device-mapper : le chiffrement de son disque relève de l'hôte Proxmox, demandé à l'école. Ce qui est couvert et ce qui ne l'est pas : ADR 0020.
  • Interdire par défaut. Toute route exige un jeton, sauf huit routes publiques listées nommément dans tests/api/acces.py, et un test interroge réellement chaque route sans identifiant.
  • Révocation immédiate. Le compte est relu en base à chaque requête : une désactivation ou un changement de rôle prend effet à la requête suivante, pas au bout de 15 minutes.
  • Limitation de débit à fenêtre glissante sur trois clés, évaluée avant le hachage. Pas de verrouillage de compte, qui serait un déni de service trivial.
  • Journal d'audit en ajout seul, garanti par deux déclencheurs PostgreSQL (ADR 0004).
  • Les secrets n'ont pas de valeur par défaut. APP_SECRET_KEY et DATABASE_URL sont requis sans repli, et la configuration refuse de démarrer sur cinq erreurs silencieuses : secret trop court ou laissé à sa valeur d'exemple, debug en production, joker CORS, origines vides hors local, cookie SameSite=None sans Secure.
  • CORS explicite : origines listées, méthodes et en-têtes énumérés, jamais de joker.
  • En-têtes de sécurité posés par l'application (nosniff, DENY, no-referrer) et Cache-Control: no-store sur les routes d'authentification.
  • Caviardage des journaux : jetons, empreintes Argon2, mots de passe et cookies sont expurgés avant écriture.
  • Documentation interactive fermée en préproduction et en production, /metrics derrière un jeton, exigé dès que la supervision tourne, sonde de disponibilité qui ne publie plus la version de TimescaleDB.
  • CI backend bloquante : format, lint, typage strict et tests avec seuil de couverture.
  • Conteneur backend non-root, déclaré dans apps/backend/Dockerfile.
  • Terminaison TLS au proxy de chaque environnement, derrière un frontal SNI qui est le seul composant publié sur la machine et aiguille sans déchiffrer. Certificats Let's Encrypt par DNS-01 (ADR 0018). Le proxy redirige 80 vers 443, sert le SPA et l'API sous la même origine, pose HSTS et CSP que l'application refuse délibérément de poser, et ajoute une limitation de débit au frontal distincte de celle de l'application. Voir ADR 0007.
  • Côté infrastructure : la clé SSH est marquée sensitive, le kubeconfig reste en 600/root sur la machine cible et n'est lu que par sudo, *.tfvars est ignoré par git sauf les .example.

Absent, et assumé

  • Rôles PostgreSQL cantonnés pour l'ETL et le travail d'apprentissage. C'est la vraie frontière pour ces deux consommateurs, qui écrivent en base et non par HTTP. Reporté parce que cela impose une réinitialisation de base à toute l'équipe. Voir l'ADR 0003.
  • REVOKE sur audit_log : les déclencheurs arrêtent les accidents, les privilèges arrêteraient une application compromise. Même raison de report.
  • Portée par site dans l'autorisation : les rôles sont globaux, un opérateur du site A peut agir sur le site B. C'est la limite connue du modèle.
  • Approbation humaine avant la production : l'environnement GitHub prod n'accepte que main mais n'exige aucun relecteur, et aucune branche n'est protégée. Réglage réservé à l'administratrice du dépôt.
  • Analyse des images de conteneur dans la CI. Celle des dépendances, elle, est en place (pip-audit, npm audit, Dependabot sur 5 écosystèmes), de même que le SAST Bandit. Voir 50-cicd.md.

Décisions structurantes

Elles vivent dans ../adr/, pas ici.

ADR Objet
0001 PostgreSQL 17 avec l'extension TimescaleDB, et la frontière db/ vs alembic/
0002 Authentification par JWT d'accès et jeton de rafraîchissement opaque
0003 Autorisation RBAC à trois rôles, avec relecture du compte à chaque requête
0004 Journal d'audit en ajout seul, garanti par PostgreSQL
0005 Modèle de prédiction de consommation : LightGBM
0006 Le moteur de règles de recommandation vit dans le backend, pas dans ml/
0007 Terminaison TLS par un reverse proxy Nginx, en Docker Compose
0008 Airflow exécute le code du backend en sous-processus, dans son propre environnement
0009 Un projet Compose par environnement sur la VM ENI, déployé par un runner auto-hébergé (deux environnements à l'origine, trois depuis l'ADR 0017)
0010 Terraform provisionne la machine, GitHub Actions déploie l'application
0011 Procédure de déploiement, telle qu'exécutée le 22/09/2026
0012 État de la recette et de la production sur la VM ENI
0013 La surveillance de dérive vit dans le backend et écrit sa propre table
0014 Un pipeline CI unique appelle les workflows de composant et conditionne le déploiement
0015 Les tests de bout en bout et de charge visent la stack Compose déployée
0016 La supervision vit dans un profil Compose, active en prod
0017 Un troisième environnement, dev, déployé à la demande depuis n'importe quelle branche
0018 Noms publics, certificats Let's Encrypt par DNS-01 et frontal SNI sans port
0019 Stockage objet Garage par environnement ; les chunks anciens de reading sont exportés en CSV gzip puis supprimés
0020 Chiffrement au repos : coffre LUKS des volumes Docker de la VM, SSE-C des archives