Maîtriser les diagrammes de conteneurs C4 : Modéliser l’architecture de passerelle IoT

Read this post in: de_DEen_USen_USes_ESid_IDjapl_PLpt_PTvizh_CNzh_TW
VPasCode PlantUML C4 model of IoT Gateway System architecture diagram

Diagramme d'architecture du système de passerelle IoT basé sur le modèle C4 PlantUML de VPasCode

Dans l’architecture logicielle moderne, comprendre l’interaction entre le matériel physique et les services cloud est essentiel. Ce tutoriel explore une visualisation architecturale spécifique : leDiagramme de conteneurs de niveau 2 pour un système de passerelle IoT. En utilisant la méthodologie du modèle C4 dans un environnement VPasCode, nous expliquons comment représenter des systèmes embarqués complexes, des bases de données locales et des flux de données externes dans une vue unique et cohérente.

Contrairement à un diagramme de contexte de haut niveau qui présente un système comme une boîte noire, un diagramme de niveau 2 « ouvre la boîte ». Il révèle les environnements d’exécution internes, les limites des processus et les technologies spécifiques (langages, bases de données) qui alimentent l’application. Ci-dessous, nous parcourons la construction de ce diagramme, les choix de modélisation spécifiques effectués et la logique technique derrière les relations.

Le modèle C4 : Pourquoi utiliser des conteneurs ?

Le modèle C4 est une approche hiérarchique de la documentation de l’architecture logicielle. Il se compose de quatre niveaux :

  • Niveau 1 (Contexte) : Montre le système et ses utilisateurs.
  • Niveau 2 (Conteneur) : Montre les blocs de construction techniques de haut niveau (conteneurs) qui composent le système.
  • Niveau 3 (Composant) : Montre la structure interne d’un conteneur.
  • Niveau 4 (Code) : Montre les classes de code réelles et les dépendances.

Ce tutoriel se concentre surle niveau 2. Dans l’exemple fourni, nous modélisons unsystème de passerelle IoT. Il s’agit d’une frontière critique car elle représente la limite du réseau où les capteurs physiques rencontrent le cloud.

Étape par étape : Construction du diagramme

Pour recréer cette architecture, nous utilisons du code PlantUML. Ce code est analysé par l’éditeur VPasCode pour afficher le diagramme visuel à droite.

1. Mise en place : Inclusions et disposition

D’abord, nous devons charger la bibliothèque C4 PlantUML. Cette bibliothèque fournit les formes standard (personnes, conteneurs, boîtes) et les règles de style.

!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml

LAYOUT_WITH_LEGEND()

LaLAYOUTAVECLEGEND() est une directive spécifique qui indique au rendu d’organiser automatiquement les éléments et de générer une légende expliquant ce que signifient les formes (par exemple, « Personne » vs « Conteneur »).

2. Définir les acteurs et les systèmes externes

Avant de définir ce qui se trouve à l’intérieur de la passerelle, nous devons définir qui interagit avec elle et avec quoi elle communique à l’extérieur.

Person(homeowner, "Propriétaire du logement", "Surveille et contrôle le climat de la maison.")
System_Ext(weather_api, "API Météorologique Nationale", "Fournit des prévisions de température ambiante externes.")
  • Person(homeowner…) :Représente l’utilisateur humain. L’étiquette décrit leur rôle.
  • SystèmeExt(weatherapi…) :Représente un système situé en dehors de notre périmètre. Nous utilisons SystèmeExt plutôt qu’un Système pour indiquer que le code source n’est pas sous notre contrôle (il s’agit d’une API tierce).

3. Le périmètre du système et les conteneurs

C’est le cœur du diagramme. Nous définissons un SystèmePérimètre pour regrouper tout ce qui se passe à l’intérieur du matériel de la passerelle IoT.

System_Boundary(gateway_boundary, "Système de passerelle IoT") {
    Container(firmware, "Service de démon central", "C++ / FreeRTOS", "Interroge directement les registres matériels des capteurs physiques via I2C.")
    ContainerDb(local_db, "Cache de télémétrie", "Fichier SQLite", "Épingle temporairement les métriques des capteurs lors de pannes de connexion généralisées.")
    Container(mqtt_client, "Client de synchronisation cloud", "Binaire Go", "Pousse des paquets de télémétrie structurés vers l'amont via un socket WAN sécurisé.")
}

Remarquez les types spécifiques de conteneurs utilisés :

  1. Container(firmware…) : Cela représente le micrologiciel exécuté sur le microcontrôleur. La description met en évidence l’interaction de bas niveau : interrogation des registres matériels via I2C.
  2. ContainerDb(localdb…) : Nous utilisons ContainerDb spécifiquement pour les bases de données. La description explique le modèle « stocker et transmettre » : mise en tampon des données lorsque l’Internet est hors ligne.
  3. Container(mqttclient…):Cela représente un processus client (probablement exécuté en tant que fil d’exécution séparé ou processus sidecar) responsable de la connectivité cloud.

4. Définir les relations (les « lignes »)

Enfin, nous dessinons les flèches. Dans PlantUML, leRel commande signifie « Relation ». La syntaxe est généralementRel(Source, Cible, "Étiquette", "Protocole").

Rel(homeowner, firmware, "Contrôle localement via", "BLE")
Rel(firmware, local_db, "Écrit des métriques dans", "SQL / IPC")
Rel(mqtt_client, local_db, "Interroge les trames en attente depuis", "SQL / IPC")
Rel(mqtt_client, weather_api, "Récupère l'état environnemental via", "HTTPS")

Aperçus architecturaux clés issus de ces relations :

  • BLE (Bluetooth Low Energy) :Le propriétaire interagit directement avec le firmware via Bluetooth, et non via le cloud.
  • IPC (Communication Inter-Processus) :Remarquez que le firmware et le client MQTT interagissent avec la base de données viaSQL / IPC. Cela implique que la base de données est un fichier local (SQLite) qui agit comme un pont entre le processus de firmware C++ et le processus client Go.
  • HTTPS :Le client cloud communique avec l’API Météo via l’internet public.

Analyse technique : le modèle Store-and-Forward

Ce diagramme illustre un modèle classique dans l’ingénierie IoT :Store-and-Forward. Dans le diagramme, leCache de télémétrie(SQLite) est le composant critique. Il découple la collecte de données (firmware) de la transmission de données (Client MQTT).

Sans ce conteneur, si Internet tombait en panne, les données des capteurs seraient perdues. En introduisant leContainerDb, le système garantit l’intégrité des données. Le diagramme indique clairement que le « Client de synchronisation cloud » doit disposer d’une logique pour interroger la base de données afin de récupérer les « trames en attente » avant d’envoyer de nouvelles données.

Conclusion

En utilisant VPasCode et la bibliothèque C4 PlantUML, nous avons transformé une architecture matérielle-logicielle complexe en un diagramme clair et lisible. La vue de niveau 2 communique efficacement non seulement “qui utilise le système, mais “comment il fonctionne en interne, en mettant en évidence la séparation des préoccupations entre la collecte de données des capteurs, le stockage local des données et la synchronisation avec le cloud.