aboutsummaryrefslogtreecommitdiff
path: root/bigtop-deploy
diff options
context:
space:
mode:
authorjayunit100 <jayunit100@gmail.com>2014-05-05 18:31:37 -0500
committerjayunit100 <jayunit100@gmail.com>2014-05-06 09:29:54 -0500
commit59d192b9f9324df000cc54ab636e9a75a466b80c (patch)
tree3df6a65461ee936ca4f718d654abc63c293ad34e /bigtop-deploy
parent221ac5d94ec1f6bc978bc10c43f668615da4c1ae (diff)
BIGTOP-1296 : Fix permission and Update README for vagrant-puppet recipe
Signed-off-by: jayunit100 <jayunit100@gmail.com>
Diffstat (limited to 'bigtop-deploy')
-rw-r--r--bigtop-deploy/vm/vagrant-puppet/README.md61
-rwxr-xr-x[-rw-r--r--]bigtop-deploy/vm/vagrant-puppet/startup.sh0
2 files changed, 40 insertions, 21 deletions
diff --git a/bigtop-deploy/vm/vagrant-puppet/README.md b/bigtop-deploy/vm/vagrant-puppet/README.md
index ce7fc8e9..bebf7ed9 100644
--- a/bigtop-deploy/vm/vagrant-puppet/README.md
+++ b/bigtop-deploy/vm/vagrant-puppet/README.md
@@ -15,38 +15,57 @@
------------------------------------------------------------------------------------------------------------------------------------------------------
-#Deploy Apache Hadoop VM(s) on top of vagrant boxes using puppet
+#BigTop VM provisioner
-##Preparation
-* You need to install [vagrant-hostmanager plugin](https://github.com/smdahlen/vagrant-hostmanager) to better manage `/etc/hosts`
-<pre>
-$ vagrant plugin install vagrant-hostmanager
-</pre>
+## Overview
-##Usage
+The startup.sh script runs one of 3 vagrant templates, and creates a bigtop virtual hadoop cluster for you, by
+pulling from existing publishing bigtop repositories. This cluster can be used:
-* To provision a 3 node Apache Hadoop cluster on top of vagrant boxes
-<pre>
-$ ./startup.sh --cluster
-</pre>
+- to test bigtop smoke tests
+- to test bigtop puppet recipes
-* See options with -h specified
-<pre>
+Eventually, we may also add ability to build AND provision bigtop in a vagrant recipe, which would essentially
+give full validation of the BigTop stack.
+
+## USAGE
+
+1) Install [vagrant-hostmanager plugin](https://github.com/smdahlen/vagrant-hostmanager) to better manage `/etc/hosts`
+
+```
+vagrant plugin install vagrant-hostmanager
+```
+
+2) To provision a 3 node Apache Hadoop cluster on top of vagrant boxes
+
+```
+./startup.sh --cluster
+```
+
+3) See options with -h specified
+
+```
$ ./startup.sh -h
-usage: startup.sh [options]
+
+ usage: startup.sh [options]
+
-s, --standalone deploy a standalone hadoop vm
+
-c, --cluster deploy a 3 node hadoop cluster
+
-h, --help
-</pre>
+```
+
+##Example:
-* Run hbase-test.sh to evaluate the deployment.
+4) Run hbase-test.sh to evaluate the deployment.
##Configure Apache Hadoop ecosystem components
-* Choose the ecosystem you want to be deployed by modify components in provision.sh:
+* Choose the ecosystem you want to be deployed by modify components in provision.sh.
-<pre>
+```
components,hadoop,hbase,...
-</pre>
+```
- By default, Apache Hadoop and Apache HBase will be installed.
- See `bigtop-deploy/puppet/config/site.csv.example` for more details.
+By default, Apache Hadoop and Apache HBase will be installed.
+See `bigtop-deploy/puppet/config/site.csv.example` for more details.
diff --git a/bigtop-deploy/vm/vagrant-puppet/startup.sh b/bigtop-deploy/vm/vagrant-puppet/startup.sh
index 34b52ad2..34b52ad2 100644..100755
--- a/bigtop-deploy/vm/vagrant-puppet/startup.sh
+++ b/bigtop-deploy/vm/vagrant-puppet/startup.sh