Skip to content

Commit af68a32

Browse files
AhyoungRyuAhyoungRyu
committed
Extend install.md -> Quick Start
1 parent 5ddc1ef commit af68a32

File tree

2 files changed

+118
-29
lines changed

2 files changed

+118
-29
lines changed

‎docs/assets/themes/zeppelin/css/style.css‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,8 @@ a.anchor {
433433
word-break: keep-all;
434434
-webkit-overflow-scrolling: touch;
435435
font-size: 90%;
436+
margin-top: 16px;
437+
margin-bottom: 16px;
436438
}
437439
.content table th {
438440
font-weight: bold;

‎docs/install/install.md‎

Lines changed: 116 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,117 @@ limitations under the License.
1919
-->
2020
{% include JB/setup %}
2121

22-
## Zeppelin Installation
23-
Welcome to your first trial to explore Zeppelin!
22+
# Quick Start
23+
Welcome to your first trial to explore Apache Zeppelin!
24+
This page will help you to get started with Zeppelin. Here is the list of this page.
2425

25-
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.
26+
* [Installation](#installation)
27+
* [Downloading Binary Package](#downloading-binary-package)
28+
* [Building from Source](#building-from-source)
29+
* [Starting Zeppelin with Command Line](#starting-zeppelin-with-command-line)
30+
* [Start Zeppelin](#start-zeppelin)
31+
* [Stop Zeppelin](#stop-zeppelin)
32+
* [(Optional) Start Zeppelin with a service manager](#optional-start-zeppelin-with-a-service-manager)
33+
* [What is the next?](#what-is-the-next)
34+
* [Zeppelin Configuration](#zeppelin-configuration)
2635

27-
### Install with Binary Package
36+
## Installation
2837

29-
If you want to install Zeppelin with latest binary package, please visit [this page](http://zeppelin.apache.org/download.html).
38+
Apache Zeppelin officially tested on the below environment.
3039

31-
### Build from Zeppelin Source
40+
<table class="table-configuration">
41+
<tr>
42+
<th>Name</th>
43+
<th>Value</th>
44+
</tr>
45+
<tr>
46+
<td>Oracle JDK</td>
47+
<td>1.7 <br /> (set <code>JAVA_HOME</code>)</td>
48+
</tr>
49+
<tr>
50+
<td>OS</td>
51+
<td>Mac OSX <br /> Ubuntu 14.X <br /> CentOS 6.X <br /> Windows 7 Pro SP1</td>
52+
</tr>
53+
</table>
54+
55+
There are two options to install Zeppelin on your machine. One is [downloading prebuild binary package](#downloading-binary-package) from the archive.
56+
You can download not only the latest stable version but also the older one if you need.
57+
The other option is [building from the source](#building-from-source).
58+
Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.
59+
60+
### Downloading Binary Package
3261

33-
You can also build Zeppelin from the source.
62+
If you want to install Zeppelin with a stable binary package, please visit [Zeppelin download Page](http://zeppelin.apache.org/download.html).
63+
After unpacking, jump to [Starting Zeppelin with Command Line](#starting-zeppelin-with-command-line) section.
3464

35-
#### Prerequisites for build
36-
* Java 1.7
37-
* Git
38-
* Maven(3.1.x or higher)
39-
* Node.js Package Manager
65+
### Building from Source
66+
If you want to build from the source, there are more requirements.
67+
68+
<table class="table-configuration">
69+
<tr>
70+
<th>Name</th>
71+
<th>Value</th>
72+
</tr>
73+
<tr>
74+
<td>Git</td>
75+
<td></td>
76+
</tr>
77+
<tr>
78+
<td>Maven</td>
79+
<td>3.1.x or higher</td>
80+
</tr>
81+
<tr>
82+
<td>Node.js Package Manager(npm)</td>
83+
<td></td>
84+
</tr>
85+
</table>
4086

41-
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.
87+
If you don't have the above requirements yet, please check [Before Build](https://github.com/apache/zeppelin/blob/master/README.md#before-build) section and follow step by step.
4288

89+
####1. Clone Zeppelin repository
4390

91+
```
92+
git clone https://github.com/apache/zeppelin.git
93+
```
4494

45-
Maybe you need to configure individual interpreter. If so, please check **Interpreter** section in Zeppelin documentation.
46-
[Spark Interpreter for Apache Zeppelin](../interpreter/spark.html) will be a good example.
95+
####2. Build source with options
96+
Each interpreters requires different build options. For the further information about options, please see [Build](https://github.com/apache/zeppelin#build) section.
4797

48-
## Zeppelin Start / Stop
98+
```
99+
mvn clean package -DskipTests [Options]
100+
```
101+
102+
Here are some examples with several options
103+
104+
```
105+
# basic build
106+
mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark
107+
108+
# spark-cassandra integration
109+
mvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests
110+
111+
# with CDH
112+
mvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests
113+
114+
# with MapR
115+
mvn clean package -Pspark-1.5 -Pmapr50 -DskipTests
116+
```
117+
118+
For the further information about building with source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in Zeppelin repository.
119+
120+
## Starting Zeppelin with Command Line
49121
#### Start Zeppelin
50122

51123
```
52124
bin/zeppelin-daemon.sh start
53125
```
126+
127+
If you are using Windows
128+
129+
```
130+
bin\zeppelin.cmd
131+
```
132+
54133
After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser.
55134

56135
#### Stop Zeppelin
@@ -59,21 +138,28 @@ After successful start, visit [http://localhost:8080](http://localhost:8080) wit
59138
bin/zeppelin-daemon.sh stop
60139
```
61140

62-
#### Start Zeppelin with a service manager such as upstart
141+
#### (Optional) Start Zeppelin with a service manager
63142

64-
Zeppelin can auto start as a service with an init script, such as services managed by upstart.
143+
> **Note :** The below description was written based on Ubuntu Linux.
65144
66-
The following is an example upstart script to be saved as `/etc/init/zeppelin.conf`
67-
This example has been tested with Ubuntu Linux.
145+
Zeppelin can be auto started as a service with an init script, such as services managed by **upstart**.
146+
147+
The following is an example of upstart script to be saved as `/etc/init/zeppelin.conf`
68148
This also allows the service to be managed with commands such as
69149

70-
`sudo service zeppelin start`
71-
`sudo service zeppelin stop`
72-
`sudo service zeppelin restart`
150+
```
151+
sudo service zeppelin start
152+
sudo service zeppelin stop
153+
sudo service zeppelin restart
154+
```
155+
156+
Other service managers could use a similar approach with the `upstart` argument passed to the `zeppelin-daemon.sh` script.
73157

74-
Other service managers could use a similar approach with the `upstart` argument passed to the zeppelin-daemon.sh script: `bin/zeppelin-daemon.sh upstart`
158+
```
159+
bin/zeppelin-daemon.sh upstart
160+
```
75161

76-
##### zeppelin.conf
162+
**zeppelin.conf**
77163

78164
```
79165
description "zeppelin"
@@ -93,11 +179,12 @@ chdir /usr/share/zeppelin
93179
exec bin/zeppelin-daemon.sh upstart
94180
```
95181

96-
#### Running on Windows
182+
## What is the next?
183+
Congratulation to your successful Zeppelin installation! Here are two next steps you might need.
97184

98-
```
99-
bin\zeppelin.cmd
100-
```
185+
* For an in-depth overview of Zeppelin UI, head to [Explore Zeppelin UI](../quickstart/explorezeppelinui.html)
186+
* After getting familiar with Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend
187+
* If you need more configuration setting for Zeppelin, jump to the next section: [Zeppelin Configuration](#zeppelin-configuration)
101188

102189
## Zeppelin Configuration
103190

0 commit comments

Comments
 (0)