You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by bz...@apache.org on 2016/06/20 01:41:21 UTC
zeppelin git commit: [ZEPPELIN-998] Extend install.md -> Quick Start
Repository: zeppelin
Updated Branches:
refs/heads/master 19c479770 -> 70d22d3d0
[ZEPPELIN-998] Extend install.md -> Quick Start
### What is this PR for?
Most of other projects have **Quick Start** or **Getting Started** page for the beginner. Currently, Zeppelin also has [Zeppelin Install](https://zeppelin.apache.org/docs/0.6.0-SNAPSHOT/install/install.html) which is similar with those kind of instruction page. But it has only contents that explain just installation and configuration. So I updated this page to **Quick Start** so that it can include step by step guide for the beginners.
### What type of PR is it?
Improvement & Documentation
### Todos
* [x] - Add each title link to the head of documentation
* [x] - Add more information about Zeppelin installation
* [x] - Reorder contents
### What is the Jira issue?
[ZEPPELIN-998](https://issues.apache.org/jira/browse/ZEPPELIN-998)
### How should this be tested?
See the attached screenshot images
### Screenshots (if appropriate)
<img width="809" alt="screen shot 2016-06-14 at 2 59 47 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061227/d88abe56-3240-11e6-845c-e37a9975aceb.png">
<img width="796" alt="screen shot 2016-06-14 at 3 00 01 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061229/daca8b06-3240-11e6-821b-7d118b7b3e09.png">
<img width="789" alt="screen shot 2016-06-14 at 3 00 15 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061234/dd12072c-3240-11e6-9a0a-cf1e320fd879.png">
<img width="785" alt="screen shot 2016-06-14 at 3 00 27 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061238/df7f904c-3240-11e6-83e0-73f3688c0815.png">
<img width="789" alt="screen shot 2016-06-14 at 3 00 38 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061242/e1ad1402-3240-11e6-81ba-2e7125cec98e.png">
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: AhyoungRyu <fb...@hanmail.net>
Closes #1010 from AhyoungRyu/ZEPPELIN-998 and squashes the following commits:
b2b1aa8 [AhyoungRyu] Change some sentences as @bzz suggested
12da298 [AhyoungRyu] Fix pointing link in index.md
af50576 [AhyoungRyu] Address @bzz feedback
af68a32 [AhyoungRyu] Extend install.md -> Quick Start
Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/70d22d3d
Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/70d22d3d
Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/70d22d3d
Branch: refs/heads/master
Commit: 70d22d3d0a19b0d8863fbce4089913269a288a1d
Parents: 19c4797
Author: AhyoungRyu <fb...@hanmail.net>
Authored: Wed Jun 15 00:13:07 2016 -0700
Committer: Alexander Bezzubov <bz...@apache.org>
Committed: Mon Jun 20 10:41:07 2016 +0900
----------------------------------------------------------------------
docs/assets/themes/zeppelin/css/style.css | 2 +
docs/index.md | 6 +-
docs/install/install.md | 159 +++++++++++++++++++------
3 files changed, 126 insertions(+), 41 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/70d22d3d/docs/assets/themes/zeppelin/css/style.css
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/css/style.css b/docs/assets/themes/zeppelin/css/style.css
index 7e34496..a5507d3 100644
--- a/docs/assets/themes/zeppelin/css/style.css
+++ b/docs/assets/themes/zeppelin/css/style.css
@@ -433,6 +433,8 @@ a.anchor {
word-break: keep-all;
-webkit-overflow-scrolling: touch;
font-size: 90%;
+ margin-top: 16px;
+ margin-bottom: 16px;
}
.content table th {
font-weight: bold;
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/70d22d3d/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 282820b..3053f42 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -124,9 +124,9 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor
####Quick Start
* Getting Started
- * [Quick Start](./install/install.html) for basic instructions on installing Zeppelin
- * [Configuration](./install/install.html#zeppelin-configuration) lists for Zeppelin
- * [Explore Apache Zeppelin UI](./quickstart/explorezeppelinui.html): basic components of Zeppelin home
+ * [Quick Start](./install/install.html) for basic instructions on installing Apache Zeppelin
+ * [Configuration](./install/install.html#apache-zeppelin-configuration) lists for Apache Zeppelin
+ * [Explore Apache Zeppelin UI](./quickstart/explorezeppelinui.html): basic components of Apache Zeppelin home
* [Tutorial](./quickstart/tutorial.html): a short walk-through tutorial that uses Apache Spark backend
* Basic Feature Guide
* [Dynamic Form](./manual/dynamicform.html): a step by step guide for creating dynamic forms
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/70d22d3d/docs/install/install.md
----------------------------------------------------------------------
diff --git a/docs/install/install.md b/docs/install/install.md
index e3dcd2c..93d9feb 100644
--- a/docs/install/install.md
+++ b/docs/install/install.md
@@ -19,38 +19,113 @@ limitations under the License.
-->
{% include JB/setup %}
-## Zeppelin Installation
-Welcome to your first trial to explore Zeppelin!
+# Quick Start
+Welcome to your first trial to explore Apache Zeppelin!
+This page will help you to get started and here is the list of topics covered.
-In this documentation, we will explain how you can install Zeppelin from **Binary Package** or build from **Source** by yourself. Plus, you can see all of Zeppelin's configurations in the [Zeppelin Configuration](install.html#zeppelin-configuration) section below.
+* [Installation](#installation)
+ * [Downloading Binary Package](#downloading-binary-package)
+ * [Building from Source](#building-from-source)
+* [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line)
+ * [Start Zeppelin](#start-zeppelin)
+ * [Stop Zeppelin](#stop-zeppelin)
+ * [(Optional) Start Apache Zeppelin with a service manager](#optional-start-apache-zeppelin-with-a-service-manager)
+* [What is the next?](#what-is-the-next)
+* [Apache Zeppelin Configuration](#apache-zeppelin-configuration)
-### Install with Binary Package
+## Installation
-If you want to install Zeppelin with latest binary package, please visit [this page](http://zeppelin.apache.org/download.html).
+Apache Zeppelin officially supports and is tested on next environments.
-### Build from Zeppelin Source
+<table class="table-configuration">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <tr>
+ <td>Oracle JDK</td>
+ <td>1.7 <br /> (set <code>JAVA_HOME</code>)</td>
+ </tr>
+ <tr>
+ <td>OS</td>
+ <td>Mac OSX <br /> Ubuntu 14.X <br /> CentOS 6.X <br /> Windows 7 Pro SP1</td>
+ </tr>
+</table>
+
+There are two options to install Apache Zeppelin on your machine. One is [downloading prebuild binary package](#downloading-binary-package) from the archive.
+You can download not only the latest stable version but also the older one if you need.
+The other option is [building from the source](#building-from-source).
+Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.
+
+### Downloading Binary Package
+
+If you want to install Apache Zeppelin with a stable binary package, please visit [Apache Zeppelin download Page](http://zeppelin.apache.org/download.html).
+After unpacking, jump to [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line) section.
+
+### Building from Source
+If you want to build from the source, the software below needs to be installed on your system.
+
+<table class="table-configuration">
+ <tr>
+ <th>Name</th>
+ <th>Value</th>
+ </tr>
+ <tr>
+ <td>Git</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>Maven</td>
+ <td>3.1.x or higher</td>
+ </tr>
+</table>
+
+If you don't have it installed yet, please check [Before Build](https://github.com/apache/zeppelin/blob/master/README.md#before-build) section and follow step by step instructions from there.
+
+####1. Clone Apache Zeppelin repository
-You can also build Zeppelin from the source.
+```
+git clone https://github.com/apache/zeppelin.git
+```
+
+####2. Build source with options
+Each interpreters requires different build options. For the further information about options, please see [Build](https://github.com/apache/zeppelin#build) section.
+
+```
+mvn clean package -DskipTests [Options]
+```
-#### Prerequisites for build
- * Java 1.7
- * Git
- * Maven(3.1.x or higher)
- * Node.js Package Manager
+Here are some examples with several options
-If you don't have requirements prepared, please check instructions in [README.md](https://github.com/apache/zeppelin/blob/master/README.md) for the details.
+```
+# basic build
+mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark
+
+# spark-cassandra integration
+mvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests
+# with CDH
+mvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests
+# with MapR
+mvn clean package -Pspark-1.5 -Pmapr50 -DskipTests
+```
-Maybe you need to configure individual interpreter. If so, please check **Interpreter** section in Zeppelin documentation.
-[Spark Interpreter for Apache Zeppelin](../interpreter/spark.html) will be a good example.
+For the further information about building with source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in Zeppelin repository.
-## Zeppelin Start / Stop
+## Starting Apache Zeppelin with Command Line
#### Start Zeppelin
```
bin/zeppelin-daemon.sh start
```
+
+If you are using Windows
+
+```
+bin\zeppelin.cmd
+```
+
After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser.
#### Stop Zeppelin
@@ -59,21 +134,28 @@ After successful start, visit [http://localhost:8080](http://localhost:8080) wit
bin/zeppelin-daemon.sh stop
```
-#### Start Zeppelin with a service manager such as upstart
+#### (Optional) Start Apache Zeppelin with a service manager
-Zeppelin can auto start as a service with an init script, such as services managed by upstart.
+> **Note :** The below description was written based on Ubuntu Linux.
-The following is an example upstart script to be saved as `/etc/init/zeppelin.conf`
-This example has been tested with Ubuntu Linux.
+Apache Zeppelin can be auto started as a service with an init script, such as services managed by **upstart**.
+
+The following is an example of upstart script to be saved as `/etc/init/zeppelin.conf`
This also allows the service to be managed with commands such as
-`sudo service zeppelin start`
-`sudo service zeppelin stop`
-`sudo service zeppelin restart`
+```
+sudo service zeppelin start
+sudo service zeppelin stop
+sudo service zeppelin restart
+```
+
+Other service managers could use a similar approach with the `upstart` argument passed to the `zeppelin-daemon.sh` script.
-Other service managers could use a similar approach with the `upstart` argument passed to the zeppelin-daemon.sh script: `bin/zeppelin-daemon.sh upstart`
+```
+bin/zeppelin-daemon.sh upstart
+```
-##### zeppelin.conf
+**zeppelin.conf**
```
description "zeppelin"
@@ -93,15 +175,16 @@ chdir /usr/share/zeppelin
exec bin/zeppelin-daemon.sh upstart
```
-#### Running on Windows
+## What is the next?
+Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need.
-```
-bin\zeppelin.cmd
-```
+ * For an in-depth overview of Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html)
+ * After getting familiar with Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend
+ * If you need more configuration setting for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration)
-## Zeppelin Configuration
+## Apache Zeppelin Configuration
-You can configure Zeppelin with both **environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) and **Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority.
+You can configure Apache Zeppelin with both **environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) and **Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority.
<table class="table-configuration">
<tr>
@@ -210,13 +293,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN</td>
<td>zeppelin.notebook.homescreen</td>
<td></td>
- <td>A notebook id displayed in Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
+ <td>A notebook id displayed in Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE</td>
<td>zeppelin.notebook.homescreen.hide</td>
<td>false</td>
- <td>This value can be "true" when to hide the notebook id set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
+ <td>This value can be "true" when to hide the notebook id set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
</tr>
<tr>
<td>ZEPPELIN_WAR_TEMPDIR</td>
@@ -228,13 +311,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin
<td>ZEPPELIN_NOTEBOOK_DIR</td>
<td>zeppelin.notebook.dir</td>
<td>notebook</td>
- <td>The root directory where Zeppelin notebook directories are saved</td>
+ <td>The root directory where notebook directories are saved</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_S3_BUCKET</td>
<td>zeppelin.notebook.s3.bucket</td>
<td>zeppelin</td>
- <td>S3 Bucket where Zeppelin notebook files will be saved</td>
+ <td>S3 Bucket where notebook files will be saved</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_S3_USER</td>
@@ -270,7 +353,7 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin
<td>ZEPPELIN_NOTEBOOK_AZURE_SHARE</td>
<td>zeppelin.notebook.azure.share</td>
<td>zeppelin</td>
- <td>Share where the Zeppelin notebook files will be saved</td>
+ <td>Share where the notebook files will be saved</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_AZURE_USER</td>
@@ -291,13 +374,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin
<td>org.apache.zeppelin.spark.SparkInterpreter,<br />org.apache.zeppelin.spark.PySparkInterpreter,<br />org.apache.zeppelin.spark.SparkSqlInterpreter,<br />org.apache.zeppelin.spark.DepInterpreter,<br />org.apache.zeppelin.markdown.Markdown,<br />org.apache.zeppelin.shell.ShellInterpreter,<br />
...
</td>
- <td>Comma separated interpreter configurations [Class] <br /> The first interpreter will be a default value. <br /> It means only the first interpreter in this list can be available without <code>%interpreter_name</code> annotation in Zeppelin notebook paragraph. </td>
+ <td>Comma separated interpreter configurations [Class] <br /> The first interpreter will be a default value. <br /> It means only the first interpreter in this list can be available without <code>%interpreter_name</code> annotation in notebook paragraph. </td>
</tr>
<tr>
<td>ZEPPELIN_INTERPRETER_DIR</td>
<td>zeppelin.interpreter.dir</td>
<td>interpreter</td>
- <td>Zeppelin interpreter directory</td>
+ <td>Interpreter directory</td>
</tr>
<tr>
<td>ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE</td>