You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2015/11/09 13:23:53 UTC

incubator-zeppelin git commit: expanded build instructions to describe pyspark, and maven + node.js requirements

Repository: incubator-zeppelin
Updated Branches:
  refs/heads/branch-0.5.5 0af2ea047 -> 197e339d2


expanded build instructions to describe pyspark, and maven + node.js requirements

Author: Jeff Steinmetz <je...@gmail.com>

Closes #405 from jeffsteinmetz/branch-0.5.5 and squashes the following commits:

d59230d [Jeff Steinmetz] use maven 3.3 link in setup example.  old links outdated
68cb04b [Jeff Steinmetz] maven install via apt-get clobbers the openjdk-7 install, and installs java6.  It also installs an older maven version.  Update ubuntu install example.
e457745 [Jeff Steinmetz] expanded build instructions to include pyspark, and clarified maven and node.js requirements
27e7930 [Jeff Steinmetz] expanded build instructions to include pyspark, and clarified maven and node.js requirements
1015f86 [Jeff Steinmetz] expanded build instructions to include pyspark, and clarified maven and node.js requirements
9617c01 [Jeff Steinmetz] expanded build instructions to include pyspark, and clarified maven and node.js requirements


Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/197e339d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/197e339d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/197e339d

Branch: refs/heads/branch-0.5.5
Commit: 197e339d204f77a72a67f8f6033f103d95db338f
Parents: 0af2ea0
Author: Jeff Steinmetz <je...@gmail.com>
Authored: Sat Nov 7 21:24:53 2015 -0800
Committer: Lee moon soo <mo...@apache.org>
Committed: Mon Nov 9 21:23:58 2015 +0900

----------------------------------------------------------------------
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 49 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/197e339d/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index b2beaa4..ff58299 100644
--- a/README.md
+++ b/README.md
@@ -27,75 +27,112 @@ To know more about Zeppelin, visit our web site [http://zeppelin.incubator.apach
 ### Before Build
 If you don't have requirements prepared, install it. 
 (The installation method may vary according to your environment, example is for Ubuntu.)
+
 ```
 sudo apt-get update
-sudo apt-get install openjdk-7-jdk
 sudo apt-get install git
-sudo apt-get install maven
+sudo apt-get install openjdk-7-jdk
 sudo apt-get install npm
 sudo apt-get install libfontconfig
+
+# install maven
+wget http://www.eu.apache.org/dist/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
+sudo tar -zxf apache-maven-3.3.3-bin.tar.gz -C /usr/local/
+sudo ln -s /usr/local/apache-maven-3.3.3/bin/mvn /usr/local/bin/mvn
 ```
 
+_Notes:_ 
+ - Ensure node is installed by running `node --version`  
+ - Ensure maven is running version 3.1.x or higher with `mvn -version`
+
 ### Build
-If you want to build Zeppelin from the source, please first clone this repository. And then:
+If you want to build Zeppelin from the source, please first clone this repository, then:
+
 ```
 mvn clean package -DskipTests
 ```
 
-Build with specific Spark version
+To build with a specific Spark version, Hadoop version or specific features, define one or more of the `spark`, `pyspark`, `hadoop` and `yarn` profiles, such as:
+
+```
+-Pspark-1.5   [Version to run in local spark mode]
+-Ppyspark     [optional: enable PYTHON support in spark via the %pyspark interpreter]
+-Pyarn        [optional: enable YARN support]
+-Dhadoop.version=2.2.0  [hadoop distribution]
+-Phadoop-2.2            [hadoop version]
+```
+
+Currently, final/full distributions run with:
+
+```
+mvn clean package -Pspark-1.5 -Phadoop-2.4 -Pyarn -Ppyspark
+```
 
 Spark 1.5.x
+
 ```
 mvn clean package -Pspark-1.5 -Dhadoop.version=2.2.0 -Phadoop-2.2 -DskipTests
 ```
 Spark 1.4.x
+
 ```
 mvn clean package -Pspark-1.4 -Dhadoop.version=2.2.0 -Phadoop-2.2 -DskipTests
 ```
 Spark 1.3.x
+
 ```
 mvn clean package -Pspark-1.3 -Dhadoop.version=2.2.0 -Phadoop-2.2 -DskipTests
 ```
 Spark 1.2.x
+
 ```
 mvn clean package -Pspark-1.2 -Dhadoop.version=2.2.0 -Phadoop-2.2 -DskipTests 
 ```
 Spark 1.1.x
+
 ```
 mvn clean package -Pspark-1.1 -Dhadoop.version=2.2.0 -Phadoop-2.2 -DskipTests 
 ```
 CDH 5.X
+
 ```
 mvn clean package -Pspark-1.2 -Dhadoop.version=2.5.0-cdh5.3.0 -Phadoop-2.4 -DskipTests
 ```
 Yarn (Hadoop 2.7.x)
+
 ```
 mvn clean package -Pspark-1.4 -Dspark.version=1.4.1 -Dhadoop.version=2.7.0 -Phadoop-2.6 -Pyarn -DskipTests
 ```
 Yarn (Hadoop 2.6.x)
+
 ```
 mvn clean package -Pspark-1.1 -Dhadoop.version=2.6.0 -Phadoop-2.6 -Pyarn -DskipTests
 ```
 Yarn (Hadoop 2.4.x)
+
 ```
 mvn clean package -Pspark-1.1 -Dhadoop.version=2.4.0 -Phadoop-2.4 -Pyarn -DskipTests
 ```
 Yarn (Hadoop 2.3.x)
+
 ```
 mvn clean package -Pspark-1.1 -Dhadoop.version=2.3.0 -Phadoop-2.3 -Pyarn -DskipTests
 ```
 Yarn (Hadoop 2.2.x)
+
 ```
 mvn clean package -Pspark-1.1 -Dhadoop.version=2.2.0 -Phadoop-2.2 -Pyarn -DskipTests
 ```
 
 Ignite (1.1.0-incubating and later)
+
 ```
 mvn clean package -Dignite.version=1.1.0-incubating -DskipTests
 ```
 
 ### Configure
 If you wish to configure Zeppelin option (like port number), configure the following files:
+
 ```
 ./conf/zeppelin-env.sh
 ./conf/zeppelin-site.xml
@@ -140,9 +177,15 @@ Yarn
 For configuration details check __./conf__ subdirectory.
 
 ### Package
-To package final distribution do:
+To package the final distribution including the compressed archive, run:
+
+      mvn clean package -Pbuild-distr
+
+To build a distribution with specific profiles, run:
+
+      mvn clean package -Pbuild-distr -Pspark-1.5 -Phadoop-2.4 -Pyarn -Ppyspark
 
-      mvn clean package -P build-distr
+The profiles `-Pspark-1.5 -Phadoop-2.4 -Pyarn -Ppyspark` can be adjusted if you wish to build to a specific spark versions, or omit support such as `yarn`.  
 
 The archive is generated under _zeppelin-distribution/target_ directory