aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2016-11-16 17:45:55 -0800
committerJakob Odersky <jakob@odersky.com>2016-11-16 17:46:43 -0800
commitae1eaeffae896d3f3e80e66a708bfdeeba4fbe33 (patch)
treeb4d3ab4c34979e8c06841585cd81a1db3c76cb60
parentfcc27bc501a00f4d5b723e06f0bac99f60e8ed66 (diff)
downloadvcluster-ae1eaeffae896d3f3e80e66a708bfdeeba4fbe33.tar.gz
vcluster-ae1eaeffae896d3f3e80e66a708bfdeeba4fbe33.tar.bz2
vcluster-ae1eaeffae896d3f3e80e66a708bfdeeba4fbe33.zip
Add readmeHEADmaster
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4c8eec4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# vcluster
+
+Script to manage a local, docker-based, Apache Spark cluster.
+
+## Requirements
+
+- A copy of Spark's source code
+- docker
+
+## Installation
+Download the script and put it in your PATH.
+
+`curl https://raw.githubusercontent.com/jodersky/vcluster/master/vcluster -o ~/bin/vcluster && chmod 0755 ~/bin/vcluster`
+
+## Usage
+
+1. Create docker image from Spark's source
+
+ vcluster init <path to spark's source>
+
+2. Spin up a "local cluster", consisting of several containers
+
+ vcluster start <number of workers, default 5>
+
+3. Start spark-shell in a container
+
+ vcluster shell
+
+4. Show the status of the cluster
+
+ vcluster list
+
+5. Shut down the cluster
+
+ vcluster stop