-InterpreterSetting is configuration of a given InterpreterGroup and a unit of start/stop interpreter.
-All Interpreters in the same InterpreterSetting are launched in a single, separate JVM process. The Interpreter communicates with Zeppelin engine via thrift.
+[InterpreterSetting](https://github.com/apache/zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/InterpreterSetting.java) is configuration of a given [InterpreterGroup](https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/InterpreterGroup.java) and a unit of start/stop interpreter.
+All Interpreters in the same InterpreterSetting are launched in a single, separate JVM process. The Interpreter communicates with Zeppelin engine via **[Thrift](https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/thrift/RemoteInterpreterService.thrift)**.
-In 'Separate Interpreter for each note' mode, new Interpreter instance will be created per notebook. But it still runs on the same JVM while they're in the same InterpreterSettings.
+In 'Separate Interpreter(scoped / isolated) for each note' mode which you can see at the **Interpreter Setting** menu when you create a new interpreter, new interpreter instance will be created per notebook. But it still runs on the same JVM while they're in the same InterpreterSettings.
-### Make your own Interpreter
+## Make your own Interpreter
Creating a new interpreter is quite simple. Just extend [org.apache.zeppelin.interpreter](https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java) abstract class and implement some methods.
You can include `org.apache.zeppelin:zeppelin-interpreter:[VERSION]` artifact in your build system. And you should your jars under your interpreter directory with specific directory name. Zeppelin server reads interpreter directories recursively and initializes interpreters including your own interpreter.
@@ -91,18 +95,18 @@ The name of the interpreter is what you later write to identify a paragraph whic
some interpreter specific code...
```
-### Programming Languages for Interpreter
+## Programming Languages for Interpreter
If the interpreter uses a specific programming language ( like Scala, Python, SQL ), it is generally recommended to add a syntax highlighting supported for that to the notebook paragraph editor.
To check out the list of languages supported, see the `mode-*.js` files under `zeppelin-web/bower_components/ace-builds/src-noconflict` or from [github.com/ajaxorg/ace-builds](https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict).
If you want to add a new set of syntax highlighting,
-1. Add the `mode-*.js` file to `zeppelin-web/bower.json` ( when built, `zeppelin-web/src/index.html` will be changed automatically. ).
-2. Add to the list of `editorMode` in `zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js` - it follows the pattern 'ace/mode/x' where x is the name.
-3. Add to the code that checks for `%` prefix and calls `session.setMode(editorMode.x)` in `setParagraphMode` located in `zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js`.
+1. Add the `mode-*.js` file to [zeppelin-web/bower.json](https://github.com/apache/zeppelin/blob/master/zeppelin-web/bower.json) ( when built, [zeppelin-web/src/index.html](https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/index.html) will be changed automatically. ).
+2. Add to the list of `editorMode` in [zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js](https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js) - it follows the pattern 'ace/mode/x' where x is the name.
+3. Add to the code that checks for `%` prefix and calls `session.setMode(editorMode.x)` in `setParagraphMode` located in [zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js](https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js).
-### Install your interpreter binary
+## Install your interpreter binary
Once you have built your interpreter, you can place it under the interpreter directory with all its dependencies.
@@ -110,7 +114,7 @@ Once you have built your interpreter, you can place it under the interpreter dir
[ZEPPELIN_HOME]/interpreter/[INTERPRETER_NAME]/
```
-### Configure your interpreter
+## Configure your interpreter
To configure your interpreter you need to follow these steps:
@@ -119,12 +123,12 @@ To configure your interpreter you need to follow these steps:
Property value is comma separated [INTERPRETER\_CLASS\_NAME].
For example,
-```
--#### 0.6.0 and later +### 0.6.0 and later Inside of a notebook, `%[INTERPRETER_GROUP].[INTERPRETER_NAME]` directive will call your interpreter. Note that the first interpreter configuration in zeppelin.interpreters will be the default one. @@ -192,7 +195,7 @@ You can only omit your interpreter group when your interpreter group is selected codes for myintp2 ``` -### Examples +## Examples Checkout some interpreters released with Zeppelin by default. @@ -201,15 +204,16 @@ Checkout some interpreters released with Zeppelin by default. - [shell](https://github.com/apache/zeppelin/tree/master/shell) - [jdbc](https://github.com/apache/zeppelin/tree/master/jdbc) -### Contributing a new Interpreter to Zeppelin releases +## Contributing a new Interpreter to Zeppelin releases We welcome contribution to a new interpreter. Please follow these few steps: - - First, check out the general contribution guide [here](./howtocontributewebsite.html). - - Follow the steps in "Make your own Interpreter" section above. - - Add your interpreter as in the "Configure your interpreter" section above; also add it to the example template [zeppelin-site.xml.template](https://github.com/apache/zeppelin/blob/master/conf/zeppelin-site.xml.template). - - Add tests! They are run by Travis for all changes and it is important that they are self-contained. + - First, check out the general contribution guide [here](https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md). + - Follow the steps in [Make your own Interpreter](#make-your-own-interpreter) section above. + - Add your interpreter as in the [Configure your interpreter](#configure-your-interpreter) section above; also add it to the example template [zeppelin-site.xml.template](https://github.com/apache/zeppelin/blob/master/conf/zeppelin-site.xml.template). + - Add tests! They are run by [Travis](https://travis-ci.org/apache/zeppelin) for all changes and it is important that they are self-contained. - Include your interpreter as a module in [`pom.xml`](https://github.com/apache/zeppelin/blob/master/pom.xml). - Add documentation on how to use your interpreter under `docs/interpreter/`. Follow the Markdown style as this [example](https://github.com/apache/zeppelin/blob/master/docs/interpreter/elasticsearch.md). Make sure you list config settings and provide working examples on using your interpreter in code boxes in Markdown. Link to images as appropriate (images should go to `docs/assets/themes/zeppelin/img/docs-img/`). And add a link to your documentation in the navigation menu (`docs/_includes/themes/zeppelin/_navigation.html`). - Most importantly, ensure licenses of the transitive closure of all dependencies are list in [license file](https://github.com/apache/zeppelin/blob/master/zeppelin-distribution/src/bin_license/LICENSE). - - Commit your changes and open a Pull Request on the project [Mirror on GitHub](https://github.com/apache/zeppelin); check to make sure Travis CI build is passing. + - Commit your changes and open a [Pull Request](https://github.com/apache/zeppelin/pulls) on the project [Mirror on GitHub](https://github.com/apache/zeppelin); check to make sure Travis CI build is passing. + \ No newline at end of file diff --git a/docs/displaysystem/back-end-angular.md b/docs/displaysystem/back-end-angular.md index 4a06a08ffea..d84a033d6fd 100644 --- a/docs/displaysystem/back-end-angular.md +++ b/docs/displaysystem/back-end-angular.md @@ -19,15 +19,17 @@ limitations under the License. --> {% include JB/setup %} +# Back-end Angular API in Apache Zeppelin -## Back-end Angular API in Zeppelin + -Angular display system treats output as a view template for [AngularJS](https://angularjs.org/). -It compiles templates and displays them inside of Zeppelin. +## Overview -Zeppelin provides a gateway between your interpreter and your compiled **AngularJS view** templates. +Angular display system treats output as a view template for [AngularJS](https://angularjs.org/). +It compiles templates and displays them inside of Apache Zeppelin. Zeppelin provides a gateway between your interpreter and your compiled **AngularJS view** templates. Therefore, you can not only update scope variables from your interpreter but also watch them in the interpreter, which is JVM process. +## Basic Usage ### Print AngularJS view To use angular display system, you should start with `%angular`. @@ -94,30 +96,25 @@ When the button is clicked, you'll see both `run` and `numWatched` are increment ## Let's make it Simpler and more Intuitive In this section, we will introduce a simpler and more intuitive way of using **Angular Display System** in Zeppelin. -### How can we use it? Here are some usages. -#### Import - -##### - In notebook scope +### Import ```scala +// In notebook scope import org.apache.zeppelin.display.angular.notebookscope._ import AngularElem._ -``` -##### - In paragraph scope -```scala +// In paragraph scope import org.apache.zeppelin.display.angular.paragraphscope._ import AngularElem._ ``` - -#### Display Element +### Display Element ```scala // automatically convert to string and print with %angular display system directive in front.
.display
```
-#### Event Handler
+### Event Handler
```scala
// on click
.onClick(() => {
@@ -135,7 +132,7 @@ import AngularElem._
}).display
```
-#### Bind Model
+### Bind Model
```scala
// bind model
.model("myModel").display
@@ -144,7 +141,7 @@ import AngularElem._
.model("myModel", initialValue).display
```
-#### Interact with Model
+### Interact with Model
```scala
// read model
AngularModel("myModel")()
diff --git a/docs/displaysystem/basicdisplaysystem.md b/docs/displaysystem/basicdisplaysystem.md
index 3821f1d9ccf..732408dfd76 100644
--- a/docs/displaysystem/basicdisplaysystem.md
+++ b/docs/displaysystem/basicdisplaysystem.md
@@ -19,6 +19,10 @@ limitations under the License.
-->
{% include JB/setup %}
+# Basic Display System in Apache Zeppelin
+
+
+
## Text
By default, Apache Zeppelin prints interpreter responce as a plain text using `text` display system.
diff --git a/docs/displaysystem/front-end-angular.md b/docs/displaysystem/front-end-angular.md
index c78b1b4c52d..773b067d255 100644
--- a/docs/displaysystem/front-end-angular.md
+++ b/docs/displaysystem/front-end-angular.md
@@ -19,18 +19,18 @@ limitations under the License.
-->
{% include JB/setup %}
+# Front-end Angular API in Apache Zeppelin
-## Front-end Angular API in Zeppelin
+
-In addition to the back-end API to handle Angular objects binding, Zeppelin also exposes a simple AngularJS **`z`** object on the front-end side to expose the same capabilities.
+## Basic Usage
+In addition to the [back-end API](./back-end-angular.html) to handle Angular objects binding, Apache Zeppelin also exposes a simple AngularJS
### Bind / Unbind Variables -Through the **`z`**, you can bind / unbind variables to **AngularJS view** - +Through the **`z`**, you can bind / unbind variables to **AngularJS view**. Bind a value to an angular object and a **mandatory** target paragraph: ```html @@ -68,9 +68,10 @@ Unbind/remove a value from angular object and a **mandatory** target paragraph: The signature for the **`z.angularBind() / z.angularUnbind()`** functions are: ```javascript - +// Bind z.angularBind(angularObjectName, angularObjectValue, paragraphId); +// Unbind z.angularUnbind(angularObjectName, angularObjectValue, paragraphId); ``` @@ -100,24 +101,24 @@ You can also trigger paragraph execution by calling **`z.runParagraph()`** funct
-### Overriding dynamic form with Angular Object +## Overriding dynamic form with Angular Object The front-end Angular Interaction API has been designed to offer richer form capabilities and variable binding. With the existing **Dynamic Form** system you can already create input text, select and checkbox forms but the choice is rather limited and the look & feel cannot be changed. The idea is to create a custom form using plain HTML/AngularJS code and bind actions on this form to push/remove Angular variables to targeted paragraphs using this new API. -Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the _${formName}_, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example: +Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the `${formName}`, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example:
-### Feature matrix comparison +## Feature matrix comparison -How does the front-end AngularJS API compares to the back-end API ? Below is a comparison matrix for both APIs: +How does the front-end AngularJS API compares to the [back-end API](./back-end-angular.html) ? Below is a comparison matrix for both APIs: -
+
\ No newline at end of file
diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md
index 21d44c2f0d9..a831eb98d4e 100644
--- a/docs/install/upgrade.md
+++ b/docs/install/upgrade.md
@@ -19,12 +19,14 @@ limitations under the License.
-->
{% include JB/setup %}
-## Manual upgrade procedure for Zeppelin
+# Manual upgrade procedure for Zeppelin
+
+
Basically, newer version of Zeppelin works with previous version notebook directory and configurations.
So, copying `notebook` and `conf` directory should be enough.
-### Instructions
+## Instructions
1. Stop Zeppelin
```
@@ -33,7 +35,7 @@ So, copying `notebook` and `conf` directory should be enough.
1. Copy your `notebook` and `conf` directory into a backup directory
-1. Download newer version of Zeppelin and Install. See [Install page](./install.html)
+1. Download newer version of Zeppelin and Install. See [Install page](./install.html#installation).
1. Copy backup `notebook` and `conf` directory into newer version of Zeppelin `notebook` and `conf` directory
@@ -41,4 +43,4 @@ So, copying `notebook` and `conf` directory should be enough.
```
bin/zeppelin-daemon.sh start
- ```
+ ```
\ No newline at end of file
diff --git a/docs/install/virtual_machine.md b/docs/install/virtual_machine.md
index 7849ff171f0..7360183f5f9 100644
--- a/docs/install/virtual_machine.md
+++ b/docs/install/virtual_machine.md
@@ -19,8 +19,11 @@ limitations under the License.
-->
{% include JB/setup %}
+# Vagrant Virtual Machine for Apache Zeppelin
-## Vagrant Virtual Machine for Apache Zeppelin
+
+
+## Overview
Apache Zeppelin distribution includes a scripts directory
@@ -30,11 +33,11 @@ This script creates a virtual machine that launches a repeatable, known set of c
For PySpark users, this script includes several helpful [Python Libraries](#python-extras).
For SparkR users, this script includes several helpful [R Libraries](#r-extras).
-####Installing the required components to launch a virtual machine.
+### Prerequisites
This script requires three applications, [Ansible](http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip "Ansible"), [Vagrant](http://www.vagrantup.com "Vagrant") and [Virtual Box](https://www.virtualbox.org/ "Virtual Box"). All of these applications are freely available as Open Source projects and extremely easy to set up on most operating systems.
-### Create a Zeppelin Ready VM in 4 Steps (5 on Windows)
+## Create a Zeppelin Ready VM
If you are running Windows and don't yet have python installed, [install Python 2.7.x](https://www.python.org/downloads/release/python-2710/) first.
@@ -60,9 +63,15 @@ curl -fsSL https://raw.githubusercontent.com/NFLabs/z-manager/master/zeppelin-in
```
-### Building Zeppelin
+## Building Zeppelin
+
+You can now
-You can now `git clone git://git.apache.org/zeppelin.git` into a directory on your host machine, or directly in your virtual machine.
+```
+git clone git://git.apache.org/zeppelin.git
+```
+
+into a directory on your host machine, or directly in your virtual machine.
Cloning Zeppelin into the `/scripts/vagrant/zeppelin-dev` directory from the host, will allow the directory to be shared between your host and the guest machine.
@@ -74,14 +83,13 @@ By default, Vagrant will share your project directory (the directory with the Va
`cd /vagrant/zeppelin`
-### What's in this VM?
+## What's in this VM?
Running the following commands in the guest machine should display these expected versions:
`node --version` should report *v0.12.7*
`mvn --version` should report *Apache Maven 3.3.3* and *Java version: 1.7.0_85*
-
The virtual machine consists of:
- Ubuntu Server 14.04 LTS
@@ -96,7 +104,7 @@ The virtual machine consists of:
- Python addons: pip, matplotlib, scipy, numpy, pandas
- [R](https://www.r-project.org/) and R Packages required to run the R Interpreter and the related R tutorial notebook, including: Knitr, devtools, repr, rCharts, ggplot2, googleVis, mplot, htmltools, base64enc, data.table
-### How to build & run Zeppelin
+## How to build & run Zeppelin
This assumes you've already cloned the project either on the host machine in the zeppelin-dev directory (to be shared with the guest machine) or cloned directly into a directory while running inside the guest machine. The following build steps will also include Python and R support via PySpark and SparkR:
@@ -111,7 +119,7 @@ On your host machine browse to `http://localhost:8080/`
If you [turned off port forwarding](#tweaking-the-virtual-machine) in the `Vagrantfile` browse to `http://192.168.51.52:8080`
-### Tweaking the Virtual Machine
+## Tweaking the Virtual Machine
If you plan to run this virtual machine along side other Vagrant images, you may wish to bind the virtual machine to a specific IP address, and not use port fowarding from your local host.
@@ -125,7 +133,7 @@ config.vm.network "private_network", ip: "192.168.51.52"
`vagrant halt` followed by `vagrant up` will restart the guest machine bound to the IP address of `192.168.51.52`.
This approach usually is typically required if running other virtual machines that discover each other directly by IP address, such as Spark Masters and Slaves as well as Cassandra Nodes, Elasticsearch Nodes, and other Spark data sources. You may wish to launch nodes in virtual machines with IP addresses in a subnet that works for your local network, such as: 192.168.51.53, 192.168.51.54, 192.168.51.53, etc..
-
+## Extras
### Python Extras
With Zeppelin running, **Numpy**, **SciPy**, **Pandas** and **Matplotlib** will be available. Create a pyspark notebook, and try the below code.
diff --git a/docs/interpreter/alluxio.md b/docs/interpreter/alluxio.md
index 332dd0d24b2..c8ecf93d281 100644
--- a/docs/interpreter/alluxio.md
+++ b/docs/interpreter/alluxio.md
@@ -6,7 +6,11 @@ group: manual
---
{% include JB/setup %}
-## Alluxio Interpreter for Apache Zeppelin
+# Alluxio Interpreter for Apache Zeppelin
+
+
+
+## Overview
[Alluxio](http://alluxio.org/) is a memory-centric distributed storage system enabling reliable data sharing at memory-speed across cluster frameworks.
## Configuration
diff --git a/docs/interpreter/cassandra.md b/docs/interpreter/cassandra.md
index 2091666761c..33cff199b05 100644
--- a/docs/interpreter/cassandra.md
+++ b/docs/interpreter/cassandra.md
@@ -6,7 +6,9 @@ group: manual
---
{% include JB/setup %}
-## Cassandra CQL Interpreter for Apache Zeppelin
+# Cassandra CQL Interpreter for Apache Zeppelin
+
+
**z** object on the front-end side to expose the same capabilities.
+This **z** object is accessible in the Angular isolated scope for each paragraph.
-This **`z`** object is accessible in the Angular isolated scope for each paragraph.
-### Bind / Unbind Variables -Through the **`z`**, you can bind / unbind variables to **AngularJS view** - +Through the **`z`**, you can bind / unbind variables to **AngularJS view**. Bind a value to an angular object and a **mandatory** target paragraph: ```html @@ -68,9 +68,10 @@ Unbind/remove a value from angular object and a **mandatory** target paragraph: The signature for the **`z.angularBind() / z.angularUnbind()`** functions are: ```javascript - +// Bind z.angularBind(angularObjectName, angularObjectValue, paragraphId); +// Unbind z.angularUnbind(angularObjectName, angularObjectValue, paragraphId); ``` @@ -100,24 +101,24 @@ You can also trigger paragraph execution by calling **`z.runParagraph()`** funct
-### Overriding dynamic form with Angular Object +## Overriding dynamic form with Angular Object The front-end Angular Interaction API has been designed to offer richer form capabilities and variable binding. With the existing **Dynamic Form** system you can already create input text, select and checkbox forms but the choice is rather limited and the look & feel cannot be changed. The idea is to create a custom form using plain HTML/AngularJS code and bind actions on this form to push/remove Angular variables to targeted paragraphs using this new API. -Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the _${formName}_, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example: +Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the `${formName}`, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example:
-### Feature matrix comparison +## Feature matrix comparison -How does the front-end AngularJS API compares to the back-end API ? Below is a comparison matrix for both APIs: +How does the front-end AngularJS API compares to the [back-end API](./back-end-angular.html) ? Below is a comparison matrix for both APIs: -
| Actions | diff --git a/docs/index.md b/docs/index.md index 282820b0392..10fc7e1588e 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 @@ -139,11 +139,10 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor ####Interpreter * [Interpreters in Apache Zeppelin](./manual/interpreters.html): what is interpreter group? how can you set interpreters in Apache Zeppelin? -* Available Interpreters: currently, about 20 interpreters are available in Apache Zeppelin. * Usage - * [Dynamic Interpreter Loading](./manual/dynamicinterpreterload.html) using REST API + * [Interpreter Installation](./manual/interpreterinstallation.html): Install not only community managed interpreters but also 3rd party interpreters * [Interpreter Dependency Management](./manual/dependencymanagement.html) when you include external libraries to interpreter - +* Available Interpreters: currently, about 20 interpreters are available in Apache Zeppelin. ####Display System @@ -163,6 +162,7 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor * [Interpreter API](./rest-api/rest-interpreter.html) * [Notebook API](./rest-api/rest-notebook.html) * [Configuration API](./rest-api/rest-configuration.html) + * [Credential API](./rest-api/rest-credential.html) * Security: available security support in Apache Zeppelin * [Authentication for NGINX](./security/authentication.html) * [Shiro Authentication](./security/shiroauthentication.html) diff --git a/docs/install/install.md b/docs/install/install.md index e3dcd2c0005..bcc93da224d 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -19,38 +19,108 @@ 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. + -### 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 +
|---|
| Name | +Value | +
|---|---|
| Oracle JDK | +1.7 (set JAVA_HOME) |
+
| OS | +Mac OSX Ubuntu 14.X CentOS 6.X Windows 7 Pro SP1 |
+
| Name | +Value | +
|---|---|
| Git | ++ |
| Maven | +3.1.x or higher | +
| ZEPPELIN_NOTEBOOK_HOMESCREEN | zeppelin.notebook.homescreen | - | A notebook id displayed in Zeppelin homescreen i.e. 2A94M5J1Z |
+ A notebook id displayed in Apache Zeppelin homescreen i.e. 2A94M5J1Z |
|
| ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE | zeppelin.notebook.homescreen.hide | false | -This value can be "true" when to hide the notebook id set by ZEPPELIN_NOTEBOOK_HOMESCREEN on the Zeppelin homescreen. For the further information, please read Customize your Zeppelin homepage. |
+ This value can be "true" when to hide the notebook id set by ZEPPELIN_NOTEBOOK_HOMESCREEN on the Apache Zeppelin homescreen. For the further information, please read Customize your Zeppelin homepage. |
|
| ZEPPELIN_WAR_TEMPDIR | @@ -228,13 +314,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelinZEPPELIN_NOTEBOOK_DIR | zeppelin.notebook.dir | notebook | -The root directory where Zeppelin notebook directories are saved | +The root directory where notebook directories are saved |
| ZEPPELIN_NOTEBOOK_S3_BUCKET | zeppelin.notebook.s3.bucket | zeppelin | -S3 Bucket where Zeppelin notebook files will be saved | +S3 Bucket where notebook files will be saved | |
| ZEPPELIN_NOTEBOOK_S3_USER | @@ -270,7 +356,7 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelinZEPPELIN_NOTEBOOK_AZURE_SHARE | zeppelin.notebook.azure.share | zeppelin | -Share where the Zeppelin notebook files will be saved | +Share where the notebook files will be saved |
| ZEPPELIN_NOTEBOOK_AZURE_USER | @@ -291,13 +377,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelinorg.apache.zeppelin.spark.SparkInterpreter, org.apache.zeppelin.spark.PySparkInterpreter, org.apache.zeppelin.spark.SparkSqlInterpreter, org.apache.zeppelin.spark.DepInterpreter, org.apache.zeppelin.markdown.Markdown, org.apache.zeppelin.shell.ShellInterpreter, ... |
- Comma separated interpreter configurations [Class] The first interpreter will be a default value. It means only the first interpreter in this list can be available without %interpreter_name annotation in Zeppelin notebook paragraph. |
+ Comma separated interpreter configurations [Class] The first interpreter will be a default value. It means only the first interpreter in this list can be available without %interpreter_name annotation in notebook paragraph. |
||
| ZEPPELIN_INTERPRETER_DIR | zeppelin.interpreter.dir | interpreter | -Zeppelin interpreter directory | +Interpreter directory | |
| ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE | @@ -305,4 +391,4 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin1024000 | Size in characters of the maximum text message to be received by websocket. |
| Name | @@ -33,7 +37,7 @@ This interpreter supports the [Geode](http://geode.incubator.apache.org/) [Objec This [Video Tutorial](https://www.youtube.com/watch?v=zvzzA9GXu3Q) illustrates some of the features provided by the `Geode Interpreter`. -### Create Interpreter +## Create Interpreter By default Zeppelin creates one `Geode/OQL` instance. You can remove it or create more instances. Multiple Geode instances can be created, each configured to the same or different backend Geode cluster. But over time a `Notebook` can have only one Geode interpreter instance `bound`. That means you _cannot_ connect to different Geode clusters in the same `Notebook`. This is a known Zeppelin limitation. @@ -42,10 +46,10 @@ To create new Geode instance open the `Interpreter` section and click the `+Crea > Note: The `Name` of the instance is used only to distinguish the instances while binding them to the `Notebook`. The `Name` is irrelevant inside the `Notebook`. In the `Notebook` you must use `%geode.oql` tag. -### Bind to Notebook +## Bind to Notebook In the `Notebook` click on the `settings` icon in the top right corner. The select/deselect the interpreters to be bound with the `Notebook`. -### Configuration +## Configuration You can modify the configuration of the Geode from the `Interpreter` section. The Geode interpreter expresses the following properties:
|---|
| Name | @@ -222,7 +226,8 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/hive_password |
|---|
| Artifact | @@ -237,8 +242,9 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
|---|
| Name | @@ -261,7 +267,7 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/phoenix_password |
|---|
| Artifact | @@ -272,8 +278,9 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
|---|
| Name | @@ -288,7 +295,8 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/jdbc:tajo://localhost:26002/default |
|---|
| Artifact | @@ -300,9 +308,9 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
|---|
-### Example
+## Example
The following example demonstrates the basic usage of Markdown in a Zeppelin notebook.
diff --git a/docs/interpreter/postgresql.md b/docs/interpreter/postgresql.md
index 5985b188791..107fda1d809 100644
--- a/docs/interpreter/postgresql.md
+++ b/docs/interpreter/postgresql.md
@@ -6,7 +6,12 @@ group: manual
---
{% include JB/setup %}
+# PostgreSQL, Apache HAWQ (incubating) Interpreter for Apache Zeppelin
+
+
+
## Important Notice
+
Postgresql Interpreter will be deprecated and merged into JDBC Interpreter. You can use Postgresql by using JDBC Interpreter with same functionality. See the example below of settings and dependencies.
### Properties
@@ -44,10 +49,19 @@ Postgresql Interpreter will be deprecated and merged into JDBC Interpreter. You
](https://www.youtube.com/watch?v=wqXXQhJ5Uk8)
+
+This interpreter seamlessly supports the following SQL data processing engines:
+
+* [PostgreSQL](http://www.postgresql.org/) - OSS, Object-relational database management system (ORDBMS)
+* [pache HAWQ (incubating)](http://hawq.incubator.apache.org/) - Powerful open source SQL-On-Hadoop engine.
+* [Greenplum](http://pivotal.io/big-data/pivotal-greenplum-database) - MPP database built on open source PostgreSQL.
+
+This [Video Tutorial](https://www.youtube.com/watch?v=wqXXQhJ5Uk8) illustrates some of the features provided by the `Postgresql Interpreter`.
](https://www.youtube.com/watch?v=wqXXQhJ5Uk8)
-
-This interpreter seamlessly supports the following SQL data processing engines:
-
-* [PostgreSQL](http://www.postgresql.org/) - OSS, Object-relational database management system (ORDBMS)
-* [Apache HAWQ](http://pivotal.io/big-data/pivotal-hawq) - Powerful [Open Source](https://wiki.apache.org/incubator/HAWQProposal) SQL-On-Hadoop engine.
-* [Greenplum](http://pivotal.io/big-data/pivotal-greenplum-database) - MPP database built on open source PostgreSQL.
-
-This [Video Tutorial](https://www.youtube.com/watch?v=wqXXQhJ5Uk8) illustrates some of the features provided by the `Postgresql Interpreter`.
-
-### Create Interpreter
+## Create Interpreter
By default Zeppelin creates one `PSQL` instance. You can remove it or create new instances.
Multiple PSQL instances can be created, each configured to the same or different backend databases. But over time a `Notebook` can have only one PSQL interpreter instance `bound`. That means you _cannot_ connect to different databases in the same `Notebook`. This is a known Zeppelin limitation.
@@ -81,10 +85,10 @@ To create new PSQL instance open the `Interpreter` section and click the `+Creat
> Note: The `Name` of the instance is used only to distinct the instances while binding them to the `Notebook`. The `Name` is irrelevant inside the `Notebook`. In the `Notebook` you must use `%psql.sql` tag.
-### Bind to Notebook
+## Bind to Notebook
In the `Notebook` click on the `settings` icon in the top right corner. The select/deselect the interpreters to be bound with the `Notebook`.
-### Configuration
+## Configuration
You can modify the configuration of the PSQL from the `Interpreter` section. The PSQL interpreter expenses the following properties:
| Description | |||
|---|---|---|---|
| python | +zeppelin.python | python | Path of the already installed Python binary (could be python2 or python3). If python is not in your $PATH you can set the absolute directory (example : /usr/bin/python) |
| zeppelin.python.maxResult | +1000 | +Max number of dataframe rows to display. | +
+
+
+## Pandas integration
+[Zeppelin Display System]({{BASE_PATH}}/displaysystem/basicdisplaysystem.html#table) provides simple API to visualize data in Pandas DataFrames, same as in Matplotlib.
-[](/docs/interpreter/screenshots/pythonMatplotlib.png)
+Example:
+```python
+import pandas as pd
+rates = pd.read_csv("bank.csv", sep=";")
+z.show(rates)
+```
## Technical description
-For in-depth technical details on current implementation plese reffer [python/README.md](https://github.com/apache/zeppelin/blob/master/python/README.md)
+For in-depth technical details on current implementation plese reffer [python/README.md](https://github.com/apache/zeppelin/blob/master/python/README.md).
diff --git a/docs/interpreter/r.md b/docs/interpreter/r.md
index c5ed98b8da9..dce8bd1dcc9 100644
--- a/docs/interpreter/r.md
+++ b/docs/interpreter/r.md
@@ -6,78 +6,99 @@ group: manual
---
{% include JB/setup %}
-## R Interpreter
+# R Interpreter for Apache Zeppelin
-This is a the Apache Zeppelin project, with the addition of support for the R programming language and R-spark integration.
+
-### Requirements
+## Overview
-Additional requirements for the R interpreter are:
+[R](https://www.r-project.org) is a free software environment for statistical computing and graphics.
- * R 3.1 or later (earlier versions may work, but have not been tested)
- * The `evaluate` R package.
+To run R code and visualize plots in Apache Zeppelin, you will need R on your master node (or your dev laptop).
-For full R support, you will also need the following R packages:
++ For Centos: `yum install R R-devel libcurl-devel openssl-devel`
++ For Ubuntu: `apt-get install r-base`
- * `knitr`
- * `repr` -- available with `devtools::install_github("IRkernel/repr")`
- * `htmltools` -- required for some interactive plotting
- * `base64enc` -- required to view R base plots
+Validate your installation with a simple R command:
-### Configuration
+```
+R -e "print(1+1)"
+```
-To run Zeppelin with the R Interpreter, the SPARK_HOME environment variable must be set. The best way to do this is by editing `conf/zeppelin-env.sh`.
+To enjoy plots, install additional libraries with:
+```
++ devtools with `R -e "install.packages('devtools', repos = 'http://cran.us.r-project.org')"`
++ knitr with `R -e "install.packages('knitr', repos = 'http://cran.us.r-project.org')"`
++ ggplot2 with `R -e "install.packages('ggplot2', repos = 'http://cran.us.r-project.org')"`
++ Other vizualisation librairies: `R -e "install.packages(c('devtools','mplot', 'googleVis'), repos = 'http://cran.us.r-project.org'); require(devtools); install_github('ramnathv/rCharts')"`
+```
+
+We recommend you to also install the following optional R libraries for happy data analytics:
+
++ glmnet
++ pROC
++ data.table
++ caret
++ sqldf
++ wordcloud
+
+## Configuration
+
+To run Zeppelin with the R Interpreter, the `SPARK_HOME` environment variable must be set. The best way to do this is by editing `conf/zeppelin-env.sh`.
If it is not set, the R Interpreter will not be able to interface with Spark.
-You should also copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`. That will ensure that Zeppelin sees the R Interpreter the first time it starts up.
+You should also copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`. That will ensure that Zeppelin sees the R Interpreter the first time it starts up.
-### Using the R Interpreter
+## Using the R Interpreter
By default, the R Interpreter appears as two Zeppelin Interpreters, `%r` and `%knitr`.
`%r` will behave like an ordinary REPL. You can execute commands as in the CLI.
-[](screenshots/repl2plus2.png)
+
R base plotting is fully supported
-[](screenshots/replhist.png)
+
If you return a data.frame, Zeppelin will attempt to display it using Zeppelin's built-in visualizations.
-[](screenshots/replhead.png)
+
`%knitr` interfaces directly against `knitr`, with chunk options on the first line:
-[](screenshots/knitgeo.png)
-[](screenshots/knitstock.png)
-[](screenshots/knitmotion.png)
+
+
+
+
+
The two interpreters share the same environment. If you define a variable from `%r`, it will be within-scope if you then make a call using `knitr`.
-### Using SparkR & Moving Between Languages
+## Using SparkR & Moving Between Languages
If `SPARK_HOME` is set, the `SparkR` package will be loaded automatically:
-[](screenshots/sparkrfaithful.png)
+
The Spark Context and SQL Context are created and injected into the local environment automatically as `sc` and `sql`.
The same context are shared with the `%spark`, `%sql` and `%pyspark` interpreters:
-[](screenshots/backtoscala.png)
+
You can also make an ordinary R variable accessible in scala and Python:
-[](screenshots/varr1.png)
+
And vice versa:
-[](screenshots/varscala.png)
-[](screenshots/varr2.png)
+
+
+
-### Caveats & Troubleshooting
+## Caveats & Troubleshooting
* Almost all issues with the R interpreter turned out to be caused by an incorrectly set `SPARK_HOME`. The R interpreter must load a version of the `SparkR` package that matches the running version of Spark, and it does this by searching `SPARK_HOME`. If Zeppelin isn't configured to interface with Spark in `SPARK_HOME`, the R interpreter will not be able to connect to Spark.
@@ -98,40 +119,3 @@ And vice versa:
* Error `unable to start device X11` with the repl interpreter. Check your shell login scripts to see if they are adjusting the `DISPLAY` environment variable. This is common on some operating systems as a workaround for ssh issues, but can interfere with R plotting.
* akka Library Version or `TTransport` errors. This can happen if you try to run Zeppelin with a SPARK_HOME that has a version of Spark other than the one specified with `-Pspark-1.x` when Zeppelin was compiled.
-
-
-
-
-
-## R Interpreter for Apache Zeppelin
-
-[R](https://www.r-project.org) is a free software environment for statistical computing and graphics.
-
-To run R code and visualize plots in Apache Zeppelin, you will need R on your master node (or your dev laptop).
-
-+ For Centos: `yum install R R-devel libcurl-devel openssl-devel`
-+ For Ubuntu: `apt-get install r-base`
-
-Validate your installation with a simple R command:
-
-```
-R -e "print(1+1)"
-```
-
-To enjoy plots, install additional libraries with:
-
-```
-+ devtools with `R -e "install.packages('devtools', repos = 'http://cran.us.r-project.org')"`
-+ knitr with `R -e "install.packages('knitr', repos = 'http://cran.us.r-project.org')"`
-+ ggplot2 with `R -e "install.packages('ggplot2', repos = 'http://cran.us.r-project.org')"`
-+ Other vizualisation librairies: `R -e "install.packages(c('devtools','mplot', 'googleVis'), repos = 'http://cran.us.r-project.org'); require(devtools); install_github('ramnathv/rCharts')"`
-```
-
-We recommend you to also install the following optional R libraries for happy data analytics:
-
-+ glmnet
-+ pROC
-+ data.table
-+ caret
-+ sqldf
-+ wordcloud
diff --git a/docs/interpreter/scalding.md b/docs/interpreter/scalding.md
index ec5608bf3b3..e8774df67fa 100644
--- a/docs/interpreter/scalding.md
+++ b/docs/interpreter/scalding.md
@@ -6,17 +6,20 @@ group: manual
---
{% include JB/setup %}
-## Scalding Interpreter for Apache Zeppelin
+# Scalding Interpreter for Apache Zeppelin
+
+
+
[Scalding](https://github.com/twitter/scalding) is an open source Scala library for writing MapReduce jobs.
-### Building the Scalding Interpreter
+## Building the Scalding Interpreter
You have to first build the Scalding interpreter by enable the **scalding** profile as follows:
```
mvn clean package -Pscalding -DskipTests
```
-### Enabling the Scalding Interpreter
+## Enabling the Scalding Interpreter
In a notebook, to enable the **Scalding** interpreter, click on the **Gear** icon,select **Scalding**, and hit **Save**.
diff --git a/docs/interpreter/spark.md b/docs/interpreter/spark.md
index 30da219ac03..a183033bf7c 100644
--- a/docs/interpreter/spark.md
+++ b/docs/interpreter/spark.md
@@ -7,8 +7,14 @@ group: manual
{% include JB/setup %}
-## Spark Interpreter for Apache Zeppelin
-[Apache Spark](http://spark.apache.org) is supported in Zeppelin with
+# Spark Interpreter for Apache Zeppelin
+
+
+
+## Overview
+[Apache Spark](http://spark.apache.org) is a fast and general-purpose cluster computing system.
+It provides high-level APIs in Java, Scala, Python and R, and an optimized engine that supports general execution graphs
+Apache Spark is supported in Zeppelin with
Spark Interpreter group, which consists of five interpreters.
| true | Use HiveContext instead of SQLContext if it is true. | |
| zeppelin.spark.importImplicit | +true | +Import implicits, UDF collection, and sql if set true. | +
-####Configuration Setup
+### Configuration Setup
1. On the server that Zeppelin is installed, install Kerberos client modules and configuration, krb5.conf.
This is to make the server communicate with KDC.
diff --git a/docs/manual/dynamicform.md b/docs/manual/dynamicform.md
index 6594767efec..b554fec1127 100644
--- a/docs/manual/dynamicform.md
+++ b/docs/manual/dynamicform.md
@@ -19,16 +19,18 @@ limitations under the License.
-->
{% include JB/setup %}
-## Dynamic Form
+# Dynamic Form
-Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form.
+
+
+Apache Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form.
Custom language backend can select which type of form creation it wants to use.
-### Using form Templates
+## Using form Templates
This mode creates form using simple template language. It's simple and easy to use. For example Markdown, Shell, SparkSql language backend uses it.
-#### Text input form
+### Text input form
To create text input form, use `${formName}` templates.
@@ -42,7 +44,7 @@ Also you can provide default value, using `${formName=defaultValue}`.
-#### Select form
+### Select form
To create select form, use `${formName=defaultValue,option1|option2...}`
@@ -54,7 +56,7 @@ Also you can separate option's display name and value, using `${formName=default
-#### Checkbox form
+### Checkbox form
For multi-selection, you can create a checkbox form using `${checkbox:formName=defaultValue1|defaultValue2...,option1|option2...}`. The variable will be substituted by a comma-separated string based on the selected items. For example:
@@ -64,13 +66,13 @@ Besides, you can specify the delimiter using `${checkbox(delimiter):formName=...
-### Creates Programmatically
+## Creates Programmatically
Some language backend uses programmatic way to create form. For example [ZeppelinContext](../interpreter/spark.html#zeppelincontext) provides form creation API
Here're some examples.
-####Text input form
+### Text input form
@@ -91,7 +93,7 @@ print("Hello "+z.input("name"))
-####Text input form with default value
+### Text input form with default value
@@ -112,7 +114,7 @@ print("Hello "+z.input("name", "sun"))
-####Select form
+### Select form
diff --git a/docs/manual/dynamicinterpreterload.md b/docs/manual/dynamicinterpreterload.md
index 0794314b53d..42dd74df61f 100644
--- a/docs/manual/dynamicinterpreterload.md
+++ b/docs/manual/dynamicinterpreterload.md
@@ -19,12 +19,13 @@ limitations under the License.
-->
{% include JB/setup %}
-## Dynamic Interpreter Loading using REST API
+# Dynamic Interpreter Loading using REST API
+
+
Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this section, we will introduce **Dynamic interpreter loading** using **REST API**. This concept actually comes from [Zeppelin Helium Proposal](https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal).
Before we start, if you are not familiar with the concept of **Zeppelin interpreter**, you can check out [Overview of Zeppelin interpreter](../manual/interpreters.html) first.
-
## Overview In the past, Zeppelin was loading interpreter binaries from `/interpreter/[interpreter_name]` directory. They were configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They were loaded on Zeppelin server startup and stayed alive until the server was stopped. In order to simplify using 3rd party interpreters, we changed this way to **dynamically** load interpreters from **Maven Repository** using **REST API**. Hopefully, the picture below will help you to understand the process. @@ -32,7 +33,7 @@ In order to simplify using 3rd party interpreters, we changed this way to **dyna ## Load & Unload Interpreters Using REST API -### 1. Load +### Load You can **load** interpreters located in Maven repository using REST API, like this: ( Maybe, you are unfamiliar with `[interpreter_group_name]` or `[interpreter_name]`. If so, please checkout [Interpreters in Zeppelin](../manual/interpreter.html) again. ) @@ -69,21 +70,21 @@ http://127.0.0.1:8080/api/interpreter/load/md/markdown The meaning of each parameters is: 1. **Artifact** - - groupId: org.apache.zeppelin - - artifactId: zeppelin-markdown - - version: 0.6.0-SNAPSHOT + - groupId: org.apache.zeppelin + - artifactId: zeppelin-markdown + - version: 0.6.0-SNAPSHOT 2. **Class Name** - - Package Name: org.apache.zeppelin - - Interpreter Class Name: markdown.Markdown + - Package Name: org.apache.zeppelin + - Interpreter Class Name: markdown.Markdown 3. **Repository ( optional )** - - Url: http://dl.bintray.com/spark-packages/maven - - Snapshot: false + - Url: http://dl.bintray.com/spark-packages/maven + - Snapshot: false > Please note: The interpreters you downloaded need to be **reload**, when your Zeppelin server is down. -### 2. Unload +### Unload If you want to **unload** the interpreters using REST API, ``` @@ -95,7 +96,7 @@ In this case, the Restful method will be
+
diff --git a/docs/manual/interpreters.md b/docs/manual/interpreters.md
index 488d5e9f28c..a21d34e81a7 100644
--- a/docs/manual/interpreters.md
+++ b/docs/manual/interpreters.md
@@ -19,7 +19,12 @@ limitations under the License.
-->
{% include JB/setup %}
-## Interpreters in Zeppelin
+# Interpreters in Apache Zeppelin
+
+
+
+## Overview
+
In this section, we will explain about the role of interpreters, interpreters group and interpreter settings in Zeppelin.
The concept of Zeppelin interpreter allows any language/data-processing-backend to be plugged into Zeppelin.
Currently, Zeppelin supports many interpreters such as Scala ( with Apache Spark ), Python ( with Apache Spark ), SparkSQL, JDBC, Markdown, Shell and so on.
@@ -29,12 +34,12 @@ Zeppelin Interpreter is a plug-in which enables Zeppelin users to use a specific
When you click the ```+Create``` button in the interpreter page, the interpreter drop-down list box will show all the available interpreters on your server.
-
+
-## What is Zeppelin Interpreter Setting?
+## What is interpreter setting?
Zeppelin interpreter setting is the configuration of a given interpreter on Zeppelin server. For example, the properties are required for hive JDBC interpreter to connect to the Hive server.
-
+
Properties are exported as environment variable when property name is consisted of upper characters, numbers and underscore ([A-Z_0-9]). Otherwise set properties as JVM property.
@@ -44,14 +49,15 @@ Each notebook can be bound to multiple Interpreter Settings using setting icon o
-## What is Zeppelin Interpreter Group?
+## What is interpreter group?
Every Interpreter is belonged to an **Interpreter Group**. Interpreter Group is a unit of start/stop interpreter.
By default, every interpreter is belonged to a single group, but the group might contain more interpreters. For example, Spark interpreter group is including Spark support, pySpark, SparkSQL and the dependency loader.
Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout [here](../development/writingzeppelininterpreter.html).
Each interpreters is belonged to a single group and registered together. All of their properties are listed in the interpreter setting like below image.
-
+
+
## Interpreter binding mode
@@ -62,7 +68,7 @@ In 'shared' mode, every notebook bound to the Interpreter Setting will share the
-## Connecting to the Existing Remote Interpreter
+## Connecting to the existing remote interpreter
Zeppelin users can start interpreter thread embedded in their service. This will provide flexibility to user to start interpreter on remote host. To start interpreter along with your service you have to create an instance of ``RemoteInterpreterServer`` and start it as follows:
@@ -75,4 +81,4 @@ interpreter.start()
The above code will start interpreter thread inside your process. Once the interpreter is started you can configure zeppelin to connect to RemoteInterpreter by checking **Connect to existing process** checkbox and then provide **Host** and **Port** on which interpreter porocess is listening as shown in the image below:
-
+
diff --git a/docs/manual/notebookashomepage.md b/docs/manual/notebookashomepage.md
index 48f06a6df45..22697c60048 100644
--- a/docs/manual/notebookashomepage.md
+++ b/docs/manual/notebookashomepage.md
@@ -19,91 +19,84 @@ limitations under the License.
-->
{% include JB/setup %}
-## Customize your zeppelin homepage
- Zeppelin allows you to use one of the notebooks you create as your zeppelin Homepage.
- With that you can brand your zeppelin installation,
- adjust the instruction to your users needs and even translate to other languages.
+# Customize Apache Zeppelin homepage
-
-### How to set a notebook as your zeppelin homepage + -The process for creating your homepage is very simple as shown below: - - 1. Create a notebook using zeppelin - 2. Set the notebook id in the config file - 3. Restart zeppelin +Apache Zeppelin allows you to use one of the notebooks you create as your Zeppelin Homepage. +With that you can brand your Zeppelin installation, adjust the instruction to your users needs and even translate to other languages. -
-#### Create a notebook using zeppelin - Create a new notebook using zeppelin, - you can use ```%md``` interpreter for markdown content or any other interpreter you like. +## How to set a notebook as your Zeppelin homepage - You can also use the display system to generate [text](../displaysystem/display.html), - [html](../displaysystem/display.html#html),[table](../displaysystem/table.html) or - [angular](../displaysystem/angular.html) +The process for creating your homepage is very simple as shown below: - Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide - the code sections. +1. Create a notebook using Zeppelin +2. Set the notebook id in the config file +3. Restart Zeppelin -
-#### Set the notebook id in the config file - To set the notebook id in the config file you should copy it from the last word in the notebook url +### Create a notebook using Zeppelin +Create a new notebook using Zeppelin, +you can use ```%md``` interpreter for markdown content or any other interpreter you like. +You can also use the display system to generate [text](../displaysystem/basicdisplaysystem.html#text), [html](../displaysystem/basicdisplaysystem.html#html), [table](../displaysystem/basicdisplaysystem.html#table) or +Angular ([backend API](../displaysystem/back-end-angular.html), [frontend API](../displaysystem/front-end-angular.html)). - for example +Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide +the code sections. -
+### Set the notebook id in the config file
+To set the notebook id in the config file, you should copy it from the last word in the notebook url.
+For example,
- Set the notebook id to the ```ZEPPELIN_NOTEBOOK_HOMESCREEN``` environment variable
- or ```zeppelin.notebook.homescreen``` property.
+
- You can also set the ```ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE``` environment variable
- or ```zeppelin.notebook.homescreen.hide``` property to hide the new notebook from the notebook list.
+Set the notebook id to the ```ZEPPELIN_NOTEBOOK_HOMESCREEN``` environment variable
+or ```zeppelin.notebook.homescreen``` property.
-
-#### Restart zeppelin - Restart your zeppelin server +You can also set the ```ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE``` environment variable +or ```zeppelin.notebook.homescreen.hide``` property to hide the new notebook from the notebook list. - ``` - ./bin/zeppelin-deamon stop - ./bin/zeppelin-deamon start - ``` - ####That's it! Open your browser and navigate to zeppelin and see your customized homepage... +### Restart Zeppelin +Restart your Zeppelin server +``` +./bin/zeppelin-deamon stop +./bin/zeppelin-deamon start +``` +That's it! Open your browser and navigate to Apache Zeppelin and see your customized homepage.
-### Show notebooks list in your custom homepage -If you want to display the list of notebooks on your custom zeppelin homepage all +## Show notebooks list in your custom homepage +If you want to display the list of notebooks on your custom Apache Zeppelin homepage all you need to do is use our %angular support. -
- Add the following code to a paragraph in you home page and run it... walla! you have your notebooks list. - - ```javascript - println( - """%angular -
## Overview In the past, Zeppelin was loading interpreter binaries from `/interpreter/[interpreter_name]` directory. They were configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They were loaded on Zeppelin server startup and stayed alive until the server was stopped. In order to simplify using 3rd party interpreters, we changed this way to **dynamically** load interpreters from **Maven Repository** using **REST API**. Hopefully, the picture below will help you to understand the process. @@ -32,7 +33,7 @@ In order to simplify using 3rd party interpreters, we changed this way to **dyna ## Load & Unload Interpreters Using REST API -### 1. Load +### Load You can **load** interpreters located in Maven repository using REST API, like this: ( Maybe, you are unfamiliar with `[interpreter_group_name]` or `[interpreter_name]`. If so, please checkout [Interpreters in Zeppelin](../manual/interpreter.html) again. ) @@ -69,21 +70,21 @@ http://127.0.0.1:8080/api/interpreter/load/md/markdown The meaning of each parameters is: 1. **Artifact** - - groupId: org.apache.zeppelin - - artifactId: zeppelin-markdown - - version: 0.6.0-SNAPSHOT + - groupId: org.apache.zeppelin + - artifactId: zeppelin-markdown + - version: 0.6.0-SNAPSHOT 2. **Class Name** - - Package Name: org.apache.zeppelin - - Interpreter Class Name: markdown.Markdown + - Package Name: org.apache.zeppelin + - Interpreter Class Name: markdown.Markdown 3. **Repository ( optional )** - - Url: http://dl.bintray.com/spark-packages/maven - - Snapshot: false + - Url: http://dl.bintray.com/spark-packages/maven + - Snapshot: false > Please note: The interpreters you downloaded need to be **reload**, when your Zeppelin server is down. -### 2. Unload +### Unload If you want to **unload** the interpreters using REST API, ``` @@ -95,7 +96,7 @@ In this case, the Restful method will be
**DELETE**.
## What is the next step after Loading ?
### Q1. Where is the location of interpreters you downloaded ?
-
+
Actually, the answer about this question is in the above picture. Once the REST API is called, the `.jar` files of interpreters you get are saved under `ZEPPELIN_HOME/local-repo` first. Then, they will be copied to `ZEPPELIN_HOME/interpreter` directory. So, please checkout your `ZEPPELIN_HOME/interpreter`.
### Q2. Then, how can I use this interpreter ?
diff --git a/docs/manual/interpreterinstallation.md b/docs/manual/interpreterinstallation.md
new file mode 100644
index 00000000000..b940f597b76
--- /dev/null
+++ b/docs/manual/interpreterinstallation.md
@@ -0,0 +1,166 @@
+---
+layout: page
+title: "Interpreter Installation"
+description: ""
+group: manual
+---
+
+{% include JB/setup %}
+
+# Interpreter Installation
+
+
+
+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
+```
+
+Once you have installed interpreters, you need to restart Zeppelin. And then [create interpreter setting](../manual/interpreters.html#what-is-zeppelin-interpreter) and [bind it with your notebook](../manual/interpreters.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 it's transitive dependencies into `interpreter/interpreter1` directory.
+
+Once you have installed interpreters, you'll need to add interpreter class name into `zeppelin.interpreters` property in [configuration](../install/install.html#apache-zeppelin-configuration).
+And then restart Zeppelin, [create interpreter setting](../manual/interpreters.html#what-is-zeppelin-interpreter) and [bind it with your notebook](../manual/interpreters.html#what-is-zeppelin-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.
+| Name | +Maven Artifact | +Description | +
|---|---|---|
| alluxio | +org.apache.zeppelin:zeppelin-alluxio:0.6.0 | +Alluxio interpreter | +
| angular | +org.apache.zeppelin:zeppelin-angular:0.6.0 | +HTML and AngularJS view rendering | +
| cassandra | +org.apache.zeppelin:zeppelin-cassandra:0.6.0 | +Cassandra interpreter | +
| elasticsearch | +org.apache.zeppelin:zeppelin-elasticsearch:0.6.0 | +Elasticsearch interpreter | +
| file | +org.apache.zeppelin:zeppelin-file:0.6.0 | +HDFS file interpreter | +
| flink | +org.apache.zeppelin:zeppelin-flink:0.6.0 | +Flink interpreter | +
| hbase | +org.apache.zeppelin:zeppelin-hbase:0.6.0 | +Hbase interpreter | +
| ignite | +org.apache.zeppelin:zeppelin-ignite:0.6.0 | +Ignite interpreter | +
| jdbc | +org.apache.zeppelin:zeppelin-jdbc:0.6.0 | +Jdbc interpreter | +
| kylin | +org.apache.zeppelin:zeppelin-kylin:0.6.0 | +Kylin interpreter | +
| lens | +org.apache.zeppelin:zeppelin-lens:0.6.0 | +Lens interpreter | +
| livy | +org.apache.zeppelin:zeppelin-livy:0.6.0 | +Livy interpreter | +
| md | +org.apache.zeppelin:zeppelin-markdown:0.6.0 | +Markdown support | +
| postgresql | +org.apache.zeppelin:zeppelin-postgresql:0.6.0 | +Postgresql interpreter | +
| python | +org.apache.zeppelin:zeppelin-python:0.6.0 | +Python interpreter | +
| shell | +org.apache.zeppelin:zeppelin-shell:0.6.0 | +Shell command | +
+
-## What is Zeppelin Interpreter Setting?
+## What is interpreter setting?
Zeppelin interpreter setting is the configuration of a given interpreter on Zeppelin server. For example, the properties are required for hive JDBC interpreter to connect to the Hive server.
-
+
Properties are exported as environment variable when property name is consisted of upper characters, numbers and underscore ([A-Z_0-9]). Otherwise set properties as JVM property.
@@ -44,14 +49,15 @@ Each notebook can be bound to multiple Interpreter Settings using setting icon o
-## What is Zeppelin Interpreter Group?
+## What is interpreter group?
Every Interpreter is belonged to an **Interpreter Group**. Interpreter Group is a unit of start/stop interpreter.
By default, every interpreter is belonged to a single group, but the group might contain more interpreters. For example, Spark interpreter group is including Spark support, pySpark, SparkSQL and the dependency loader.
Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout [here](../development/writingzeppelininterpreter.html).
Each interpreters is belonged to a single group and registered together. All of their properties are listed in the interpreter setting like below image.
-
+
+
## Interpreter binding mode
@@ -62,7 +68,7 @@ In 'shared' mode, every notebook bound to the Interpreter Setting will share the
-## Connecting to the Existing Remote Interpreter
+## Connecting to the existing remote interpreter
Zeppelin users can start interpreter thread embedded in their service. This will provide flexibility to user to start interpreter on remote host. To start interpreter along with your service you have to create an instance of ``RemoteInterpreterServer`` and start it as follows:
@@ -75,4 +81,4 @@ interpreter.start()
The above code will start interpreter thread inside your process. Once the interpreter is started you can configure zeppelin to connect to RemoteInterpreter by checking **Connect to existing process** checkbox and then provide **Host** and **Port** on which interpreter porocess is listening as shown in the image below:
-
+
diff --git a/docs/manual/notebookashomepage.md b/docs/manual/notebookashomepage.md
index 48f06a6df45..22697c60048 100644
--- a/docs/manual/notebookashomepage.md
+++ b/docs/manual/notebookashomepage.md
@@ -19,91 +19,84 @@ limitations under the License.
-->
{% include JB/setup %}
-## Customize your zeppelin homepage
- Zeppelin allows you to use one of the notebooks you create as your zeppelin Homepage.
- With that you can brand your zeppelin installation,
- adjust the instruction to your users needs and even translate to other languages.
+# Customize Apache Zeppelin homepage
- -### How to set a notebook as your zeppelin homepage + -The process for creating your homepage is very simple as shown below: - - 1. Create a notebook using zeppelin - 2. Set the notebook id in the config file - 3. Restart zeppelin +Apache Zeppelin allows you to use one of the notebooks you create as your Zeppelin Homepage. +With that you can brand your Zeppelin installation, adjust the instruction to your users needs and even translate to other languages. -
-#### Create a notebook using zeppelin - Create a new notebook using zeppelin, - you can use ```%md``` interpreter for markdown content or any other interpreter you like. +## How to set a notebook as your Zeppelin homepage - You can also use the display system to generate [text](../displaysystem/display.html), - [html](../displaysystem/display.html#html),[table](../displaysystem/table.html) or - [angular](../displaysystem/angular.html) +The process for creating your homepage is very simple as shown below: - Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide - the code sections. +1. Create a notebook using Zeppelin +2. Set the notebook id in the config file +3. Restart Zeppelin -
-#### Set the notebook id in the config file - To set the notebook id in the config file you should copy it from the last word in the notebook url +### Create a notebook using Zeppelin +Create a new notebook using Zeppelin, +you can use ```%md``` interpreter for markdown content or any other interpreter you like. +You can also use the display system to generate [text](../displaysystem/basicdisplaysystem.html#text), [html](../displaysystem/basicdisplaysystem.html#html), [table](../displaysystem/basicdisplaysystem.html#table) or +Angular ([backend API](../displaysystem/back-end-angular.html), [frontend API](../displaysystem/front-end-angular.html)). - for example +Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide +the code sections. -
+### Set the notebook id in the config file
+To set the notebook id in the config file, you should copy it from the last word in the notebook url.
+For example,
- Set the notebook id to the ```ZEPPELIN_NOTEBOOK_HOMESCREEN``` environment variable
- or ```zeppelin.notebook.homescreen``` property.
+
- You can also set the ```ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE``` environment variable
- or ```zeppelin.notebook.homescreen.hide``` property to hide the new notebook from the notebook list.
+Set the notebook id to the ```ZEPPELIN_NOTEBOOK_HOMESCREEN``` environment variable
+or ```zeppelin.notebook.homescreen``` property.
- -#### Restart zeppelin - Restart your zeppelin server +You can also set the ```ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE``` environment variable +or ```zeppelin.notebook.homescreen.hide``` property to hide the new notebook from the notebook list. - ``` - ./bin/zeppelin-deamon stop - ./bin/zeppelin-deamon start - ``` - ####That's it! Open your browser and navigate to zeppelin and see your customized homepage... +### Restart Zeppelin +Restart your Zeppelin server +``` +./bin/zeppelin-deamon stop +./bin/zeppelin-deamon start +``` +That's it! Open your browser and navigate to Apache Zeppelin and see your customized homepage.
-### Show notebooks list in your custom homepage -If you want to display the list of notebooks on your custom zeppelin homepage all +## Show notebooks list in your custom homepage +If you want to display the list of notebooks on your custom Apache Zeppelin homepage all you need to do is use our %angular support. -
- Add the following code to a paragraph in you home page and run it... walla! you have your notebooks list. - - ```javascript - println( - """%angular -
- 
+After running the notebook you will see output similar to this one:
+
- The main trick here relays in linking the ```
Notebooks
-
-
+Add the following code to a paragraph in you home page and run it... walla! you have your notebooks list.
+
+```javascript
+println(
+"""%angular
+ - Create new note
--
-
- - {{noteName(note)}} - -
+
+""")
+```
- After running the notebook you will see output similar to this one:
- Notebooks
+
+
- """)
- ```
+ + Create new note
+-
+
- + {{noteName(note)}} + +
+After running the notebook you will see output similar to this one:
+
- The main trick here relays in linking the `````` to the controller:
+The main trick here relays in linking the ```
``` to the controller:
- ```javascript
-
- ```
+```javascript
+
+```
- Once we have ```home``` as our controller variable in our ``````
- we can use ```home.notes.list``` to get access to the notebook list.
+Once we have ```home``` as our controller variable in our ``````
+we can use ```home.notes.list``` to get access to the notebook list.
diff --git a/docs/manual/publish.md b/docs/manual/publish.md
index 1559fba2f8e..a6dea0d3c91 100644
--- a/docs/manual/publish.md
+++ b/docs/manual/publish.md
@@ -19,13 +19,14 @@ limitations under the License.
-->
{% include JB/setup %}
-## How can you publish your paragraph ?
-Zeppelin provides a feature for publishing your notebook paragraph results. Using this feature, you can show Zeppelin notebook paragraph results in your own website.
-It's very straightforward. Just use `