-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #406 from NFLabs/migrated
Notice codebase and issue migration
- Loading branch information
Showing
1 changed file
with
10 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,123 +1,14 @@ | ||
| #Zeppelin | ||
| # Zeppelin has moved to Apache. | ||
|
|
||
| **Documentation:** [User Guide](http://zeppelin-project.org/docs/index.html)<br/> | ||
| **Mailing List:** [User and Dev mailing list](http://zeppelin.incubator.apache.org/community.html)<br/> | ||
| **Continuous Integration:** [](https://travis-ci.org/NFLabs/zeppelin) <br/> | ||
| **Contributing:** [Contribution Guide](https://github.com/NFLabs/zeppelin/blob/master/CONTRIBUTING.md)<br/> | ||
| **License:** [Apache 2.0](https://github.com/NFLabs/zeppelin/blob/master/LICENSE) | ||
|
|
||
|
|
||
| **Zeppelin**, a web-based notebook that enables interactive data analytics. You can make beautiful data-driven, interactive and collaborative documents with SQL, Scala and more. | ||
|
|
||
| Core feature: | ||
| * Web based notebook style editor. | ||
| * Built-in Apache Spark support | ||
|
|
||
|
|
||
| To know more about Zeppelin, visit our web site [http://zeppelin-project.org](http://zeppelin-project.org) | ||
|
|
||
| ## Requirements | ||
| * Java 1.7 | ||
| * Tested on Mac OSX, Ubuntu 14.X, CentOS 6.X | ||
| * Maven (if you want to build from the source code) | ||
| * Node.js Package Manager | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### 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 npm | ||
| ``` | ||
|
|
||
| ### Build | ||
| If you want to build Zeppelin from the source, please first clone this repository. And then: | ||
| ``` | ||
| mvn clean package | ||
| ``` | ||
| Build with specific version | ||
|
|
||
| Spark 1.1.x | ||
| ``` | ||
| mvn clean package -Pspark-1.1 -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.3.x | ||
| ``` | ||
| mvn clean package -Pspark-1.3 -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.2.x and later) | ||
| ``` | ||
| mvn clean package -Pspark-1.1 -Dhadoop.version=2.2.0 -Phadoop-2.2 -Pyarn -DskipTests | ||
| ``` | ||
|
|
||
| ### Configure | ||
| If you wish to configure Zeppelin option (like port number), configure the following files: | ||
| ``` | ||
| ./conf/zeppelin-env.sh | ||
| ./conf/zeppelin-site.xml | ||
| ``` | ||
| (You can copy ```./conf/zeppelin-env.sh.template``` into ```./conf/zeppelin-env.sh```. | ||
| Same for ```zeppein-site.xml```.) | ||
|
|
||
| #### External cluster configuration | ||
| Mesos | ||
|
|
||
| # ./conf/zeppelin-env.sh | ||
| export MASTER=mesos://... | ||
| export ZEPPELIN_JAVA_OPTS="-Dspark.executor.uri=/path/to/spark-*.tgz" or SPARK_HOME="/path/to/spark_home" | ||
| export MESOS_NATIVE_LIBRARY=/path/to/libmesos.so | ||
|
|
||
| If you set `SPARK_HOME`, you should deploy spark binary on the same location to all worker nodes. And if you set `spark.executor.uri`, every worker can read that file on its node. | ||
|
|
||
| Yarn | ||
|
|
||
| # ./conf/zeppelin-env.sh | ||
| export SPARK_YARN_JAR=/path/to/spark-assembly-*.jar | ||
| export HADOOP_CONF_DIR=/path/to/hadoop_conf_dir | ||
|
|
||
| `SPARK_YARN_JAR` is deployed for running executor, this could be a local path or HDFS. HDFS allows YARN to cache it on nodes so that it doesn't need to be distributed each time an application runs. To point to a jar on HDFS, for example, set this configuration to "hdfs:///some/path". | ||
| `HADOOP_CONF_DIR` should contains yarn-site.xml and core-site.xml. | ||
|
|
||
|
|
||
| ### Run | ||
| ./bin/zeppelin-daemon.sh start | ||
|
|
||
| browse localhost:8080 in your browser. 8081 port should be accessible for websocket connection. | ||
|
|
||
|
|
||
| For configuration details check __./conf__ subdirectory. | ||
|
|
||
| ### Package | ||
| To package final distribution do: | ||
|
|
||
| mvn clean package -P build-distr | ||
|
|
||
| The archive is generated under _zeppelin-distribution/target_ directory | ||
|
|
||
| ###Run end-to-end tests | ||
| Zeppelin comes with a set of end-to-end acceptnce tests driving headless selenium browser | ||
|
|
||
| #assumes zeppelin-server running on localhost:8080 (use -Durl=.. to override) | ||
| mvn verify | ||
|
|
||
| #or take care of starting\stoping zeppelin-server from packaged _zeppelin-distribuion/target_ | ||
| mvn verify -P using-packaged-distr | ||
|
|
||
|
|
||
| [](http://githalytics.com/NFLabs/zeppelin) | ||
| Zeppelin's has moved to Apache incubator. | ||
| This github repository is not going to be synced to the ASF's one after 20/Mar/2015. | ||
| Please consider using ASF repo for source code access and JIRA for issues. | ||
| <br /> | ||
| <br /> | ||
| ###Please use new github repo to create pull-request. | ||
|
|
||
| Github : [https://github.com/apache/incubator-zeppelin](https://github.com/apache/incubator-zeppelin) | ||
|
|
||
|
|
||
| ###Please create issue on JIRA. | ||
| JIRA : [https://issues.apache.org/jira/browse/ZEPPELIN](https://issues.apache.org/jira/browse/ZEPPELIN) |