From cc0fc63ad732cb9fd8866bbad765f57e917f1dd7 Mon Sep 17 00:00:00 2001 From: Leon Overweel Date: Sun, 12 Mar 2017 17:25:22 +0100 Subject: Add component diagram to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2da13fe9..445a988b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ OpenDC consists of four components: a C++ simulator, a SQLite database, a Python Flask web server, and a TypeScript frontend. +![opendc-component-diagram](https://raw.githubusercontent.com/tudelft-atlarge/opendc/master/images/opendc-component-diagram.png) + On the frontend, users can construct a topology by specifying a datacenter's rooms, racks and machines, and create experiments to see how a workload trace runs on that topology. The frontend communicates with the web server over SocketIO, through a custom REST request/response layer. For example, the frontend might make a `GET` request to `/api/v1/users/{userId}`, but this request is completed via SocketIO, not plain HTTP requests. The (Swagger/ OpenAPI compliant) API spec specifies what requests the frontend can make to the web server. To view this specification, go to the [Swagger UI](http://petstore.swagger.io/) and "Explore" [opendc-api-spec.json](https://raw.githubusercontent.com/tudelft-atlarge/opendc/master/opendc-api-spec.json). -- cgit v1.2.3