You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mi...@apache.org on 2016/11/05 04:49:29 UTC
svn commit: r1768149 [1/2] - in /zeppelin/site/docs/0.7.0-SNAPSHOT: ./
development/ displaysystem/ install/ rest-api/ security/
Author: minalee
Date: Sat Nov 5 04:49:29 2016
New Revision: 1768149
URL: http://svn.apache.org/viewvc?rev=1768149&view=rev
Log:
https://github.com/apache/zeppelin/pull/1565
Modified:
zeppelin/site/docs/0.7.0-SNAPSHOT/atom.xml
zeppelin/site/docs/0.7.0-SNAPSHOT/development/writingzeppelininterpreter.html
zeppelin/site/docs/0.7.0-SNAPSHOT/displaysystem/basicdisplaysystem.html
zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html
zeppelin/site/docs/0.7.0-SNAPSHOT/install/upgrade.html
zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-interpreter.html
zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-notebook.html
zeppelin/site/docs/0.7.0-SNAPSHOT/rss.xml
zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json
zeppelin/site/docs/0.7.0-SNAPSHOT/security/authentication.html
zeppelin/site/docs/0.7.0-SNAPSHOT/security/shiroauthentication.html
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/atom.xml
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/atom.xml?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/atom.xml (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/atom.xml Sat Nov 5 04:49:29 2016
@@ -4,7 +4,7 @@
<title>Apache Zeppelin</title>
<link href="http://zeppelin.apache.org/" rel="self"/>
<link href="http://zeppelin.apache.org"/>
- <updated>2016-10-26T12:17:46+09:00</updated>
+ <updated>2016-11-05T13:46:01+09:00</updated>
<id>http://zeppelin.apache.org</id>
<author>
<name>The Apache Software Foundation</name>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/development/writingzeppelininterpreter.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/development/writingzeppelininterpreter.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/development/writingzeppelininterpreter.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/development/writingzeppelininterpreter.html Sat Nov 5 04:49:29 2016
@@ -216,7 +216,7 @@ Interpreters in the same InterpreterGrou
<p><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/InterpreterSetting.java">InterpreterSetting</a> is configuration of a given <a href="https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/InterpreterGroup.java">InterpreterGroup</a> 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 <strong><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/thrift/RemoteInterpreterService.thrift">Thrift</a></strong>.</p>
-<p>In 'Separate Interpreter(scoped / isolated) for each note' mode which you can see at the <strong>Interpreter Setting</strong> 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.</p>
+<p>In 'Separate Interpreter(scoped / isolated) for each note' mode which you can see at the <strong>Interpreter Setting</strong> menu when you create a new interpreter, new interpreter instance will be created per note. But it still runs on the same JVM while they're in the same InterpreterSettings.</p>
<h2>Make your own Interpreter</h2>
@@ -226,7 +226,7 @@ You can include <code>org.apache.zeppeli
<p>There are three locations where you can store your interpreter group, name and other information. Zeppelin server tries to find the location below. Next, Zeppelin tries to find <code>interpreter-setting.json</code> in your interpreter jar.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">{ZEPPELIN_INTERPRETER_DIR}/{YOUR_OWN_INTERPRETER_DIR}/interpreter-setting.json
</code></pre></div>
-<p>Here is an example of <code>interpreter-setting.json</code> on your own interpreter. Note that if you don't specify editor object, your interpreter will use plain text mode for syntax highlighting.</p>
+<p>Here is an example of <code>interpreter-setting.json</code> on your own interpreter.</p>
<div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">[</span>
<span class="p">{</span>
<span class="nt">"group"</span><span class="p">:</span> <span class="s2">"your-group"</span><span class="p">,</span>
@@ -247,7 +247,8 @@ You can include <code>org.apache.zeppeli
<span class="p">},</span> <span class="err">...</span>
<span class="p">},</span>
<span class="nt">"editor"</span><span class="p">:</span> <span class="p">{</span>
- <span class="nt">"language"</span><span class="p">:</span> <span class="s2">"your-syntax-highlight-language"</span>
+ <span class="nt">"language"</span><span class="p">:</span> <span class="s2">"your-syntax-highlight-language"</span><span class="p">,</span>
+ <span class="nt">"editOnDblClick"</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
@@ -267,23 +268,34 @@ The name of the interpreter is what you
<div class="highlight"><pre><code class="text language-text" data-lang="text">%MyInterpreterName
some interpreter specific code...
</code></pre></div>
-<h2>Programming Languages for Interpreter</h2>
+<h2>Editor setting for Interpreter</h2>
-<p>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. </p>
+<p>You can add <code>editor</code> object to <code>interpreter-setting.json</code> file to specify paragraph editor settings.</p>
-<p>To check out the list of languages supported, see the <code>mode-*.js</code> files under <code>zeppelin-web/bower_components/ace-builds/src-noconflict</code> or from <a href="https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict">github.com/ajaxorg/ace-builds</a>. </p>
+<h3>Language</h3>
+
+<p>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 note paragraph editor.</p>
+
+<p>To check out the list of languages supported, see the <code>mode-*.js</code> files under <code>zeppelin-web/bower_components/ace-builds/src-noconflict</code> or from <a href="https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict">github.com/ajaxorg/ace-builds</a>.</p>
<p>If you want to add a new set of syntax highlighting, </p>
<ol>
-<li>Add the <code>mode-*.js</code> file to <code><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-web/bower.json">zeppelin-web/bower.json</a></code> ( when built, <code><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/index.html">zeppelin-web/src/index.html</a></code> will be changed automatically. ).<br></li>
-<li><p>Add <code>editor</code> object to <code>interpreter-setting.json</code> file. If you want to set your language to <code>java</code> for example, add:</p>
+<li>Add the <code>mode-*.js</code> file to <code><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-web/bower.json">zeppelin-web/bower.json</a></code> (when built, <code><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/index.html">zeppelin-web/src/index.html</a></code> will be changed automatically).</li>
+<li><p>Add <code>language</code> field to <code>editor</code> object. Note that if you don't specify language field, your interpreter will use plain text mode for syntax highlighting. Let's say you want to set your language to <code>java</code>, then add:</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">"editor": {
"language": "java"
}
</code></pre></div></li>
</ol>
+<h3>Edit on double click</h3>
+
+<p>If your interpreter uses mark-up language such as markdown or HTML, set <code>editOnDblClick</code> to <code>true</code> so that text editor opens on pargraph double click and closes on paragraph run. Otherwise set it to <code>false</code>.</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">"editor": {
+ "editOnDblClick": false
+}
+</code></pre></div>
<h2>Install your interpreter binary</h2>
<p>Once you have built your interpreter, you can place it under the interpreter directory with all its dependencies.</p>
@@ -317,7 +329,7 @@ Now you are done and ready to use your i
<h3>0.5.0</h3>
-<p>Inside of a notebook, <code>%[INTERPRETER_NAME]</code> directive will call your interpreter.
+<p>Inside of a note, <code>%[INTERPRETER_NAME]</code> directive will call your interpreter.
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.</p>
<p>For example,</p>
@@ -328,7 +340,7 @@ println(a)
</code></pre></div>
<h3>0.6.0 and later</h3>
-<p>Inside of a notebook, <code>%[INTERPRETER_GROUP].[INTERPRETER_NAME]</code> directive will call your interpreter.</p>
+<p>Inside of a note, <code>%[INTERPRETER_GROUP].[INTERPRETER_NAME]</code> directive will call your interpreter.</p>
<p>You can omit either [INTERPRETER_GROUP] or [INTERPRETER_NAME]. If you omit [INTERPRETER_NAME], then first available interpreter will be selected in the [INTERPRETER_GROUP].
Likewise, if you skip [INTERPRETER_GROUP], then [INTERPRETER_NAME] will be chosen from default interpreter group.</p>
@@ -370,7 +382,7 @@ codes for myintp2
<ul>
<li>First, check out the general contribution guide <a href="https://zeppelin.apache.org/contribution/contributions.html">here</a>.</li>
-<li>Follow the steps in <a href="#make-your-own-interpreter">Make your own Interpreter</a> section above.</li>
+<li>Follow the steps in <a href="#make-your-own-interpreter">Make your own Interpreter</a> section and <a href="#editor-setting-for-interpreter">Editor setting for Interpreter</a> above.</li>
<li>Add your interpreter as in the <a href="#configure-your-interpreter">Configure your interpreter</a> section above; also add it to the example template <a href="https://github.com/apache/zeppelin/blob/master/conf/zeppelin-site.xml.template">zeppelin-site.xml.template</a>.</li>
<li>Add tests! They are run by <a href="https://travis-ci.org/apache/zeppelin">Travis</a> for all changes and it is important that they are self-contained.</li>
<li>Include your interpreter as a module in <a href="https://github.com/apache/zeppelin/blob/master/pom.xml"><code>pom.xml</code></a>.</li>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/displaysystem/basicdisplaysystem.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/displaysystem/basicdisplaysystem.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/displaysystem/basicdisplaysystem.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/displaysystem/basicdisplaysystem.html Sat Nov 5 04:49:29 2016
@@ -207,7 +207,7 @@ limitations under the License.
<h2>Text</h2>
-<p>By default, Apache Zeppelin prints interpreter responce as a plain text using <code>text</code> display system.</p>
+<p>By default, Apache Zeppelin prints interpreter response as a plain text using <code>text</code> display system.</p>
<p><img src="/assets/themes/zeppelin/img/screenshots/display_text.png" /></p>
@@ -223,7 +223,7 @@ limitations under the License.
<h2>Table</h2>
-<p>If you have data that row seprated by '\n' (newline) and column separated by '\t' (tab) with first row as header row, for example</p>
+<p>If you have data that row separated by '\n' (newline) and column separated by '\t' (tab) with first row as header row, for example</p>
<p><img src="/assets/themes/zeppelin/img/screenshots/display_table.png" /></p>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html Sat Nov 5 04:49:29 2016
@@ -239,7 +239,7 @@ limitations under the License.
<p>If you downloaded the default package, just unpack it in a directory of your choice and you're ready to go. If you downloaded the <em>net-install</em> package, you should manually <a href="../manual/interpreterinstallation.html">install additional interpreters</a> first. You can also install everything by running <code>./bin/install-interpreter.sh --all</code>.</p>
-<p>After unpacking, jump to the <a href="#starting-apache-zeppelin-with-command-line">Starting Apache Zeppelin with Command Line</a>.</p>
+<p>After unpacking, jump to the <a href="#starting-apache-zeppelin-from-the-command-line">Starting Apache Zeppelin from Command Line</a>.</p>
<h3>Building from Source</h3>
@@ -338,7 +338,7 @@ respawn limit 7 5
chdir /usr/share/zeppelin
exec bin/zeppelin-daemon.sh upstart
</code></pre></div>
-<h2>Next Steps:</h2>
+<h2>Next Steps</h2>
<p>Congratulations, you have successfully installed Apache Zeppelin! Here are two next steps you might find useful:</p>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/install/upgrade.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/install/upgrade.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/install/upgrade.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/install/upgrade.html Sat Nov 5 04:49:29 2016
@@ -230,6 +230,7 @@ So, copying <code>notebook</code> and <c
<li>From 0.7, we don't use <code>ZEPPELIN_JAVA_OPTS</code> as default value of <code>ZEPPELIN_INTP_JAVA_OPTS</code> and also the same for <code>ZEPPELIN_MEM</code>/<code>ZEPPELIN_INTP_MEM</code>. If user want to configure the jvm opts of interpreter process, please set <code>ZEPPELIN_INTP_JAVA_OPTS</code> and <code>ZEPPELIN_INTP_MEM</code> explicitly. If you don't set <code>ZEPPELIN_INTP_MEM</code>, Zeppelin will set it to <code>-Xms1024m -Xmx1024m -XX:MaxPermSize=512m</code> by default.</li>
<li>Mapping from <code>%jdbc(prefix)</code> to <code>%prefix</code> is no longer available. Instead, you can use %[interpreter alias] with multiple interpreter setttings on GUI.</li>
<li>Usage of <code>ZEPPELIN_PORT</code> is not supported in ssl mode. Instead use <code>ZEPPELIN_SSL_PORT</code> to configure the ssl port. Value from <code>ZEPPELIN_PORT</code> is used only when <code>ZEPPELIN_SSL</code> is set to <code>false</code>.</li>
+<li>The support on Spark 1.1.x to 1.3.x is deprecated.</li>
</ul>
</div>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-interpreter.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-interpreter.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-interpreter.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-interpreter.html Sat Nov 5 04:49:29 2016
@@ -589,6 +589,16 @@ Note that Apache Zeppelin REST APIs rece
<td> 500 </td>
</tr>
<tr>
+ <td>Sample JSON input (Optional)</td>
+ <td>
+ <pre>
+{
+ "noteId": "2AVQJVC8N"
+}
+ </pre>
+ </td>
+ </tr>
+ <tr>
<td>Sample JSON response</td>
<td>
<code>{"status":"OK"}</code>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-notebook.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-notebook.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-notebook.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/rest-api/rest-notebook.html Sat Nov 5 04:49:29 2016
@@ -696,7 +696,7 @@ Note that Apache Zeppelin REST APIs rece
<col width="200">
<tr>
<td>Description</td>
- <td> This <code>POST</code> method runs the paragraph synchronously by given note and paragraph id. This API can return SUCCESS or ERROR depending on the outcome of the paragraph execution
+ <td>This <code>POST</code> method runs the paragraph synchronously by given note and paragraph id. This API can return SUCCESS or ERROR depending on the outcome of the paragraph execution
</td>
</tr>
<tr>
@@ -1194,6 +1194,44 @@ Note that Apache Zeppelin REST APIs rece
</tr>
</tr>
</table></p>
+
+<p><br /></p>
+
+<h3>Clear all paragraph result</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method clear all paragraph results from note of given id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/clear</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Forbidden code</td>
+ <td>401</td>
+ </tr>
+ <tr>
+ <td>Not Found code</td>
+ <td>404</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>sample JSON response</td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ </tr>
+ </table></p>
</div>
</div>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/rss.xml
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/rss.xml?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/rss.xml (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/rss.xml Sat Nov 5 04:49:29 2016
@@ -5,8 +5,8 @@
<description>Apache Zeppelin - The Apache Software Foundation</description>
<link>http://zeppelin.apache.org</link>
<link>http://zeppelin.apache.org</link>
- <lastBuildDate>2016-10-26T12:17:46+09:00</lastBuildDate>
- <pubDate>2016-10-26T12:17:46+09:00</pubDate>
+ <lastBuildDate>2016-11-05T13:46:01+09:00</lastBuildDate>
+ <pubDate>2016-11-05T13:46:01+09:00</pubDate>
<ttl>1800</ttl>
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json Sat Nov 5 04:49:29 2016
@@ -38,7 +38,7 @@
"/development/writingzeppelininterpreter.html": {
"title": "Writing a New Interpreter",
- "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Writing a New InterpreterWhat is Apache Zeppelin InterpreterApache Zeppelin Interpreter is a language backend. For example to use scala code in Zeppelin, you need a scala interpreter.Every Interpreters belongs to an InterpreterGroup.Interpreters in the same InterpreterGroup can reference each other. For example, SparkSqlInterpreter can reference SparkInterpreter to get SparkContext from it while they&#39;re in the same group.In
terpreterSetting 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.In &#39;Separate Interpreter(scoped / isolated) for each note&#39; 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&#39;re in the same InterpreterSettings.Make your own InterpreterCreating a new interpreter is quite simple. Just extend org.apache.zeppelin.interpreter abstract class and implement some methods.You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact in your build system. And you should put your jars under your interpreter directory with a specific directory name. Zeppelin server reads interpreter directories recursively and initializes interpreters
including your own interpreter.There are three locations where you can store your interpreter group, name and other information. Zeppelin server tries to find the location below. Next, Zeppelin tries to find interpreter-setting.json in your interpreter jar.{ZEPPELIN_INTERPRETER_DIR}/{YOUR_OWN_INTERPRETER_DIR}/interpreter-setting.jsonHere is an example of interpreter-setting.json on your own interpreter. Note that if you don&#39;t specify editor object, your interpreter will use plain text mode for syntax highlighting.[ { &quot;group&quot;: &quot;your-group&quot;, &quot;name&quot;: &quot;your-name&quot;, &quot;className&quot;: &quot;your.own.interpreter.class&quot;, &quot;properties&quot;: { &quot;properties1&quot;: { &quot;envName&quot;: null, &quot;propertyName&quot;: &quot;property.1.name&quot;, &quot;defaultValue&quot;: &quot;propertyDefa
ultValue&quot;, &quot;description&quot;: &quot;Property description&quot; }, &quot;properties2&quot;: { &quot;envName&quot;: PROPERTIES_2, &quot;propertyName&quot;: null, &quot;defaultValue&quot;: &quot;property2DefaultValue&quot;, &quot;description&quot;: &quot;Property 2 description&quot; }, ... }, &quot;editor&quot;: { &quot;language&quot;: &quot;your-syntax-highlight-language&quot; } }, { ... }]Finally, Zeppelin uses static initialization with the following:static { Interpreter.register(&quot;MyInterpreterName&quot;, MyClassName.class.getName());}Static initialization is deprecated and will be supported until 0.6.0.The name will appear later in the interpreter name option box during the interpreter configuration process.The name of the interpreter is what you later write to identify a paragraph which sh
ould be interpreted using this interpreter.%MyInterpreterNamesome interpreter specific code...Programming Languages for InterpreterIf 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. If you want to add a new set of syntax highlighting, Add the mode-*.js file to zeppelin-web/bower.json ( when built, zeppelin-web/src/index.html will be changed automatically. ).Add editor object to interpreter-setting.json file. If you want to set your language to java for example, add:&quot;editor&quot;: { &quot;language&quot;: &quot;java&quot;}Install your interpreter binaryOnce you have built your interpreter, you can place it under the interpreter directory with al
l its dependencies.[ZEPPELIN_HOME]/interpreter/[INTERPRETER_NAME]/Configure your interpreterTo configure your interpreter you need to follow these steps:Add your interpreter class name to the zeppelin.interpreters property in conf/zeppelin-site.xml.Property value is comma separated [INTERPRETER_CLASS_NAME].For example,&lt;property&gt;&lt;name&gt;zeppelin.interpreters&lt;/name&gt;&lt;value&gt;org.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,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter&lt;/value&gt;&lt;/property&gt;Add your interpreter to the default configuration which is used when there is no zeppelin-site.xml.Start Zeppelin by running ./bin/zeppelin-daemon.sh start.In the interpreter page, click the +Create butt
on and configure your interpreter properties.Now you are done and ready to use your interpreter.Note : Interpreters released with zeppelin have a default configuration which is used when there is no conf/zeppelin-site.xml.Use your interpreter0.5.0Inside of a notebook, %[INTERPRETER_NAME] directive will call your interpreter.Note that the first interpreter configuration in zeppelin.interpreters will be the default one.For example,%myintpval a = &quot;My interpreter&quot;println(a)0.6.0 and laterInside of a notebook, %[INTERPRETER_GROUP].[INTERPRETER_NAME] directive will call your interpreter.You can omit either [INTERPRETER_GROUP] or [INTERPRETER_NAME]. If you omit [INTERPRETER_NAME], then first available interpreter will be selected in the [INTERPRETER_GROUP].Likewise, if you skip [INTERPRETER_GROUP], then [INTERPRETER_NAME] will be chosen from default interpreter group.For example, if you have two interpreter myintp1 and myintp2 in group mygrp, you can call myintp1 like%myg
rp.myintp1codes for myintp1and you can call myintp2 like%mygrp.myintp2codes for myintp2If you omit your interpreter name, it&#39;ll select first available interpreter in the group ( myintp1 ).%mygrpcodes for myintp1You can only omit your interpreter group when your interpreter group is selected as a default group.%myintp2codes for myintp2ExamplesCheckout some interpreters released with Zeppelin by default.sparkmarkdownshelljdbcContributing a new Interpreter to Zeppelin releasesWe welcome contribution to a new interpreter. Please follow these few steps:First, check out the general contribution guide here.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.Add tests! They are run by Travis for all changes and it is important that they are self-contained.Include your interpreter as a module in pom.xml.Add documentation on how to use your in
terpreter under docs/interpreter/. Follow the Markdown style as this example. 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.Commit your changes and open a Pull Request on the project Mirror on GitHub; check to make sure Travis CI build is passing.",
+ "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Writing a New InterpreterWhat is Apache Zeppelin InterpreterApache Zeppelin Interpreter is a language backend. For example to use scala code in Zeppelin, you need a scala interpreter.Every Interpreters belongs to an InterpreterGroup.Interpreters in the same InterpreterGroup can reference each other. For example, SparkSqlInterpreter can reference SparkInterpreter to get SparkContext from it while they&#39;re in the same group.In
terpreterSetting 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.In &#39;Separate Interpreter(scoped / isolated) for each note&#39; mode which you can see at the Interpreter Setting menu when you create a new interpreter, new interpreter instance will be created per note. But it still runs on the same JVM while they&#39;re in the same InterpreterSettings.Make your own InterpreterCreating a new interpreter is quite simple. Just extend org.apache.zeppelin.interpreter abstract class and implement some methods.You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact in your build system. And you should put your jars under your interpreter directory with a specific directory name. Zeppelin server reads interpreter directories recursively and initializes interpreters inc
luding your own interpreter.There are three locations where you can store your interpreter group, name and other information. Zeppelin server tries to find the location below. Next, Zeppelin tries to find interpreter-setting.json in your interpreter jar.{ZEPPELIN_INTERPRETER_DIR}/{YOUR_OWN_INTERPRETER_DIR}/interpreter-setting.jsonHere is an example of interpreter-setting.json on your own interpreter.[ { &quot;group&quot;: &quot;your-group&quot;, &quot;name&quot;: &quot;your-name&quot;, &quot;className&quot;: &quot;your.own.interpreter.class&quot;, &quot;properties&quot;: { &quot;properties1&quot;: { &quot;envName&quot;: null, &quot;propertyName&quot;: &quot;property.1.name&quot;, &quot;defaultValue&quot;: &quot;propertyDefaultValue&quot;, &quot;description&quot;: &quot;Property description&quot; }, &quot;p
roperties2&quot;: { &quot;envName&quot;: PROPERTIES_2, &quot;propertyName&quot;: null, &quot;defaultValue&quot;: &quot;property2DefaultValue&quot;, &quot;description&quot;: &quot;Property 2 description&quot; }, ... }, &quot;editor&quot;: { &quot;language&quot;: &quot;your-syntax-highlight-language&quot;, &quot;editOnDblClick&quot;: false } }, { ... }]Finally, Zeppelin uses static initialization with the following:static { Interpreter.register(&quot;MyInterpreterName&quot;, MyClassName.class.getName());}Static initialization is deprecated and will be supported until 0.6.0.The name will appear later in the interpreter name option box during the interpreter configuration process.The name of the interpreter is what you later write to identify a paragraph which should be interpreted using this interpreter.%MyInterpreterNamesome interpreter
specific code...Editor setting for InterpreterYou can add editor object to interpreter-setting.json file to specify paragraph editor settings.LanguageIf 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 note 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.If you want to add a new set of syntax highlighting, Add the mode-*.js file to zeppelin-web/bower.json (when built, zeppelin-web/src/index.html will be changed automatically).Add language field to editor object. Note that if you don&#39;t specify language field, your interpreter will use plain text mode for syntax highlighting. Let&#39;s say you want to set your language to java, then add:&quot;editor&quot;: { &quot;language&quot;: &quot;java&quot;}E
dit on double clickIf your interpreter uses mark-up language such as markdown or HTML, set editOnDblClick to true so that text editor opens on pargraph double click and closes on paragraph run. Otherwise set it to false.&quot;editor&quot;: { &quot;editOnDblClick&quot;: false}Install your interpreter binaryOnce you have built your interpreter, you can place it under the interpreter directory with all its dependencies.[ZEPPELIN_HOME]/interpreter/[INTERPRETER_NAME]/Configure your interpreterTo configure your interpreter you need to follow these steps:Add your interpreter class name to the zeppelin.interpreters property in conf/zeppelin-site.xml.Property value is comma separated [INTERPRETER_CLASS_NAME].For example,&lt;property&gt;&lt;name&gt;zeppelin.interpreters&lt;/name&gt;&lt;value&gt;org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppeli
n.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter&lt;/value&gt;&lt;/property&gt;Add your interpreter to the default configuration which is used when there is no zeppelin-site.xml.Start Zeppelin by running ./bin/zeppelin-daemon.sh start.In the interpreter page, click the +Create button and configure your interpreter properties.Now you are done and ready to use your interpreter.Note : Interpreters released with zeppelin have a default configuration which is used when there is no conf/zeppelin-site.xml.Use your interpreter0.5.0Inside of a note, %[INTERPRETER_NAME] directive will call your interpreter.Note that the first interpreter configuration in zeppelin.interpreters will be the default one.For example,%myintpval a = &quot;My interpreter&quot;println(a)0.6.0 and laterInside of a note, %[INTERPRETER_GROUP].[INTERPRETER_NAME] directive will cal
l your interpreter.You can omit either [INTERPRETER_GROUP] or [INTERPRETER_NAME]. If you omit [INTERPRETER_NAME], then first available interpreter will be selected in the [INTERPRETER_GROUP].Likewise, if you skip [INTERPRETER_GROUP], then [INTERPRETER_NAME] will be chosen from default interpreter group.For example, if you have two interpreter myintp1 and myintp2 in group mygrp, you can call myintp1 like%mygrp.myintp1codes for myintp1and you can call myintp2 like%mygrp.myintp2codes for myintp2If you omit your interpreter name, it&#39;ll select first available interpreter in the group ( myintp1 ).%mygrpcodes for myintp1You can only omit your interpreter group when your interpreter group is selected as a default group.%myintp2codes for myintp2ExamplesCheckout some interpreters released with Zeppelin by default.sparkmarkdownshelljdbcContributing a new Interpreter to Zeppelin releasesWe welcome contribution to a new interpreter. Please follow these few steps:First, check out the gene
ral contribution guide here.Follow the steps in Make your own Interpreter section and Editor setting for Interpreter above.Add your interpreter as in the Configure your interpreter section above; also add it to the example template zeppelin-site.xml.template.Add tests! They are run by Travis for all changes and it is important that they are self-contained.Include your interpreter as a module in pom.xml.Add documentation on how to use your interpreter under docs/interpreter/. Follow the Markdown style as this example. 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.Commit your changes and open a Pull Request on
the project Mirror on GitHub; check to make sure Travis CI build is passing.",
"url": " /development/writingzeppelininterpreter.html",
"group": "development",
"excerpt": "Apache Zeppelin Interpreter is a language backend. Every Interpreters belongs to an InterpreterGroup. Interpreters in the same InterpreterGroup can reference each other."
@@ -60,7 +60,7 @@
"/displaysystem/basicdisplaysystem.html": {
"title": "Basic Display System in Apache Zeppelin",
- "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Basic Display System in Apache ZeppelinTextBy default, Apache Zeppelin prints interpreter responce as a plain text using text display system.You can explicitly say you&#39;re using text display system.HtmlWith %html directive, Zeppelin treats your output as HTMLTableIf you have data that row seprated by &#39;n&#39; (newline) and column separated by &#39;t&#39; (tab) with first row as header row, for exampleYou c
an simply use %table display system to leverage Zeppelin&#39;s built in visualization.If table contents start with %html, it is interpreted as an HTML.Note : Display system is backend independent.",
+ "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Basic Display System in Apache ZeppelinTextBy default, Apache Zeppelin prints interpreter response as a plain text using text display system.You can explicitly say you&#39;re using text display system.HtmlWith %html directive, Zeppelin treats your output as HTMLTableIf you have data that row separated by &#39;n&#39; (newline) and column separated by &#39;t&#39; (tab) with first row as header row, for exampleYou
can simply use %table display system to leverage Zeppelin&#39;s built in visualization.If table contents start with %html, it is interpreted as an HTML.Note : Display system is backend independent.",
"url": " /displaysystem/basicdisplaysystem.html",
"group": "display",
"excerpt": "There are 3 basic display systems in Apache Zeppelin. By default, Zeppelin prints interpreter responce as a plain text using text display system. With %html directive, Zeppelin treats your output as HTML. You can also simply use %table display system..."
@@ -94,7 +94,7 @@
"/install/install.html": {
"title": "Quick Start",
- "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Quick StartWelcome to Apache Zeppelin! On this page are instructions to help you get started.InstallationApache Zeppelin officially supports and is tested on the following environments: Name Value Oracle JDK 1.7 (set JAVA_HOME) OS Mac OSX Ubuntu 14.X CentOS 6.X Windows 7 Pro SP1 To install Apache Zeppelin, you have two options:You can download pre-built binary packages from the archive. This is usua
lly easier than building from source, and you can download the latest stable version (or older versions, if necessary).You can also build from source. This gives you a development version of Zeppelin, which is more unstable but has new features.Downloading Binary PackageStable binary packages are available on the Apache Zeppelin Download Page. You can download a default package with all interpreters, or you can download the net-install package, which lets you choose which interpreters to install.If you downloaded the default package, just unpack it in a directory of your choice and you&#39;re ready to go. If you downloaded the net-install package, you should manually install additional interpreters first. You can also install everything by running ./bin/install-interpreter.sh --all.After unpacking, jump to the Starting Apache Zeppelin with Command Line.Building from SourceIf you want to build from source, you must first install the following dependencies: Name Value
Git (Any Version) Maven 3.1.x or higher If you haven&#39;t installed Git and Maven yet, check the Before Build section and follow the step by step instructions from there.1. Clone the Apache Zeppelin repositorygit clone https://github.com/apache/zeppelin.git2. Build source with optionsEach interpreter requires different build options. For more information about build options, please see the Build section.mvn clean package -DskipTests [Options]Here are some examples with several options:# build with spark-2.0, scala-2.11./dev/change_scala_version.sh 2.11mvn clean package -Pspark-2.0 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11# build with spark-1.6, scala-2.10mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr# spark-cassandra integrationmvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests# with CDHmvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests# with M
apRmvn clean package -Pspark-1.5 -Pmapr50 -DskipTestsFor further information about building from source, please see README.md in the Zeppelin repository.Starting Apache Zeppelin from the Command LineStarting Apache ZeppelinOn all platforms except for Windows:bin/zeppelin-daemon.sh startIf you are using Windows:binzeppelin.cmdAfter Zeppelin has started successfully, go to http://localhost:8080 with your web browser.Stopping Zeppelinbin/zeppelin-daemon.sh stop(Optional) Start Apache Zeppelin with a service managerNote : The below description was written based on Ubuntu Linux.Apache Zeppelin can be auto-started as a service with an init script, using a service manager like upstart.This is an example upstart script saved as /etc/init/zeppelin.confThis allows the service to be managed with commands such assudo service zeppelin start sudo service zeppelin stop sudo service zeppelin restartOther service managers could use a similar approach with the upstart argument passed to the zeppeli
n-daemon.sh script.bin/zeppelin-daemon.sh upstartzeppelin.confdescription &quot;zeppelin&quot;start on (local-filesystems and net-device-up IFACE!=lo)stop on shutdown# Respawn the process on unexpected terminationrespawn# respawn the job up to 7 times within a 5 second period.# If the job exceeds these values, it will be stopped and marked as failed.respawn limit 7 5# zeppelin was installed in /usr/share/zeppelin in this examplechdir /usr/share/zeppelinexec bin/zeppelin-daemon.sh upstartNext Steps:Congratulations, you have successfully installed Apache Zeppelin! Here are two next steps you might find useful:If you are new to Apache Zeppelin...For an in-depth overview of the Apache Zeppelin UI, head to Explore Apache Zeppelin UI.After getting familiar with the Apache Zeppelin UI, have fun with a short walk-through Tutorial that uses the Apache Spark backend.If you need more configuration for Apache Zeppelin, jump to the next section: Apache Zeppelin Configuration.If you need
more information about Spark or JDBC interpreter settings...Apache Zeppelin provides deep integration with Apache Spark. For more information, see Spark Interpreter for Apache Zeppelin.You can also use generic JDBC connections in Apache Zeppelin. Go to Generic JDBC Interpreter for Apache Zeppelin.If you are in a multi-user environment...You can set permissions for your notebooks and secure data resource in a multi-user environment. Go to More -&gt; Security section.Apache Zeppelin ConfigurationYou can configure Apache Zeppelin with either environment variables in conf/zeppelin-env.sh (confzeppelin-env.cmd for Windows) or Java properties in conf/zeppelin-site.xml. If both are defined, then the environment variables will take priority. zeppelin-env.sh zeppelin-site.xml Default value Description ZEPPELIN_PORT zeppelin.server.port 8080 Zeppelin server port ZEPPELIN_SSL_PORT zeppelin.server.ssl.port 8443 Zeppelin Server ssl port (used whe
n ssl environment/property is set to true) ZEPPELIN_MEM N/A -Xmx1024m -XX:MaxPermSize=512m JVM mem options ZEPPELIN_INTP_MEM N/A ZEPPELIN_MEM JVM mem options for interpreter process ZEPPELIN_JAVA_OPTS N/A JVM options ZEPPELIN_ALLOWED_ORIGINS zeppelin.server.allowed.origins * Enables a way to specify a ',' separated list of allowed origins for REST and websockets. i.e. http://localhost:8080 N/A zeppelin.anonymous.allowed true The anonymous user is allowed by default. ZEPPELIN_SERVER_CONTEXT_PATH zeppelin.server.context.path / Context path of the web application ZEPPELIN_SSL zeppelin.ssl false ZEPPELIN_SSL_CLIENT_AUTH zeppelin.ssl.client.auth false ZEPPELIN_SSL_KEYSTORE_PATH zeppelin.ssl.keystore.path keystore ZEPPELIN_SSL_KEYSTORE_TYPE zeppelin.ssl.keystore.type JKS ZEPPELIN_SSL_KEYSTORE_PASSWORD zep
pelin.ssl.keystore.password ZEPPELIN_SSL_KEY_MANAGER_PASSWORD zeppelin.ssl.key.manager.password ZEPPELIN_SSL_TRUSTSTORE_PATH zeppelin.ssl.truststore.path ZEPPELIN_SSL_TRUSTSTORE_TYPE zeppelin.ssl.truststore.type ZEPPELIN_SSL_TRUSTSTORE_PASSWORD zeppelin.ssl.truststore.password ZEPPELIN_NOTEBOOK_HOMESCREEN zeppelin.notebook.homescreen Display note IDs on the Apache Zeppelin homescreen i.e. 2A94M5J1Z ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE zeppelin.notebook.homescreen.hide false Hide the note ID set by ZEPPELIN_NOTEBOOK_HOMESCREEN on the Apache Zeppelin homescreen. For the further information, please read Customize your Zeppelin homepage. ZEPPELIN_WAR_TEMPDIR zeppelin.war.tempdir webapps Location of the jetty temporary directory ZEPPELIN_NOTEBOOK_DIR zeppelin.notebook.dir notebook The root directory where notebook directories are saved ZEPPE
LIN_NOTEBOOK_S3_BUCKET zeppelin.notebook.s3.bucket zeppelin S3 Bucket where notebook files will be saved ZEPPELIN_NOTEBOOK_S3_USER zeppelin.notebook.s3.user user User name of an S3 bucketi.e. bucket/user/notebook/2A94M5J1Z/note.json ZEPPELIN_NOTEBOOK_S3_ENDPOINT zeppelin.notebook.s3.endpoint s3.amazonaws.com Endpoint for the bucket ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID zeppelin.notebook.s3.kmsKeyID AWS KMS Key ID to use for encrypting data in S3 (optional) ZEPPELIN_NOTEBOOK_S3_EMP zeppelin.notebook.s3.encryptionMaterialsProvider Class name of a custom S3 encryption materials provider implementation to use for encrypting data in S3 (optional) ZEPPELIN_NOTEBOOK_AZURE_CONNECTION_STRING zeppelin.notebook.azure.connectionString The Azure storage account connection stringi.e. DefaultEndpointsProtocol=https;AccountName=&lt;accountName&gt;;AccountKey=&lt;accountKey&gt; ZEPPELIN_NOTEB
OOK_AZURE_SHARE zeppelin.notebook.azure.share zeppelin Azure Share where the notebook files will be saved ZEPPELIN_NOTEBOOK_AZURE_USER zeppelin.notebook.azure.user user Optional user name of an Azure file sharei.e. share/user/notebook/2A94M5J1Z/note.json ZEPPELIN_NOTEBOOK_STORAGE zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.VFSNotebookRepo Comma separated list of notebook storage locations ZEPPELIN_NOTEBOOK_ONE_WAY_SYNC zeppelin.notebook.one.way.sync false If there are multiple notebook storage locations, should we treat the first one as the only source of truth? ZEPPELIN_INTERPRETERS zeppelin.interpreters org.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 int
erpreter configurations [Class] NOTE: This property is deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0 on. ZEPPELIN_INTERPRETER_DIR zeppelin.interpreter.dir interpreter Interpreter directory ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE zeppelin.websocket.max.text.message.size 1024000 Size (in characters) of the maximum text message that can be received by websocket. ",
+ "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Quick StartWelcome to Apache Zeppelin! On this page are instructions to help you get started.InstallationApache Zeppelin officially supports and is tested on the following environments: Name Value Oracle JDK 1.7 (set JAVA_HOME) OS Mac OSX Ubuntu 14.X CentOS 6.X Windows 7 Pro SP1 To install Apache Zeppelin, you have two options:You can download pre-built binary packages from the archive. This is usua
lly easier than building from source, and you can download the latest stable version (or older versions, if necessary).You can also build from source. This gives you a development version of Zeppelin, which is more unstable but has new features.Downloading Binary PackageStable binary packages are available on the Apache Zeppelin Download Page. You can download a default package with all interpreters, or you can download the net-install package, which lets you choose which interpreters to install.If you downloaded the default package, just unpack it in a directory of your choice and you&#39;re ready to go. If you downloaded the net-install package, you should manually install additional interpreters first. You can also install everything by running ./bin/install-interpreter.sh --all.After unpacking, jump to the Starting Apache Zeppelin from Command Line.Building from SourceIf you want to build from source, you must first install the following dependencies: Name Value
Git (Any Version) Maven 3.1.x or higher If you haven&#39;t installed Git and Maven yet, check the Before Build section and follow the step by step instructions from there.1. Clone the Apache Zeppelin repositorygit clone https://github.com/apache/zeppelin.git2. Build source with optionsEach interpreter requires different build options. For more information about build options, please see the Build section.mvn clean package -DskipTests [Options]Here are some examples with several options:# build with spark-2.0, scala-2.11./dev/change_scala_version.sh 2.11mvn clean package -Pspark-2.0 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11# build with spark-1.6, scala-2.10mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr# spark-cassandra integrationmvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests# with CDHmvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests# with M
apRmvn clean package -Pspark-1.5 -Pmapr50 -DskipTestsFor further information about building from source, please see README.md in the Zeppelin repository.Starting Apache Zeppelin from the Command LineStarting Apache ZeppelinOn all platforms except for Windows:bin/zeppelin-daemon.sh startIf you are using Windows:binzeppelin.cmdAfter Zeppelin has started successfully, go to http://localhost:8080 with your web browser.Stopping Zeppelinbin/zeppelin-daemon.sh stop(Optional) Start Apache Zeppelin with a service managerNote : The below description was written based on Ubuntu Linux.Apache Zeppelin can be auto-started as a service with an init script, using a service manager like upstart.This is an example upstart script saved as /etc/init/zeppelin.confThis allows the service to be managed with commands such assudo service zeppelin start sudo service zeppelin stop sudo service zeppelin restartOther service managers could use a similar approach with the upstart argument passed to the zeppeli
n-daemon.sh script.bin/zeppelin-daemon.sh upstartzeppelin.confdescription &quot;zeppelin&quot;start on (local-filesystems and net-device-up IFACE!=lo)stop on shutdown# Respawn the process on unexpected terminationrespawn# respawn the job up to 7 times within a 5 second period.# If the job exceeds these values, it will be stopped and marked as failed.respawn limit 7 5# zeppelin was installed in /usr/share/zeppelin in this examplechdir /usr/share/zeppelinexec bin/zeppelin-daemon.sh upstartNext StepsCongratulations, you have successfully installed Apache Zeppelin! Here are two next steps you might find useful:If you are new to Apache Zeppelin...For an in-depth overview of the Apache Zeppelin UI, head to Explore Apache Zeppelin UI.After getting familiar with the Apache Zeppelin UI, have fun with a short walk-through Tutorial that uses the Apache Spark backend.If you need more configuration for Apache Zeppelin, jump to the next section: Apache Zeppelin Configuration.If you need m
ore information about Spark or JDBC interpreter settings...Apache Zeppelin provides deep integration with Apache Spark. For more information, see Spark Interpreter for Apache Zeppelin.You can also use generic JDBC connections in Apache Zeppelin. Go to Generic JDBC Interpreter for Apache Zeppelin.If you are in a multi-user environment...You can set permissions for your notebooks and secure data resource in a multi-user environment. Go to More -&gt; Security section.Apache Zeppelin ConfigurationYou can configure Apache Zeppelin with either environment variables in conf/zeppelin-env.sh (confzeppelin-env.cmd for Windows) or Java properties in conf/zeppelin-site.xml. If both are defined, then the environment variables will take priority. zeppelin-env.sh zeppelin-site.xml Default value Description ZEPPELIN_PORT zeppelin.server.port 8080 Zeppelin server port ZEPPELIN_SSL_PORT zeppelin.server.ssl.port 8443 Zeppelin Server ssl port (used when
ssl environment/property is set to true) ZEPPELIN_MEM N/A -Xmx1024m -XX:MaxPermSize=512m JVM mem options ZEPPELIN_INTP_MEM N/A ZEPPELIN_MEM JVM mem options for interpreter process ZEPPELIN_JAVA_OPTS N/A JVM options ZEPPELIN_ALLOWED_ORIGINS zeppelin.server.allowed.origins * Enables a way to specify a ',' separated list of allowed origins for REST and websockets. i.e. http://localhost:8080 N/A zeppelin.anonymous.allowed true The anonymous user is allowed by default. ZEPPELIN_SERVER_CONTEXT_PATH zeppelin.server.context.path / Context path of the web application ZEPPELIN_SSL zeppelin.ssl false ZEPPELIN_SSL_CLIENT_AUTH zeppelin.ssl.client.auth false ZEPPELIN_SSL_KEYSTORE_PATH zeppelin.ssl.keystore.path keystore ZEPPELIN_SSL_KEYSTORE_TYPE zeppelin.ssl.keystore.type JKS ZEPPELIN_SSL_KEYSTORE_PASSWORD zepp
elin.ssl.keystore.password ZEPPELIN_SSL_KEY_MANAGER_PASSWORD zeppelin.ssl.key.manager.password ZEPPELIN_SSL_TRUSTSTORE_PATH zeppelin.ssl.truststore.path ZEPPELIN_SSL_TRUSTSTORE_TYPE zeppelin.ssl.truststore.type ZEPPELIN_SSL_TRUSTSTORE_PASSWORD zeppelin.ssl.truststore.password ZEPPELIN_NOTEBOOK_HOMESCREEN zeppelin.notebook.homescreen Display note IDs on the Apache Zeppelin homescreen i.e. 2A94M5J1Z ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE zeppelin.notebook.homescreen.hide false Hide the note ID set by ZEPPELIN_NOTEBOOK_HOMESCREEN on the Apache Zeppelin homescreen. For the further information, please read Customize your Zeppelin homepage. ZEPPELIN_WAR_TEMPDIR zeppelin.war.tempdir webapps Location of the jetty temporary directory ZEPPELIN_NOTEBOOK_DIR zeppelin.notebook.dir notebook The root directory where notebook directories are saved ZEPPEL
IN_NOTEBOOK_S3_BUCKET zeppelin.notebook.s3.bucket zeppelin S3 Bucket where notebook files will be saved ZEPPELIN_NOTEBOOK_S3_USER zeppelin.notebook.s3.user user User name of an S3 bucketi.e. bucket/user/notebook/2A94M5J1Z/note.json ZEPPELIN_NOTEBOOK_S3_ENDPOINT zeppelin.notebook.s3.endpoint s3.amazonaws.com Endpoint for the bucket ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID zeppelin.notebook.s3.kmsKeyID AWS KMS Key ID to use for encrypting data in S3 (optional) ZEPPELIN_NOTEBOOK_S3_EMP zeppelin.notebook.s3.encryptionMaterialsProvider Class name of a custom S3 encryption materials provider implementation to use for encrypting data in S3 (optional) ZEPPELIN_NOTEBOOK_AZURE_CONNECTION_STRING zeppelin.notebook.azure.connectionString The Azure storage account connection stringi.e. DefaultEndpointsProtocol=https;AccountName=&lt;accountName&gt;;AccountKey=&lt;accountKey&gt; ZEPPELIN_NOTEBO
OK_AZURE_SHARE zeppelin.notebook.azure.share zeppelin Azure Share where the notebook files will be saved ZEPPELIN_NOTEBOOK_AZURE_USER zeppelin.notebook.azure.user user Optional user name of an Azure file sharei.e. share/user/notebook/2A94M5J1Z/note.json ZEPPELIN_NOTEBOOK_STORAGE zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.VFSNotebookRepo Comma separated list of notebook storage locations ZEPPELIN_NOTEBOOK_ONE_WAY_SYNC zeppelin.notebook.one.way.sync false If there are multiple notebook storage locations, should we treat the first one as the only source of truth? ZEPPELIN_INTERPRETERS zeppelin.interpreters org.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 inte
rpreter configurations [Class] NOTE: This property is deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0 on. ZEPPELIN_INTERPRETER_DIR zeppelin.interpreter.dir interpreter Interpreter directory ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE zeppelin.websocket.max.text.message.size 1024000 Size (in characters) of the maximum text message that can be received by websocket. ",
"url": " /install/install.html",
"group": "install",
"excerpt": "This page will help you get started and will guide you through installing Apache Zeppelin, running it in the command line and configuring options."
@@ -116,7 +116,7 @@
"/install/upgrade.html": {
"title": "Manual Zeppelin version upgrade procedure",
- "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Manual upgrade procedure for ZeppelinBasically, newer version of Zeppelin works with previous version notebook directory and configurations.So, copying notebook and conf directory should be enough.InstructionsStop Zeppelinbin/zeppelin-daemon.sh stopCopy your notebook and conf directory into a backup directoryDownload newer version of Zeppelin and Install. See Install page.Copy backup notebook and conf directory into newer version o
f Zeppelin notebook and conf directoryStart Zeppelinbin/zeppelin-daemon.sh startMigration GuideUpgrading from Zeppelin 0.6 to 0.7From 0.7, we don&#39;t use ZEPPELIN_JAVA_OPTS as default value of ZEPPELIN_INTP_JAVA_OPTS and also the same for ZEPPELIN_MEM/ZEPPELIN_INTP_MEM. If user want to configure the jvm opts of interpreter process, please set ZEPPELIN_INTP_JAVA_OPTS and ZEPPELIN_INTP_MEM explicitly. If you don&#39;t set ZEPPELIN_INTP_MEM, Zeppelin will set it to -Xms1024m -Xmx1024m -XX:MaxPermSize=512m by default.Mapping from %jdbc(prefix) to %prefix is no longer available. Instead, you can use %[interpreter alias] with multiple interpreter setttings on GUI.Usage of ZEPPELIN_PORT is not supported in ssl mode. Instead use ZEPPELIN_SSL_PORT to configure the ssl port. Value from ZEPPELIN_PORT is used only when ZEPPELIN_SSL is set to false.",
+ "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Manual upgrade procedure for ZeppelinBasically, newer version of Zeppelin works with previous version notebook directory and configurations.So, copying notebook and conf directory should be enough.InstructionsStop Zeppelinbin/zeppelin-daemon.sh stopCopy your notebook and conf directory into a backup directoryDownload newer version of Zeppelin and Install. See Install page.Copy backup notebook and conf directory into newer version o
f Zeppelin notebook and conf directoryStart Zeppelinbin/zeppelin-daemon.sh startMigration GuideUpgrading from Zeppelin 0.6 to 0.7From 0.7, we don&#39;t use ZEPPELIN_JAVA_OPTS as default value of ZEPPELIN_INTP_JAVA_OPTS and also the same for ZEPPELIN_MEM/ZEPPELIN_INTP_MEM. If user want to configure the jvm opts of interpreter process, please set ZEPPELIN_INTP_JAVA_OPTS and ZEPPELIN_INTP_MEM explicitly. If you don&#39;t set ZEPPELIN_INTP_MEM, Zeppelin will set it to -Xms1024m -Xmx1024m -XX:MaxPermSize=512m by default.Mapping from %jdbc(prefix) to %prefix is no longer available. Instead, you can use %[interpreter alias] with multiple interpreter setttings on GUI.Usage of ZEPPELIN_PORT is not supported in ssl mode. Instead use ZEPPELIN_SSL_PORT to configure the ssl port. Value from ZEPPELIN_PORT is used only when ZEPPELIN_SSL is set to false.The support on Spark 1.1.x to 1.3.x is deprecated.",
"url": " /install/upgrade.html",
"group": "install",
"excerpt": "This document will guide you through a procedure of manual upgrade your Apache Zeppelin instance to a newer version. Apache Zeppelin keeps backward compatibility for the notebook file format."
@@ -524,7 +524,7 @@
"/rest-api/rest-interpreter.html": {
"title": "Apache Zeppelin Interpreter REST API",
- "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Apache Zeppelin Interpreter REST APIOverviewApache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.If you work with Apache Zeppelin
and find a need for an additional REST API, please file an issue or send us an email.Interpreter REST API ListThe role of registered interpreters, settings and interpreters group are described in here.List of registered interpreters Description This GET method returns all the registered interpreters available on the server. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;md.md&quot;: { &quot;name&quot;: &quot;md&quot;, &quot;group&quot;: &quot;md&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;properties&quot;: {}, &quot;path&quot;: &quot;/z
eppelin/interpreter/md&quot; }, &quot;spark.spark&quot;: { &quot;name&quot;: &quot;spark&quot;, &quot;group&quot;: &quot;spark&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.spark.SparkInterpreter&quot;, &quot;properties&quot;: { &quot;spark.executor.memory&quot;: { &quot;defaultValue&quot;: &quot;1g&quot;, &quot;description&quot;: &quot;Executor memory per worker instance. ex) 512m, 32g&quot; }, &quot;spark.cores.max&quot;: { &quot;defaultValue&quot;: &quot;&quot;, &quot;description&quot;: &quot;Total number of cores to use. Empty value uses all available core.&quot; }, }, &quot;path&quot;: &quot;/zeppelin/interpreter/spark&quot; }, &quot;spark.sql&quot;: { &quot;name&quot;: &quot;sq
l&quot;, &quot;group&quot;: &quot;spark&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.spark.SparkSqlInterpreter&quot;, &quot;properties&quot;: { &quot;zeppelin.spark.maxResult&quot;: { &quot;defaultValue&quot;: &quot;1000&quot;, &quot;description&quot;: &quot;Max number of Spark SQL result to display.&quot; } }, &quot;path&quot;: &quot;/zeppelin/interpreter/spark&quot; } }} List of registered interpreter settings Description This GET method returns all the interpreters settings registered on the server. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&
;quot;: &quot;&quot;, &quot;body&quot;: [ { &quot;id&quot;: &quot;2AYUGP2D5&quot;, &quot;name&quot;: &quot;md&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;empty&quot;: &quot;&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [] }, { &quot;id&quot;: &quot;2AY6GV7Q3&quot;, &quot;name&quot;: &quot;spark&quot;, &quot;group&quot;: &quot;spark&quot;, &quot;properties&quot;: { &quot;spark.cores.max&quot;: &quot;&quot;, &quot;spark.executor.memory&quot;: &quot;1g&quot;, }, &quot;inte
rpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.spark.SparkInterpreter&quot;, &quot;name&quot;: &quot;spark&quot; }, { &quot;class&quot;: &quot;org.apache.zeppelin.spark.SparkSqlInterpreter&quot;, &quot;name&quot;: &quot;sql&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;com.databricks:spark-csv_2.10:1.3.0&quot; } ] } ]} Create a new interpreter setting Description This POST method adds a new interpreter setting using a registered interpreter to the server. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting Success code 201 Fail code 400 if the input json is empty 500 for any other errors
Sample JSON input { &quot;name&quot;: &quot;Markdown setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;propvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ]} Sample JSON response { &quot;status&quot;: &quot;CREATED&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;id&quot;: &quot;2AYW25ANY&quot;, &quot;name&quot;: &quot;Mar
kdown setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;propvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ] }} Update an interpreter setting Description This PUT method updates an interpreter setting with new properties. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID] Success code 200 Fail code 500 Sam
ple JSON input { &quot;name&quot;: &quot;Markdown setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;Otherpropvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ]} Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;id&quot;: &quot;2AYW25ANY&quot;, &quot;name&quot;: &quot;Markdo
wn setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;Otherpropvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ] }} Delete an interpreter setting Description This DELETE method deletes an given interpreter setting. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID] Success code 200 Fail code 500 Sample JSON
response {&quot;status&quot;:&quot;OK&quot;} Restart an interpreter Description This PUT method restarts the given interpreter id. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID] Success code 200 Fail code 500 Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Add a new repository for dependency resolving Description This POST method adds new repository. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository Success code 201 Fail code 500 Sample JSON input { &quot;id&quot;: &quot;securecentral&quot;, &quot;url&quot;: &quot;https://repo1.maven.org/maven2&quot;, &quot;snapshot&quot;: false}
Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Delete a repository for dependency resolving Description This DELETE method delete repository with given id. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID] Success code 200 Fail code 500 ",
+ "content" : "<!--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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Apache Zeppelin Interpreter REST APIOverviewApache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.If you work with Apache Zeppelin
and find a need for an additional REST API, please file an issue or send us an email.Interpreter REST API ListThe role of registered interpreters, settings and interpreters group are described in here.List of registered interpreters Description This GET method returns all the registered interpreters available on the server. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;md.md&quot;: { &quot;name&quot;: &quot;md&quot;, &quot;group&quot;: &quot;md&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;properties&quot;: {}, &quot;path&quot;: &quot;/z
eppelin/interpreter/md&quot; }, &quot;spark.spark&quot;: { &quot;name&quot;: &quot;spark&quot;, &quot;group&quot;: &quot;spark&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.spark.SparkInterpreter&quot;, &quot;properties&quot;: { &quot;spark.executor.memory&quot;: { &quot;defaultValue&quot;: &quot;1g&quot;, &quot;description&quot;: &quot;Executor memory per worker instance. ex) 512m, 32g&quot; }, &quot;spark.cores.max&quot;: { &quot;defaultValue&quot;: &quot;&quot;, &quot;description&quot;: &quot;Total number of cores to use. Empty value uses all available core.&quot; }, }, &quot;path&quot;: &quot;/zeppelin/interpreter/spark&quot; }, &quot;spark.sql&quot;: { &quot;name&quot;: &quot;sq
l&quot;, &quot;group&quot;: &quot;spark&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.spark.SparkSqlInterpreter&quot;, &quot;properties&quot;: { &quot;zeppelin.spark.maxResult&quot;: { &quot;defaultValue&quot;: &quot;1000&quot;, &quot;description&quot;: &quot;Max number of Spark SQL result to display.&quot; } }, &quot;path&quot;: &quot;/zeppelin/interpreter/spark&quot; } }} List of registered interpreter settings Description This GET method returns all the interpreters settings registered on the server. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&
;quot;: &quot;&quot;, &quot;body&quot;: [ { &quot;id&quot;: &quot;2AYUGP2D5&quot;, &quot;name&quot;: &quot;md&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;empty&quot;: &quot;&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [] }, { &quot;id&quot;: &quot;2AY6GV7Q3&quot;, &quot;name&quot;: &quot;spark&quot;, &quot;group&quot;: &quot;spark&quot;, &quot;properties&quot;: { &quot;spark.cores.max&quot;: &quot;&quot;, &quot;spark.executor.memory&quot;: &quot;1g&quot;, }, &quot;inte
rpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.spark.SparkInterpreter&quot;, &quot;name&quot;: &quot;spark&quot; }, { &quot;class&quot;: &quot;org.apache.zeppelin.spark.SparkSqlInterpreter&quot;, &quot;name&quot;: &quot;sql&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;com.databricks:spark-csv_2.10:1.3.0&quot; } ] } ]} Create a new interpreter setting Description This POST method adds a new interpreter setting using a registered interpreter to the server. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting Success code 201 Fail code 400 if the input json is empty 500 for any other errors
Sample JSON input { &quot;name&quot;: &quot;Markdown setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;propvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ]} Sample JSON response { &quot;status&quot;: &quot;CREATED&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;id&quot;: &quot;2AYW25ANY&quot;, &quot;name&quot;: &quot;Mar
kdown setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;propvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ] }} Update an interpreter setting Description This PUT method updates an interpreter setting with new properties. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID] Success code 200 Fail code 500 Sam
ple JSON input { &quot;name&quot;: &quot;Markdown setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;Otherpropvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ]} Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;id&quot;: &quot;2AYW25ANY&quot;, &quot;name&quot;: &quot;Markdo
wn setting name&quot;, &quot;group&quot;: &quot;md&quot;, &quot;properties&quot;: { &quot;propname&quot;: &quot;Otherpropvalue&quot; }, &quot;interpreterGroup&quot;: [ { &quot;class&quot;: &quot;org.apache.zeppelin.markdown.Markdown&quot;, &quot;name&quot;: &quot;md&quot; } ], &quot;dependencies&quot;: [ { &quot;groupArtifactVersion&quot;: &quot;groupId:artifactId:version&quot;, &quot;exclusions&quot;: [ &quot;groupId:artifactId&quot; ] } ] }} Delete an interpreter setting Description This DELETE method deletes an given interpreter setting. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID] Success code 200 Fail code 500 Sample JSON
response {&quot;status&quot;:&quot;OK&quot;} Restart an interpreter Description This PUT method restarts the given interpreter id. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID] Success code 200 Fail code 500 Sample JSON input (Optional) { &quot;noteId&quot;: &quot;2AVQJVC8N&quot;} Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Add a new repository for dependency resolving Description This POST method adds new repository. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository Success code 201 Fail code 500 Sample JSON input { &quot;id&quot;: &quot;securecentral&quot;, &
quot;url&quot;: &quot;https://repo1.maven.org/maven2&quot;, &quot;snapshot&quot;: false} Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Delete a repository for dependency resolving Description This DELETE method delete repository with given id. URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID] Success code 200 Fail code 500 ",
"url": " /rest-api/rest-interpreter.html",
"group": "rest-api",
"excerpt": "This page contains Apache Zeppelin Interpreter REST API information."
@@ -535,7 +535,7 @@
"/rest-api/rest-notebook.html": {
"title": "Apache Zeppelin Notebook REST API",
[... 24 lines stripped ...]
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/security/authentication.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/security/authentication.html?rev=1768149&r1=1768148&r2=1768149&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/security/authentication.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/security/authentication.html Sat Nov 5 04:49:29 2016
@@ -264,7 +264,7 @@ server {
}
location /ws { # For websocket support
- proxy_pass http://zeppelin;
+ proxy_pass http://zeppelin/ws;
proxy_http_version 1.1;
proxy_set_header Upgrade websocket;
proxy_set_header Connection upgrade;