mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
### What is this PR for? Improving documentation page. Please check *TODO* and *Screenshots* sections for detail. The motivation is described in [the JIRA ticket](https://issues.apache.org/jira/browse/ZEPPELIN-2583) and discussion is ongoing on the mailing list. ### What type of PR is it? [Improvement | Documentation] ### Todos * [x] - improved the navbar style * [x] - improved the main page * [x] - re-organized content structure * [x] - added tutorial pages: `spark_with_zeppelin.md`, `python_with_zeppelin.md`, `sql_with_zeppelin.md` for overview * [x] - added `multi_user_support.md` page to provide overview * [x] - added the empty `interpreter_binding_mode` page. This will be handed in the different issue: [ZEPPELIN-2582](https://issues.apache.org/jira/browse/ZEPPELIN-2582) * [x] - added the empty `trouble_shooting` page. This can be filled in the following PRs. * [x] - added the empty `useful_developer_tools` page. This can be filled in the following PRs. ### What is the Jira issue? [ZEPPELIN-2596](https://issues.apache.org/jira/browse/ZEPPELIN-2596) ### How should this be tested? 1. checkout 2. `cd docs` 3. `bundle install` (make sure that you have ruby 2.1.0+ and bundle) 4. `bundle exec jekyll serve --watch` 5. open `localhost:4000` ### Screenshots (if appropriate) #### better navbar: before  #### better navbar: after  #### improved main page: before  #### improved main page: after  #### organized content structure: before  #### organized content structure: after  ### Questions: * Does the licenses files need update? - NO * Is there breaking changes for older versions? - NO * Does this needs documentation? - related with docs Author: 1ambda <1amb4a@gmail.com> Closes #2371 from 1ambda/updating-version-doc and squashes the following commits:eb02fa967[1ambda] fix: navbar focus color applies after folding026379ed6[1ambda] fix: Remove docs/.listen_testa7dd4737b[1ambda] fix: sora's comment 1.218c5058f7[1ambda] fix: resolve description in python_with_zeppelin.mdd3ad67c73[1ambda] fix: sora's comment 4d133dbbcc[1ambda] fix: resolve sora's comment 3513c6ff2c[1ambda] fix: resolve sora's comment 1.14c2946928[1ambda] fix: resovle sora's comment 21c3946ac6[1ambda] fix: sora's comment 14d6e4267f[1ambda] fix: Resolve sola's comment 3d0524cafe[1ambda] fix: Set less shadow for nav5f1f998ba[1ambda] docs: Add useful_develop_tools.md9dfd62c74[1ambda] fix: Typo in installation.md30f7d7e06[1ambda] fix: Typo in helium ctrld6877e792[1ambda] docs: Add python_with_zeppelin.md7027e96c0[1ambda] docs: Improve python conda, docker doc stylee55b50a9d[1ambda] fix: Invalid URLs75ddeeaff[1ambda] docs: replace URIs in interpreter5b43993a4[1ambda] docs: Add sql_with_zeppelin053794e84[1ambda] docs: Add spark_with_zeppelin.mdd4d88b9c7[1ambda] docs: Improve proxy docb46cdd126[1ambda] docs: Add empty interpreter_binding_mode.md06fcb239e[1ambda] docs: Add empty personalized_mode.md4991cf0a7[1ambda] docs: Update upgrading.md53142b7a0[1ambda] fix: Simplify install.md8a5c1e721[1ambda] docs: Add multi_user_support.md34095775e[1ambda] fix: Increase font size to 15pxa03b04b33[1ambda] fix: Remove sample text from trouble_shooting.md199842590[1ambda] fix: Remove docker doc link66a2a7d26[1ambda] docs: Improve impersonation page0a6e3fc1d[1ambda] docs: Improve install docccd999ed5[1ambda] docs: Improve helium docf8d742d08[1ambda] fix: an invalid link in navbarb7aa5f884[1ambda] fix: URLs in development61a175d94[1ambda] docs: Update install.md4c56de5c4[1ambda] fix: URLs in setup0b1d63513[1ambda] fix: URLs in quickstart28970a4fe[1ambda] feat: Add docs/usage735946bca[1ambda] feat: rename /quickstartb351cf237[1ambda] fix: Add missing linksb70770b4f[1ambda] feat: Change URLs in nav, index94e80aef6[1ambda] fix: doens't display navbar version in small6e0cab110[1ambda] feat: Update doc section namesb9ce256ff[1ambda] feat: Hide version in navbar when mdf8bab52be[1ambda] fix: Better image display in index.mdeeb37d5b5[1ambda] fix: Add RL padding for mobile browserceb60b5ee[1ambda] feat: Style collapsed nav for mobile browser4ebafb4b6[1ambda] commit
230 lines
7.1 KiB
Markdown
230 lines
7.1 KiB
Markdown
---
|
|
layout: page
|
|
title: "Installing Interpreters"
|
|
description: "Apache Zeppelin provides Interpreter Installation mechanism for whom downloaded Zeppelin netinst binary package, or just want to install another 3rd party interpreters."
|
|
group: usage/interpreter
|
|
---
|
|
<!--
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
-->
|
|
{% include JB/setup %}
|
|
|
|
# Installing Interpreters
|
|
|
|
<div id="toc"></div>
|
|
|
|
Apache Zeppelin provides **Interpreter Installation** mechanism for whom downloaded Zeppelin `netinst` binary package, or just want to install another 3rd party interpreters.
|
|
|
|
## Community managed interpreters
|
|
Apache Zeppelin provides several interpreters as [community managed interpreters](#available-community-managed-interpreters).
|
|
If you downloaded `netinst` binary package, you need to install by using below commands.
|
|
|
|
#### Install all community managed interpreters
|
|
|
|
```
|
|
./bin/install-interpreter.sh --all
|
|
```
|
|
|
|
#### Install specific interpreters
|
|
|
|
```
|
|
./bin/install-interpreter.sh --name md,shell,jdbc,python
|
|
```
|
|
|
|
You can get full list of community managed interpreters by running
|
|
|
|
```
|
|
./bin/install-interpreter.sh --list
|
|
```
|
|
|
|
#### Install interpreter built with Scala 2.10
|
|
Zeppelin support both Scala 2.10 and 2.11 for several interpreters as below:
|
|
|
|
<table class="table-configuration">
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Maven Artifact for Scala 2.10</th>
|
|
<th>Maven Artifact for Scala 2.11</th>
|
|
</tr>
|
|
<tr>
|
|
<td>cassandra</td>
|
|
<td>org.apache.zeppelin:zeppelin-cassandra_2.10:0.7.0</td>
|
|
<td>org.apache.zeppelin:zeppelin-cassandra_2.11:0.7.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flink</td>
|
|
<td>org.apache.zeppelin:zeppelin-flink_2.10:0.7.0</td>
|
|
<td>org.apache.zeppelin:zeppelin-flink_2.11:0.7.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ignite</td>
|
|
<td>org.apache.zeppelin:zeppelin-ignite_2.10:0.7.0</td>
|
|
<td>org.apache.zeppelin:zeppelin-ignite_2.11:0.7.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>scio</td>
|
|
<td>org.apache.zeppelin:zeppelin-scio_2.10:0.7.0</td>
|
|
<td>org.apache.zeppelin:zeppelin-scio_2.11:0.7.0</td>
|
|
</tr>
|
|
<tr>
|
|
<td>spark</td>
|
|
<td>org.apache.zeppelin:zeppelin-spark_2.10:0.7.0</td>
|
|
<td>org.apache.zeppelin:zeppelin-spark_2.11:0.7.0</td>
|
|
</tr>
|
|
</table>
|
|
|
|
If you install one of these interpreters only with `--name` option, installer will download interpreter built with Scala 2.11 by default. If you want to specify Scala version, you will need to add `--artifact` option. Here is the example of installing flink interpreter built with Scala 2.10.
|
|
|
|
```
|
|
./bin/install-interpreter.sh --name flink --artifact org.apache.zeppelin:zeppelin-flink_2.10:0.7.0
|
|
```
|
|
|
|
#### Install Spark interpreter built with Scala 2.10
|
|
Spark distribution package has been built with Scala 2.10 until 1.6.2. If you have `SPARK_HOME` set pointing to Spark version earlier than 2.0.0, you need to download Spark interpreter packaged with Scala 2.10. To do so, use follow command:
|
|
|
|
```
|
|
rm -rf ./interpreter/spark
|
|
./bin/install-interpreter.sh --name spark --artifact org.apache.zeppelin:zeppelin-spark_2.10:0.7.0
|
|
```
|
|
|
|
<br />
|
|
Once you have installed interpreters, you need to restart Zeppelin. And then [create interpreter setting](./overview.html#what-is-zeppelin-interpreter) and [bind it with your notebook](./overview.html#what-is-zeppelin-interpreter-setting).
|
|
|
|
|
|
## 3rd party interpreters
|
|
|
|
You can also install 3rd party interpreters located in the maven repository by using below commands.
|
|
|
|
#### Install 3rd party interpreters
|
|
|
|
```
|
|
./bin/install-interpreter.sh --name interpreter1 --artifact groupId1:artifact1:version1
|
|
```
|
|
|
|
The above command will download maven artifact `groupId1:artifact1:version1` and all of its transitive dependencies into `interpreter/interpreter1` directory.
|
|
|
|
After restart Zeppelin, then [create interpreter setting](./overview.html#what-is-zeppelin-interpreter) and [bind it with your note](./overview.html#what-is-interpreter-setting).
|
|
|
|
#### Install multiple 3rd party interpreters at once
|
|
|
|
```
|
|
./bin/install-interpreter.sh --name interpreter1,interpreter2 --artifact groupId1:artifact1:version1,groupId2:artifact2:version2
|
|
```
|
|
|
|
`--name` and `--artifact` arguments will recieve comma separated list.
|
|
|
|
## Available community managed interpreters
|
|
|
|
You can also find the below community managed interpreter list in `conf/interpreter-list` file.
|
|
<table class="table-configuration">
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Maven Artifact</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>alluxio</td>
|
|
<td>org.apache.zeppelin:zeppelin-alluxio:0.7.0</td>
|
|
<td>Alluxio interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>angular</td>
|
|
<td>org.apache.zeppelin:zeppelin-angular:0.7.0</td>
|
|
<td>HTML and AngularJS view rendering</td>
|
|
</tr>
|
|
<tr>
|
|
<td>beam</td>
|
|
<td>org.apache.zeppelin:zeppelin-beam:0.7.0</td>
|
|
<td>Beam interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>bigquery</td>
|
|
<td>org.apache.zeppelin:zeppelin-bigquery:0.7.0</td>
|
|
<td>BigQuery interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>cassandra</td>
|
|
<td>org.apache.zeppelin:zeppelin-cassandra\_2.11:0.7.0</td>
|
|
<td>Cassandra interpreter built with Scala 2.11</td>
|
|
</tr>
|
|
<tr>
|
|
<td>elasticsearch</td>
|
|
<td>org.apache.zeppelin:zeppelin-elasticsearch:0.7.0</td>
|
|
<td>Elasticsearch interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>file</td>
|
|
<td>org.apache.zeppelin:zeppelin-file:0.7.0</td>
|
|
<td>HDFS file interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flink</td>
|
|
<td>org.apache.zeppelin:zeppelin-flink\_2.11:0.7.0</td>
|
|
<td>Flink interpreter built with Scala 2.11</td>
|
|
</tr>
|
|
<tr>
|
|
<td>hbase</td>
|
|
<td>org.apache.zeppelin:zeppelin-hbase:0.7.0</td>
|
|
<td>Hbase interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ignite</td>
|
|
<td>org.apache.zeppelin:zeppelin-ignite\_2.11:0.7.0</td>
|
|
<td>Ignite interpreter built with Scala 2.11</td>
|
|
</tr>
|
|
<tr>
|
|
<td>jdbc</td>
|
|
<td>org.apache.zeppelin:zeppelin-jdbc:0.7.0</td>
|
|
<td>Jdbc interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>kylin</td>
|
|
<td>org.apache.zeppelin:zeppelin-kylin:0.7.0</td>
|
|
<td>Kylin interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>lens</td>
|
|
<td>org.apache.zeppelin:zeppelin-lens:0.7.0</td>
|
|
<td>Lens interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>livy</td>
|
|
<td>org.apache.zeppelin:zeppelin-livy:0.7.0</td>
|
|
<td>Livy interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>md</td>
|
|
<td>org.apache.zeppelin:zeppelin-markdown:0.7.0</td>
|
|
<td>Markdown support</td>
|
|
</tr>
|
|
<tr>
|
|
<td>pig</td>
|
|
<td>org.apache.zeppelin:zeppelin-pig:0.7.0</td>
|
|
<td>Pig interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>python</td>
|
|
<td>org.apache.zeppelin:zeppelin-python:0.7.0</td>
|
|
<td>Python interpreter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>scio</td>
|
|
<td>org.apache.zeppelin:zeppelin-scio\_2.11:0.7.0</td>
|
|
<td>Scio interpreter built with Scala 2.11</td>
|
|
</tr>
|
|
<tr>
|
|
<td>shell</td>
|
|
<td>org.apache.zeppelin:zeppelin-shell:0.7.0</td>
|
|
<td>Shell command</td>
|
|
</tr>
|
|
</table>
|