System Diagrams¶
This folder contains architecture diagrams. Some sequence diagrams are explicitly marked as historical; check their status notes before using them as a description of the current implementation. For the current module/build inventory, see Project module inventory.
| File | Content |
|---|---|
| 01-component-diagram.md | Component diagram and explanation of dependencies |
| 02-sequence-diagrams.md | Sequence diagrams of the system's main flows |
| 03-system-architecture.md | System architecture: C4 Context/Containers, Android MDPL client, MQTT pipeline, Fabric audit trail, Docker deployment, Maven dependency graph, ADRs |
| 04-mqtt-docker-simulation.md | Detailed sequence diagram of the simulation process via MQTT and Docker containers (clients, aggregator, and Fabric) |
| 05-vm-deployment-topology.md | VM Deployment Topology: Docker Compose multi-service architecture, dual-network bridging (hdt-net + fabric_test), Hyperledger Fabric integration, and startup sequence |
| component-diagram-complete.md | Complete component diagram covering all 22 Maven modules of the reactor and the external infrastructure |
| component-diagram-simplified-plantuml.md | Simplified component diagram in PlantUML (UML 2.5) specification covering the 5 main subsystems |
Index of sequence diagrams¶
| # | Title | Flow covered |
|---|---|---|
| 1 | Complete Experiment Lifecycle | DRAFT → PUBLISHED → ACTIVE → CLOSED with Fabric |
| 2 | Flow of a Federated Training Round | Orchestrator → clients → aggregation → global model |
| 3 | MQTT Dataset Ingestion | Replay Simulator → MqttTimeSeriesIngestor → DataComponent |
| 4 | Web Monitor (Lifecycle via HTTP) | Creation, publication, activation, round start, blockchain explorer |
| 5 | Federated Orchestration and Aggregation (Detailed) | 6 phases: initiation, selection, RoundConfig, clients, aggregation, post-round |
| 6 | Local Training (Detailed) | Contract, acceptance, preflight, training epochs, update publication |
| 7 | Contract State Machine | DRAFT → PUBLISHED → ACTIVE → PAUSED → CLOSED → REVOKED |
| 8 | Training with IoT Simulator + Hyperledger Fabric | Session-based simulation → MQTT replay → materialization → preflight → training + on-chain registration → aggregation + model on Fabric |
| 9 | Android Multiexperiment Training through MDPL | Consent-scoped round lifecycles → signed DEX package validation → local CDDL/MDPL training → signed update relay |
The documentation uses PlantUML and Mermaid source blocks so diagrams remain version-controllable and reviewable alongside the implementation.