Skip to content

Commit

Permalink
update README: add screenshots and rearrange text
Browse files Browse the repository at this point in the history
  • Loading branch information
arcolife committed Sep 21, 2015
1 parent 0940dce commit 930c275
Showing 1 changed file with 56 additions and 52 deletions.
108 changes: 56 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,11 @@
dockerComp
==========

- Youtube Video Explaining this project:

[![Here's a video for DockerComp](http://img.youtube.com/vi/lIp2nrOnKFs/0.jpg)](http://www.youtube.com/watch?v=lIp2nrOnKFs)

- [Click here](http://asciinema.org/a/13557) for Screencast for running just one script on client side.


**NOTES**

- Demo link to be updated soon.

- In case you're curious how to go about running this from client side:

- So once the server is up and running, all one has to do is download and run installer.sh

- Docker Image: ``` $ docker pull arcolife/docker_comp ``` (will be kept updated)


**GOAL**

To setup a basic prototype for distributed computing in docker. If time permits, add a complex
computing task.

**FAQ**

Refer to Wiki .. [click Here!](https://github.com/arcolife/dockerComp/wiki).

**INTRODUCTION**

For the purpose of Distributed (Scientific) Computing, scientists across the world have been
Expand All @@ -42,35 +20,17 @@ overhead of starting up, as compared to Docker containers. Moreover, we don't ev
to explain the difference between running more than one VM on a HostOS compared to
running multiple docker containers on that same machine! See the point? :)

References:

- http://www.rightscale.com/blog/sites/default/files/docker-containers-vms.png
- http://en.wikipedia.org/wiki/Docker_%28software%29#cite_ref-3

So, just to give you a context of this whole project, take a look at this project called
[CernVM](http://cernvm.cern.ch/portal/). This is a really awesome project, developed to
help collect CERN's LHC data and perform data analysis on a volunteer's computer or even on
commercial clouds. Just imagine if the whole process of using VM was dockerized!


**FEATURES**

- Can be used for:
- Image Processing
- General Data Analysis
- Scientific Computing
- CrowdSourcing projects.


**FUTURE GOALS**

- Make this a pluggable dockerized distributed computing tool, where you just have to include
a compution task (say, map-reduce) and make it send data to clients. The app should be able
to handle the rest.
- Youtube Video Explaining this project:

[![Here's a video for DockerComp](http://img.youtube.com/vi/lIp2nrOnKFs/0.jpg)](http://www.youtube.com/watch?v=lIp2nrOnKFs)

- Benchmark results and compare with existing methodologies.
[![Here's a current screenshot of installation and first run](https://arcolife.files.wordpress.com/2015/09/installation-and-first-contact.png)](https://arcolife.wordpress.com/2015/09/21/docker-global-hack-day-mania-dockercomp/)

[![Here's a current screenshot of client logs when server goes down: constant polling](https://arcolife.files.wordpress.com/2015/09/communicatio-and-outage.png)](https://arcolife.wordpress.com/2015/09/21/docker-global-hack-day-mania-dockercomp/)

- [Click here](http://asciinema.org/a/13557) for Screencast for running just one script on client side.

**STEPS**
**INSTALLATION**

- Server side (src/server/):

Expand All @@ -94,6 +54,11 @@ commercial clouds. Just imagine if the whole process of using VM was dockerized!

- Client side (src/client/):

- Note: For server side deployement (i.e., the server that basically is responsible for distributing data
to clients), It has to be deployed somewhere and it's IP has to be provided in your `configuration` file.
And then you may distribute the script `installer.sh` alongwith the `configuration` to the clients.


- Download [This Script](https://github.com/arcolife/dockerComp/raw/master/installer.sh) and run

```$ ./installer.sh``` [configure your Server location for this script, as under `$DC_HOST` & `$DC_PORT` ]
Expand All @@ -107,9 +72,48 @@ included in the source code of this project root.

Cheers! :)

Note: For server side deployement (i.e., the server that basically is responsible for distributing data
to clients), It has to be deployed somewhere and it's IP has to be provided in your installer.sh.
And then you may distribute the script to the clients.
**NOTES**

- Demo link to be updated soon.

- In case you're curious how to go about running this from client side:

- So once the server is up and running, all one has to do is download and run installer.sh

- Docker Image: ``` $ docker pull arcolife/docker_comp ``` (will be kept updated)


**FAQ**

Refer to Wiki .. [click Here!](https://github.com/arcolife/dockerComp/wiki).

References:

- http://www.rightscale.com/blog/sites/default/files/docker-containers-vms.png
- http://en.wikipedia.org/wiki/Docker_%28software%29#cite_ref-3

So, just to give you a context of this whole project, take a look at this project called
[CernVM](http://cernvm.cern.ch/portal/). This is a really awesome project, developed to
help collect CERN's LHC data and perform data analysis on a volunteer's computer or even on
commercial clouds. Just imagine if the whole process of using VM was dockerized!


**FEATURES**

- Can be used for:
- Image Processing
- General Data Analysis
- Scientific Computing
- CrowdSourcing projects.


**FUTURE GOALS**

- Make this a pluggable dockerized distributed computing tool, where you just have to include
a compution task (say, map-reduce) and make it send data to clients. The app should be able
to handle the rest.

- Benchmark results and compare with existing methodologies.

**TESTS**

Expand Down

0 comments on commit 930c275

Please sign in to comment.