ZEPPELIN-546-docs: Add dynamicinterpreterload.md

2026-05-24 09:38:26 +00:00 · 2016-01-07 11:27:36 -08:00 · 2016-01-07 11:27:36 -08:00 · 16b46f4557
commit 16b46f4557
parent 3067025a65
1 changed files with 117 additions and 0 deletions
--- a/docs/manual/dynamicinterpreterload.md
+++ b/docs/manual/dynamicinterpreterload.md
@ -0,0 +1,117 @@
+---
+layout: page
+title: "Dynamic Interpreter Loading"
+description: ""
+group: manual
+---
+{% include JB/setup %}
+
+## 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**. Actually this concept is come up with [Zeppelin Helium Proposal](https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal).
+Before the start, if you are not clear about the concept of **Zeppelin interpreter**, you can ckeck out [Overview of Zeppelin interpreter](../manual/interpreters.html) first.
+
+<br/>
+## Overview 
+In the past, Zeppelin loads interpreter binaries from `/interpreter/[interpreter_name]` directory. And they are configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They are loaded when Zeppelin server is starting up and stay alive until the server is down.
+However, for using 3rd party interpreter much easier, we change this way to **dynamically** loading interpreters from **Maven Repository** using **REST API**. Hopefully, below picture helps you to understand the process easily. 
+<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin_user.png" height="85%" width="85%"></center>
+
+## Load & Unload Interpreters Using REST API
+
+### 1. 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. )
+
+```
+http://[zeppelin-server]:[zeppelin-port]/api/interpreter/load/[interpreter_group_name]/[interpreter_name]
+```
+The Restful method will be <code>**POST**</code>. And the parameters you need are like:
+
+  1.  **Artifact:** Maven artifact ( groupId:artifactId:version ) 
+
+  2.  **Class Name:** Package name + Interpreter class name
+
+  3. **Repository ( optional ):** Additional maven repository address
+
+For example, if you want to load `markdown` interpreter to your Zeppelin, above parameters and the URL you need may like:
+
+```
+http://127.0.0.1:8080/api/interpreter/load/md/markdown
+```
+
+```
+{
+  "artifact": "org.apache.zeppelin:zeppelin-markdown:0.6.0-incubating-SNAPSHOT",
+  "className": "org.apache.zeppelin.markdown.Markdown",
+  "repository": {
+    "url": "http://dl.bintray.com/spark-packages/maven",
+    "snapshot": false
+  }
+}
+```
+
+
+The meaning of each parameters is: 
+
+  1. **Artifact**
+	- groupId: org.apache.zeppelin
+	- artifactId: zeppelin-markdown
+	- version: 0.6.0-incubating-SNAPSHOT
+
+  2. **Class Name**
+	- Package Name: org.apache.zeppelin
+	- Interpreter Class Name: markdown.Markdown
+
+  3. **Repository ( optional )**
+	- Url: http://dl.bintray.com/spark-packages/maven
+	- Snapshot: false
+
+> <b>Please note: </b>The interpreters you downloaded need to be **reload**, when your Zeppelin server is down. 
+
+### 2. Unload
+If you want to **unload** the interpreters using REST API, 
+
+```
+http://[zeppelin-server]:[zeppelin-port]/api/interpreter/unload/[interpreter_group_name]/[interpreter_name]
+```
+In this time, the Restful method will be <code>**DELETE**</code>.
+
+<br/>
+## What is the next step after Loading ?
+
+Maybe, you are curious several things about how you can actually use the interpreter in Zeppelin. 
+ 
+### 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 ?
+ 
+After you downloaded, you can create and configure the interpreter at the Zeppelin **Interpreter tab**. Then, how can you do this ? Please follow these simple steps. It will be really straighforward. 
+
+Oh, you don't need to restart your Zeppelin server. Because it is **Dynamic Interpreter Loading**, you can configure and load it **on runtime** !
+
+1. After Zeppelin server up, browse Zeppelin home and click **Interpreter tab**.
+<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_1.png" height="85%" width="85%"></center>
+
+2. At the **Interpreter** section, click **+Create** button. 
+<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_2.png" height="85%" width="85%"></center>
+ 
+3. Then, you can verify the interpreter list that you loaded.
+<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_3.png" height="85%" width="85%"></center>
+
+4. After choosing interpreter, you can configure and use it. Don't forget to save it.
+
+5. Create a new notebook in the **Notebook** section, then you can bind the interpreters from your interpreter list. Just drag and drop !
+<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_1.png" height="85%" width="85%"></center>
+<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_2.png" height="85%" width="85%"></center>
+
+6. At last, you can use your interpreter !
+
+If you want to get the specific information about respective interpreters, please checkout each interpreter documentaion. 
+ 
+ 
+
+