Skip to content

Commit

Permalink
graph-analytics and spark-base README files are fixed.
Browse files Browse the repository at this point in the history
  • Loading branch information
neo-apz committed Jan 16, 2016
1 parent 4a55615 commit 8d1a7e1
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 21 deletions.
33 changes: 18 additions & 15 deletions benchmarks/graph-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ Supported tags and their respective `Dockerfile` links:
- [`spark-worker`][sparkworkerdocker] This builds an image for the Spark worker node. You may spawn several workers.
- [`spark-client`][sparkclientdocker] This builds an image with the Spark client node. The client is used to start the benchmark.

These images are automatically built using the mentioned Dockerfiles available on [`CloudSuite-EPFL/GraphAnalytics`][repo] and [`CloudSuite-EPFL/spark-base`][sparkrepo].
These images are automatically built using the mentioned Dockerfiles available on [`ParsaLab/cloudsuite`][repo].

### Starting the volume images ###

The first step is to create the volume images that contain the binaries and the dataset of the Graph Analytics benchmark. First `pull` the volume images, using the following command:

$ docker pull cloudsuite/GraphAnalytics:data
$ docker pull cloudsuite/GraphAnalytics:benchmark
$ docker pull cloudsuite/graph-analytics:data
$ docker pull cloudsuite/graph-analytics:benchmark

The following command will start the volume images, making both the data and the binaries available for other docker images on the host:

$ docker create --name data cloudsuite/GraphAnalytics:data
$ docker create --name bench cloudsuite/GraphAnalytics:benchmark
$ docker create --name data cloudsuite/graph-analytics:data
$ docker create --name bench cloudsuite/graph-analytics:benchmark

### Starting the master node ###

Expand Down Expand Up @@ -71,13 +71,16 @@ To run the benchmark from the interactive container, use the following command:

$ bash /benchmark/graph_analytics/run_benchmark.sh

