summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorgios Andreadis <info@gandreadis.com>2020-06-30 14:25:01 +0200
committerFabian Mastenbroek <mail.fabianm@gmail.com>2020-08-24 19:43:17 +0200
commit4c8a21da65e9a02437c03dcdb8aab6b054b651b0 (patch)
treed47b9bee07dc426e8a70ec9ab215ed59ec2ef599
parent2662c23a63c152946bb6b258bac0221ae281ae47 (diff)
Consistencify structure
-rw-r--r--README.md8
-rw-r--r--frontend/.editorconfig15
-rw-r--r--frontend/README.md2
-rw-r--r--misc/artwork/logo.png (renamed from images/logo.png)bin2825 -> 2825 bytes
-rw-r--r--misc/artwork/opendc-component-diagram.png (renamed from images/opendc-component-diagram.png)bin11875 -> 11875 bytes
-rw-r--r--misc/artwork/opendc-frontend-construction.png (renamed from images/opendc-frontend-construction.PNG)bin76461 -> 76461 bytes
-rw-r--r--misc/artwork/opendc-frontend-simulation-zoom.png (renamed from images/opendc-frontend-simulation-zoom.PNG)bin100583 -> 100583 bytes
-rw-r--r--misc/artwork/opendc-frontend-simulation.png (renamed from images/opendc-frontend-simulation.PNG)bin96351 -> 96351 bytes
-rw-r--r--simulator/README.md2
-rw-r--r--simulator/misc/artwork/logo.pngbin2825 -> 0 bytes
-rw-r--r--web-server/README.md8
-rw-r--r--web-server/images/logo.pngbin2825 -> 0 bytes
-rw-r--r--web-server/misc/artwork/opendc-web-server-component-diagram.png (renamed from web-server/images/opendc-web-server-component-diagram.png)bin90161 -> 90161 bytes
13 files changed, 10 insertions, 25 deletions
diff --git a/README.md b/README.md
index 2bb734e8..6a5a7f9c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<h1 align="center">
- <img src="images/logo.png" width="100" alt="OpenDC">
+ <img src="misc/artwork/logo.png" width="100" alt="OpenDC">
<br>
OpenDC
</h1>
@@ -11,11 +11,11 @@
OpenDC is an open-source simulator for datacenters aimed at both research and education.
-![opendc-frontend-construction](https://raw.githubusercontent.com/tudelft-atlarge/opendc/master/images/opendc-frontend-construction.PNG)
+![opendc-frontend-construction](misc/artwork/opendc-frontend-construction.png)
Users can construct datacenters (see above) and define experiments to see how these datacenters perform under different workloads and schedulers (see below).
-![opendc-frontend-simulation](https://raw.githubusercontent.com/tudelft-atlarge/opendc/master/images/opendc-frontend-simulation.PNG)
+![opendc-frontend-simulation](misc/artwork/opendc-frontend-simulation.png)
The simulator is accessible both as a ready-to-use website hosted by Delft University of Technology at [opendc.org](http://opendc.org), and as source code that users can run locally on their own machine.
@@ -26,7 +26,7 @@ OpenDC is a project by the [@Large Research Group](http://atlarge-research.com).
OpenDC consists of four components: a Kotlin simulator, a MariaDB database, a Python Flask web server, and a React.js frontend.
<p align="center">
- <img src="https://raw.githubusercontent.com/tudelft-atlarge/opendc/master/images/opendc-component-diagram.png" alt="OpenDC Component Diagram">
+ <img src="misc/artwork/opendc-component-diagram.png" alt="OpenDC Component Diagram">
</p>
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.
diff --git a/frontend/.editorconfig b/frontend/.editorconfig
deleted file mode 100644
index 823e6853..00000000
--- a/frontend/.editorconfig
+++ /dev/null
@@ -1,15 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
diff --git a/frontend/README.md b/frontend/README.md
index 44858b69..527abd28 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -1,5 +1,5 @@
<h1 align="center">
- <img src="public/img/logo.png" width="100" alt="OpenDC">
+ <img src="../misc/artwork/logo.png" width="100" alt="OpenDC">
<br>
OpenDC Frontend
</h1>
diff --git a/images/logo.png b/misc/artwork/logo.png
index d743038b..d743038b 100644
--- a/images/logo.png
+++ b/misc/artwork/logo.png
Binary files differ
diff --git a/images/opendc-component-diagram.png b/misc/artwork/opendc-component-diagram.png
index 4aa535b9..4aa535b9 100644
--- a/images/opendc-component-diagram.png
+++ b/misc/artwork/opendc-component-diagram.png
Binary files differ
diff --git a/images/opendc-frontend-construction.PNG b/misc/artwork/opendc-frontend-construction.png
index 223e8d48..223e8d48 100644
--- a/images/opendc-frontend-construction.PNG
+++ b/misc/artwork/opendc-frontend-construction.png
Binary files differ
diff --git a/images/opendc-frontend-simulation-zoom.PNG b/misc/artwork/opendc-frontend-simulation-zoom.png
index d7744926..d7744926 100644
--- a/images/opendc-frontend-simulation-zoom.PNG
+++ b/misc/artwork/opendc-frontend-simulation-zoom.png
Binary files differ
diff --git a/images/opendc-frontend-simulation.PNG b/misc/artwork/opendc-frontend-simulation.png
index bbf4cbd6..bbf4cbd6 100644
--- a/images/opendc-frontend-simulation.PNG
+++ b/misc/artwork/opendc-frontend-simulation.png
Binary files differ
diff --git a/simulator/README.md b/simulator/README.md
index 1bc866cf..84b40a54 100644
--- a/simulator/README.md
+++ b/simulator/README.md
@@ -1,6 +1,6 @@
<h1 align="center">
<a href="http://opendc.org/">
- <img src="misc/artwork/logo.png" width="100" alt="OpenDC">
+ <img src="../misc/artwork/logo.png" width="100" alt="OpenDC">
</a>
<br>
OpenDC Simulator
diff --git a/simulator/misc/artwork/logo.png b/simulator/misc/artwork/logo.png
deleted file mode 100644
index d743038b..00000000
--- a/simulator/misc/artwork/logo.png
+++ /dev/null
Binary files differ
diff --git a/web-server/README.md b/web-server/README.md
index 04146f59..6c07c29f 100644
--- a/web-server/README.md
+++ b/web-server/README.md
@@ -1,5 +1,5 @@
<h1 align="center">
- <img src="images/logo.png" width="100" alt="OpenDC">
+ <img src="../misc/artwork/logo.png" width="100" alt="OpenDC">
<br>
OpenDC Web Server
</h1>
@@ -7,7 +7,7 @@
Collaborative Datacenter Simulation and Exploration for Everybody
</p>
-The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](https://github.com/atlarge-research/opendc/blob/master/opendc-api-spec.json).
+The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](../opendc-api-spec.yml).
This document explains a high-level view of the web server architecture ([jump](#architecture)), and describes how to set up the web server for local development ([jump](#setup-for-local-development)).
@@ -15,7 +15,7 @@ This document explains a high-level view of the web server architecture ([jump](
The following diagram shows a high-level view of the architecture of the OpenDC web server. Squared-off colored boxes indicate packages (colors become more saturated as packages are nested); rounded-off boxes indicate individual components; dotted lines indicate control flow; and solid lines indicate data flow.
-![OpenDC Web Server Component Diagram](https://raw.githubusercontent.com/atlarge-research/opendc-web-server/master/images/opendc-web-server-component-diagram.png)
+![OpenDC Web Server Component Diagram](misc/artwork/opendc-web-server-component-diagram.png)
The OpenDC API is implemented by the `Main Server Loop`, which is the only component in the base package.
@@ -23,7 +23,7 @@ The OpenDC API is implemented by the `Main Server Loop`, which is the only compo
The `Util` package handles several miscellaneous tasks:
-* `REST`: Parses SockerIO messages into `Request` objects, and calls the appropriate `API` endpoint to get a `Response` object to return to the `Main Server Loop`.
+* `REST`: Parses SocketIO messages into `Request` objects, and calls the appropriate `API` endpoint to get a `Response` object to return to the `Main Server Loop`.
* `Param Checker`: Recursively checks whether required `Request` parameters are present and correctly typed.
* `Exceptions`: Holds definitions for exceptions used throughout the web server.
* `Database API`: Wraps SQLite functionality used by `Models` to read themselves from/ write themselves into the database.
diff --git a/web-server/images/logo.png b/web-server/images/logo.png
deleted file mode 100644
index d743038b..00000000
--- a/web-server/images/logo.png
+++ /dev/null
Binary files differ
diff --git a/web-server/images/opendc-web-server-component-diagram.png b/web-server/misc/artwork/opendc-web-server-component-diagram.png
index 91b26006..91b26006 100644
--- a/web-server/images/opendc-web-server-component-diagram.png
+++ b/web-server/misc/artwork/opendc-web-server-component-diagram.png
Binary files differ