diff options
| author | Leon Overweel <l.overweel@gmail.com> | 2017-03-12 17:09:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-12 17:09:36 +0100 |
| commit | 027878f50b6a9402afcf57b79c9ea45233d724e7 (patch) | |
| tree | f1c8d8c2a5c8d114943282d941ab275387b8746a | |
| parent | 7cc9c9d803ece56925352b257daabea9df25cabb (diff) | |
Update experiment queuing process in README
Also add some small fixes.
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -6,11 +6,11 @@ OpenDC consists of four components: a C++ simulator, a SQLite database, a Python 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 specification 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). +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). -The web server receives these API requests and processes them in the SQLite database. When the frontend requests to run a new experiment, the web server adds a row to the `queued_experiments` table in the database. +The web server receives API requests and processes them in the SQLite database. When the frontend requests to run a new experiment, the web server adds it to the `experiments` table in the database and sets is `state` as `QUEUED`. -The simulator monitors this `queued_experiments` table, and simulates experiments as they are submitted. It writes the resulting `machine_states` and `task_states` to the database, which the frontend can then again retrieve via the web server. +The simulator monitors the database for `QUEUED` experiments, and simulates them as they are submitted. It writes the resulting `machine_states` and `task_states` to the database, which the frontend can then again retrieve via the web server. ## Setup @@ -46,6 +46,6 @@ docker build -t="opendc" . # Start a container with the image docker run -d --name opendc -p 8081:8081 -e 'SERVER_URL=http://localhost:8081' -e 'OAUTH_CLIENT_ID=your-google-oauth-client-id' -e 'OAUTH_CLIENT_SECRET=your-google-oauth-secret' opendc - -# Wait a few seconds and open http://localhost:8081 in your browser ``` + +Wait a few seconds and open `http://localhost:8081` in your browser to use OpenDC. |