@@ -54,11 +54,11 @@ Welcome to the OpenDT documentation! This document provides a comprehensive over
5454 ┌─────────┴─────────────┐
5555 │ │
5656 ┌────────▼──────┐ ┌─────────▼────────┐
57- │ sim-worker │ │ opendt-api │
57+ │ sim-worker │ │ dashboard │
5858 │ (Consumer) │ │ (FastAPI) │
5959 │ │ │ │
60- │ • Windows │ │ • REST API │
61- │ • OpenDC │ │ • WebSockets │
60+ │ • Windows │ │ • Web UI │
61+ │ • OpenDC │ │ • REST API │
6262 │ • Caching │◀────│ • Topology Mgmt │
6363 │ • Experiments │ │ │
6464 └───────┬───────┘ └─────────┬────────┘
@@ -125,20 +125,22 @@ OpenDT consists of 5 microservices orchestrated via Docker Compose:
125125
126126---
127127
128- ### 3. opendt-api (API Gateway )
128+ ### 3. dashboard (Web Dashboard )
129129
130- ** Purpose** : REST API and WebSocket gateway for frontend and external integrations
130+ ** Purpose** : Web dashboard and REST API for system control and visualization
131131
132- ** Location** : [ ` ../services/opendt-api / ` ] ( ../services/opendt-api /README.md )
132+ ** Location** : [ ` ../services/dashboard / ` ] ( ../services/dashboard /README.md )
133133
134134** Key Features** :
135+ - Web UI for real-time visualization
135136- FastAPI with automatic OpenAPI documentation
136137- Topology management endpoint (` PUT /api/topology ` )
137138- Health check and status endpoints
138139- Kafka producer for configuration updates
140+ - Static file serving for dashboard assets
139141
140- ** Endpoints ** :
141- - ` GET / ` - Service information
142+ ** Routes ** :
143+ - ` GET / ` - Web dashboard UI
142144- ` GET /health ` - Health check (Kafka + config status)
143145- ` GET /docs ` - Interactive Swagger UI
144146- ` PUT /api/topology ` - Update simulated datacenter topology
@@ -159,20 +161,6 @@ OpenDT consists of 5 microservices orchestrated via Docker Compose:
159161
160162---
161163
162- ### 5. frontend (Dashboard - Planned)
163-
164- ** Purpose** : Next.js dashboard for visualization and control
165-
166- ** Status** : Planned/In Development
167-
168- ** Planned Features** :
169- - Real-time power consumption graphs (actual vs. predicted)
170- - Topology editor for What-If scenarios
171- - Experiment management interface
172- - Simulation control (pause/resume/speed)
173-
174- ---
175-
176164## Data Flow
177165
178166### 1. Data Ingestion
@@ -207,7 +195,7 @@ sim.topology ─┘
207195### 4. Topology Management
208196
209197```
210- User/API ──> PUT /api/topology ──> sim.topology (Kafka) ──> sim-worker
198+ User/Dashboard ──> PUT /api/topology ──> sim.topology (Kafka) ──> sim-worker
211199 │
212200 ├──> Update simulated topology
213201 ├──> Clear result cache
@@ -244,7 +232,7 @@ User/API ──> PUT /api/topology ──> sim.topology (Kafka) ──> sim-work
244232### Service Documentation
245233- [ dc-mock README] ( ../services/dc-mock/README.md ) - Datacenter mock producer
246234- [ sim-worker README] ( ../services/sim-worker/README.md ) - Simulation engine
247- - [ opendt-api README] ( ../services/opendt-api /README.md ) - API gateway
235+ - [ dashboard README] ( ../services/dashboard /README.md ) - Web dashboard and API
248236- [ kafka-init README] ( ../services/kafka-init/README.md ) - Kafka initialization
249237
250238### Concept Documentation
0 commit comments