diff options
| author | Leon Overweel <l.overweel@gmail.com> | 2017-03-12 17:25:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-12 17:25:22 +0100 |
| commit | cc0fc63ad732cb9fd8866bbad765f57e917f1dd7 (patch) | |
| tree | 37aadca57a651b016ccaadd12107eb094886f9b8 /README.md | |
| parent | c9e18317fe603f4f9e903e1cbf8568e403f22afa (diff) | |
Add component diagram to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 2 |
1 files changed, 2 insertions, 0 deletions
@@ -4,6 +4,8 @@ OpenDC consists of four components: a C++ simulator, a SQLite database, a Python Flask web server, and a TypeScript frontend. + + 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). |