[benchmarkdocker]: https://github.com/CloudSuite-EPFL/GraphAnalytics/blob/master/benchmarks/Dockerfile "Benchmark volume Dockerfile"
[datadocker]: https://github.com/CloudSuite-EPFL/GraphAnalytics/blob/master/data/Dockerfile "Data volume Dockerfile"
[sparkmasterdocker]: https://github.com/CloudSuite-EPFL/spark-base/blob/master/spark-master/Dockerfile "Spark Master Node Dockerfile"
[sparkworkerdocker]: https://github.com/CloudSuite-EPFL/spark-base/blob/master/spark-worker/Dockerfile "Spark Worker Dockerfile"
[sparkclientdocker]: https://github.com/CloudSuite-EPFL/spark-base/blob/master/spark-client/Dockerfile "Spark Client Dockerfile"
[repo]: https://github.com/CloudSuite-EPFL/GraphAnalytics "Graph Analytics GitHub Repo"
[sparkrepo]: https://github.com/CloudSuite-EPFL/spark-base "Spark Base GitHub Repo"
[dhrepo]: https://hub.docker.com/r/cloudsuite/graphanalytics/ "DockerHub Page"
[dhpulls]: https://img.shields.io/docker/pulls/cloudsuite/graphanalytics.svg "Go to DockerHub Page"
[dhstars]: https://img.shields.io/docker/stars/cloudsuite/graphanalytics.svg "Go to DockerHub Page"
[benchmarkdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/graph-analytics/benchmark/Dockerfile "Benchmark volume Dockerfile"
[datadocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/graph-analytics/data/Dockerfile "Data volume Dockerfile"
[sparkmasterdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/spark-base/spark-master/Dockerfile "Spark Master Node Dockerfile"
[sparkworkerdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/spark-base/spark-worker/Dockerfile "Spark Worker Dockerfile"
[sparkclientdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/spark-base/spark-client/Dockerfile "Spark Client Dockerfile"
[repo]: https://github.com/ParsaLab/cloudsuite "GitHub Repo"
[dhrepo]: https://hub.docker.com/r/cloudsuite/graph-analytics/ "DockerHub Page"
[dhpulls]: https://img.shields.io/docker/pulls/cloudsuite/graph-analytics.svg "Go to DockerHub Page"
[dhstars]: https://img.shields.io/docker/stars/cloudsuite/graph-analytics.svg "Go to DockerHub Page"

[serverdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/data-caching/server/Dockerfile "Server Dockerfile"

[clientdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/data-caching/client/Dockerfile "Client Dockerfile"
21 changes: 15 additions & 6 deletions benchmarks/spark-base/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Spark Base Image for Cloudsuite
==========

[![Pulls on DockerHub][dhpulls]][dhrepo]
[![Stars on DockerHub][dhstars]][dhrepo]

This repository contains the docker image with a base Spark image for the CloudSuite workloads.

## Building the images ##
Expand All @@ -11,7 +15,7 @@ Supported tags and their respective `Dockerfile` links:
- [`spark-worker`][sparkworkerdocker] This builds an image with the Spark worker node. You may spawn clusters of several workers.
- [`spark-client`][sparkclientdocker] This builds an image with the Spark client node. The client is used to start the benchmark.

These images are automatically built using the mentioned Dockerfiles available on [`CloudSuite-EPFL/spark-base`][sparkrepo].
These images are automatically built using the mentioned Dockerfiles available on [`ParsaLab/cloudsuite`][repo].

### Starting the volume images ###

Expand All @@ -21,7 +25,7 @@ The `data` container contains the dataset that is necessary for the benchmark to

The `bench` container hosts the Java Spark binaries and scripts necessary to run the benchmark. The client `Entrypoint` script looks for a folder with the same name as the command line argument passed to the `docker run` command and runs the `run_benchmark.sh` script in that folder.

Assuming all the volume images are pulled, the following command will start the volume images, making both the data and the binaries avaliable for other docker images in the host:
Assuming all the volume images are pulled, the following command will start the volume images, making both the data and the binaries available for other docker images in the host:

$ docker create --name data [data-volume-image-tag]
$ docker create --name bench [binary-volume-image-tag]
Expand Down Expand Up @@ -64,7 +68,12 @@ To run the benchmark from the interactive container, use the following command:

$ bash /benchmark/[benchmark-name]/run_benchmark.sh

[sparkmasterdocker]: https://github.com/CloudSuite-EPFL/spark-base/blob/master/spark-master/Dockerfile "Spark Master Node Dockerfile"
[sparkworkerdocker]: https://github.com/CloudSuite-EPFL/spark-base/blob/master/spark-worker/Dockerfile "Spark Worker Dockerfile"
[sparkclientdocker]: https://github.com/CloudSuite-EPFL/spark-base/blob/master/spark-client/Dockerfile "Spark Client Dockerfile"
[sparkrepo]: https://github.com/CloudSuite-EPFL/spark-base "Spark Base GitHub Repo"
[sparkmasterdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/spark-base/spark-master/Dockerfile "Spark Master Node Dockerfile"
[sparkworkerdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/spark-base/spark-worker/Dockerfile "Spark Worker Dockerfile"
[sparkclientdocker]: https://github.com/ParsaLab/cloudsuite/blob/master/benchmarks/spark-base/spark-client/Dockerfile "Spark Client Dockerfile"

[repo]: https://github.com/ParsaLab/cloudsuite/ "GitHub Repo"

[dhrepo]: https://hub.docker.com/r/cloudsuite/spark-base/ "DockerHub Page"
[dhpulls]: https://img.shields.io/docker/pulls/cloudsuite/spark-base.svg "Go to DockerHub Page"
[dhstars]: https://img.shields.io/docker/stars/cloudsuite/spark-base.svg "Go to DockerHub Page"

0 comments on commit 8d1a7e1

Please sign in to comment.