Commit a93f5cd1 authored by Daniel Seybold's avatar Daniel Seybold
Browse files

applied several fixes to the readme

parent 9f02f723
......@@ -8,7 +8,7 @@ In order to achieve comparable results to the ones presented in the paper a VM w
| CPU cores | 8 |
| memory | >= 4GB |
| disk | 20GB |
| software | Docker, Docker-Compose |
| software | Docker |
| open ports | 8181 |
**Task 1:** Go to your Cloud provider and create a VM of the aforementioned configuration.
......@@ -16,16 +16,12 @@ In order to achieve comparable results to the ones presented in the paper a VM w
**Task 3:** Assign public IP to the VM. We denote this IP in the following as *WORKLOAD_API_IP*.
**Task 4:** Log into the VM, and install Docker and Docker-Compose.
**Task 4a:** Docker can be installed as described in: https://docs.docker.com/install/linux/docker-ce/ubuntu/.
**Task 4b:** Docker can be installed as described in: https://docs.docker.com/compose/install/.
Before starting the Workload-API the Mowgli framework needs to be installed.
#### Start Workload-API
Now, as we have the Mowgli Framework setup and running, we can start the Workload-API.
**Task 1:** Get the public IP this VM and export it via `export PUBLIC_IP=X.X.X.X`
**Task 1:** Log into the host, where the Workload-API is installed.
**Task 2:** Set the publicly available IP of the current workload-API host in the environment variable ```PUBLIC_IP```, e.g. by ```export PUBLIC_IP=x.x.x.x```.
**Task 2:** Get the public IP of the VM that hosts the Mowgli VM and export it via `export INFLUX_IP=X.X.X.X`
**Task 3:** Set the IP of the host, where the Mowgli framework is installed in the environment variable ```INFLUXDB_URL```, e.g. by ```export INFLUX_DB=x.x.x.x```.
**Task 3:** Now run the Workload-API (provided as Docker container) with the following command `docker run -d -p 8181:8181 -e PUBLIC_IP=$PUBLIC_IP -e INFLUXDB_URL=$INFLUX_IP:8086 -v /tmp:/opt/results -v /tmp:/var/log omi-registry.e-technik.uni-ulm.de/mowgli/workload-api:latest`
**Task 4:** Now run the Workload-API (provided as Docker container) with the following command ```docker run -d -p 8181:8181 -e PUBLIC_IP=X.X.X.X -e INFLUXDB_URL=X.X.X.X:8086 -v /tmp:/opt/results -v /tmp:/var/log omi-registry.e-technik.uni-ulm.de/mowgli/workload-api:latest`
\ No newline at end of file
......@@ -18,10 +18,11 @@ This guide consists of the following steps:
1. Install Mowgli
2. Prepare and register the target cloud in Mowgli
2. Prepare and register the target cloud in Mowgli
2.1. OpenStack
2.2. Amazon AWS EC2
2.2. Amazon AWS EC2
......@@ -62,8 +63,8 @@ Execute the following steps to deploy the Mowgli framework:
**Task 4:** create the folder for the Cloudiator data: ```sudo mkdir -p /var/lib/cloudiator/cloudiator-store/```
**Task 5:** checkout the repository which includes the docker-compose.yml: ```git clone https://omi-gitlab.e-technik.uni-ulm.de/mowgli/docker.git```
**Task 6:** create the .env file based on the env-template: ```cd docker && cp env-template .env```
**Task 7:** add the public IP of the host the .env
**Task 8 (optional):** In case the host is running in an enterprise network and requires certificates please check the [wiki](https://omi-gitlab.e-technik.uni-ulm.de/mowgli/getting-started/wikis/Add-Certificates)
**Task 7:** add the public IP of the host the .env
**Task 8 (optional):** In case the host is running in an enterprise network and requires certificates please check the [wiki](https://omi-gitlab.e-technik.uni-ulm.de/mowgli/getting-started/wikis/Add-Certificates)
**Task 9:** start the Mowgli services via: ```sudo docker-compose up -d```
**Task 10:** open your browser and check if the Mowgli framework started successfully at: `http://MOWGLI_HOST:8282` or `http://MOWGLI_HOST:8282/explorer`
......
Evaluating the performance (throughput,latency) of a single node DBMS cluster.
### Evaluating the performance (throughput,latency) of a single node DBMS
#### Evaluation Scenario Workflow
------
The evaluation scenario execution comprises the following steps:
1. deploy *DBMS_X* on cloud resources *CR_Y*
2. execute workload *W_Z*
3. process performance and system metrics
#### Supported DBMS
......@@ -22,8 +18,8 @@ The evaluation scenario execution comprises the following steps:
#### Supported Workloads
#### YCSB
- Sensor Storage (YCSB write only)
- YCSB (multi-phase: write + CRUD phase)
- YCSB Load (write only)
- YCSB Multi-phase: (write phase + CRUD phase)
##### Important YCSB Parameters
- *maxExecutionTime* defines the runtime of the evaluation in seconds
......@@ -48,4 +44,76 @@ The evaluation scenario execution comprises the following steps:
#### Examples
For getting started please have a look at the performance [example templates](https://omi-gitlab.e-technik.uni-ulm.de/mowgli/getting-started/tree/master/examples/performance)
\ No newline at end of file
For getting started please have a look at the performance [example templates](../examples/performance)
#### Evaluation Scenario Workflow
The evaluation scenario execution comprises the following steps:
1. deploy *DBMS_X* on cloud resources *CR_Y*
1.1 select an example template from the [performance examples](../examples/performance)
1.2 get a VM template as described here and replace the TODOs for the resource object
1.3 replace the TODO for the workload instance with the public IP of the prepared Workload-API instance (e.g. the Mowgli VM or a separate VM if applicable). You can add multiple IPs in a comma separated list if you want to use multiple Workload-API instances
2. execute workload *W_Z*
2.1 Open http://MOWGLI_IP:8282/explorer/#!/performance/scenarioSensorStorageMultiPhaseSinglePost for the **YCSB Load Scenario** or http://134.60.244.104:8282/explorer/#!/performance/scenarioSensorStorageSinglePost for the **YCSB Multi Phase Scenario**
2.2 Copy the prepared scenario template into the body form
2.3 fill in the remaining fields
2.4 execute the scneario by clicking on the **TRY** button
3. monitor the evaluation process
3.1 check the evaluation-orchestrator logs via the Portainer dashboard: http://MOWGLi_IP:9001/#/containers , user: admin, PW: mowgli19
3.2 follow the system metrics via the Chronograf dashboard: http://MOWGLi_IP:8888
4. Check the results after the evaluation has finished under `/opt/evaluation-results` as described in the following.
#### Evaluation Results
All evaluation results are stored to the file system of the host that runs the Mowgli Framework in the following structure
```
opt
|_evaluation-results
|_SCENARIO
|_CLOUD
|_DBMS
|_CONFIG
|_RUN_X
|_data # contains raw evaluation data
|_monitoring # contains system usage plots
|_specs # contains the applied templates
|_taskLogs # additional logs
|_timeseries # throughput plot of the evaluation run
|_plots # contains aggregated evaluation data over all runs (manual processing steps required)
```
##### Workload Metrics
The `data` folder contains the raw evaluation results of the selected workload
**YCSB**
The `data` folder contains the raw evaluation results of the load phase in the load.txt and the CRUD (or transaction phase in YCSB context) in the transaction phase.
By default the plots for throughput and latency are generated under the timeseries folder.
In addition system metric plots of the Workload-API instances and the DBMS nodes are available under the monitoring folder.
**TPC-C**
The `data` folder contains the raw evaluation results.
Currently no advanced plotting support is available.
In addition system metric plots of the Workload-API instances and the DBMS nodes are available under the monitoring folder.
\ No newline at end of file
......@@ -47,14 +47,13 @@ opt
|_specs # contains the applied templates
|_taskLogs # additional logs
|_timeseries # throughput plot of the evaluation run
|_plots # contains aggregated evaluation data (manual processing steps required)
|_plots # contains aggregated evaluation data over all runs (manual processing steps required)
```
The `data` folder contains the raw evaluation results of the load phase in the load.txt and the CRUD (or transaction phase in YCSB context) in the transaction phase.
By default the plots for throughput and latency are generated under the timeseries folder.
In addition system metric plots of the Workload-API instances and the DBMS nodes are available under the monitoring folder.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment