Author: moon
Date: Fri Jul 17 16:38:22 2015
New Revision: 1691607
URL: http://svn.apache.org/r1691607
Log:
Updated by https://github.com/apache/incubator-zeppelin/pull/155
Modified:
incubator/zeppelin/site/atom.xml
incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
incubator/zeppelin/site/rss.xml
Modified: incubator/zeppelin/site/atom.xml
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/atom.xml?rev=1691607&r1=1691606&r2=1691607&view=diff
==============================================================================
--- incubator/zeppelin/site/atom.xml (original)
+++ incubator/zeppelin/site/atom.xml Fri Jul 17 16:38:22 2015
@@ -4,7 +4,7 @@
<title>Zeppelin</title>
<link href="http://zeppelin-project.org/"; rel="self"/>
<link href="http://zeppelin-project.org"/>
- <updated>2015-06-27T11:07:27-07:00</updated>
+ <updated>2015-07-17T09:37:36-07:00</updated>
<id>http://zeppelin-project.org</id>
<author>
<name>The Apache Software Foundation</name>
Modified:
incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html?rev=1691607&r1=1691606&r2=1691607&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
(original)
+++ incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
Fri Jul 17 16:38:22 2015
@@ -237,7 +237,7 @@ Interpreters in the same InterpreterGrou
<p><img class="img-responsive" style="width:50%; border: 1px solid #ecf0f1;"
height="auto" src="../../assets/themes/zeppelin/img/interpreter.png" /></p>
-<p>Interpreter can be launched either using separate classloader or separate
JVM process. Sometimes separate classloader causes problem especially when your
interpreter uses reflections or trying to grab standard out/err. In this case,
separate JVM process is the option you can select. (by checking 'fork'
in Interpreter menu, which is default value) When Interpreter is running in
separate JVM process, it's communicating with Zeppelin via thrift.</p>
+<p>All Interpreters in the same interpreter group are launched in a single,
separate JVM process. The Interpreter communicates with Zeppelin engine via
thrift.</p>
<h3>Make your own Interpreter</h3>
@@ -245,6 +245,17 @@ Interpreters in the same InterpreterGrou
<p>You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact
in your build system.</p>
+<p>Your interpreter name is derived from the static register method</p>
+<div class="highlight"><pre><code class="text language-text"
data-lang="text">static {
+ Interpreter.register("MyInterpreterName",
MyClassName.class.getName());
+ }
+</code></pre></div>
+<p>The name will appear later in the interpreter name option box during the
interpreter configuration process.</p>
+
+<p>The name of the interpreter is what you later write to identify a paragraph
which should be interpreted using this interpreter.</p>
+<div class="highlight"><pre><code class="text language-text"
data-lang="text">%MyInterpreterName
+some interpreter spesific code...
+</code></pre></div>
<h3>Install your interpreter binary</h3>
<p>Once you have build your interpreter, you can place your interpreter under
directory with all the dependencies.</p>
@@ -252,15 +263,26 @@ Interpreters in the same InterpreterGrou
</code></pre></div>
<h3>Configure your interpreter</h3>
-<p>You can configure zeppelin.interpreters property in conf/zeppelin-site.xml
-Property value is comma separated [INTERPRETER<em>CLASS</em>NAME]</p>
+<p>To configure your interpreter you need to follow these steps:</p>
+
+<ol>
+<li><p>create conf/zeppelin-site.xml by copying
conf/zeppelin-site.xml.template to conf/zeppelin-site.xml </p></li>
+<li><p>Add your interpreter class name to the zeppelin.interpreters property
in conf/zeppelin-site.xml</p>
-<p>for example, </p>
+<p>Property value is comma separated [INTERPRETER<em>CLASS</em>NAME]
+for example,</p>
<div class="highlight"><pre><code class="text language-text"
data-lang="text"><property>
- <name>zeppelin.interpreters</name>
-
<value>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</value>
+<name>zeppelin.interpreters</name>
+<value>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</value>
</property>
-</code></pre></div>
+</code></pre></div></li>
+<li><p>start zeppelin by running <code>./bin/zeppelin-deamon
start</code></p></li>
+<li><p>in the interpreter page, click the +Create button and configure your
interpreter properties.
+Now you are done and ready to use your interpreter.</p></li>
+</ol>
+
+<p>Note that the interpreters shipped with zeppelin have a <a
href="https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397";>default
configuration</a> which is used when there is no zeppelin-site.xml.</p>
+
<h3>Use your interpreter</h3>
<h4>0.5.0</h4>
@@ -278,11 +300,11 @@ println(a)
<h4>0.6.0 and later</h4>
-<p>Inside of a noteobok, %[INTERPRETER_GROUP].[INTERPRETER_NAME] directive
will call your interpreter.
+<p>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.</p>
<p>You can omit either [INTERPRETER_GROUP] or [INTERPRETER_NAME]. Omit
[INTERPRETER_NAME] selects first available interpreter in the
[INTERPRETER_GROUP].
-Omit '[INTERPRETER_GROUP]' will selects [INTERPRETER_NAME] from
defualt interpreter group.</p>
+Omit '[INTERPRETER_GROUP]' will selects [INTERPRETER_NAME] from
default interpreter group.</p>
<p>For example, if you have two interpreter myintp1 and myintp2 in group
mygrp,</p>
@@ -296,12 +318,12 @@ codes for myintp1
codes for myintp2
</code></pre></div>
-<p>If you ommit your interpreter name, it'll selects first available
interpreter in the group (myintp1)</p>
+<p>If you omit your interpreter name, it'll selects first available
interpreter in the group (myintp1)</p>
<div class="highlight"><pre><code class="text language-text"
data-lang="text">%mygrp
codes for myintp1
</code></pre></div>
-<p>You can only ommit your interpreter group when your interpreter group is
selected as a default group.</p>
+<p>You can only omit your interpreter group when your interpreter group is
selected as a default group.</p>
<div class="highlight"><pre><code class="text language-text"
data-lang="text">%myintp2
codes for myintp2
Modified: incubator/zeppelin/site/rss.xml
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/rss.xml?rev=1691607&r1=1691606&r2=1691607&view=diff
==============================================================================
--- incubator/zeppelin/site/rss.xml (original)
+++ incubator/zeppelin/site/rss.xml Fri Jul 17 16:38:22 2015
@@ -5,8 +5,8 @@
<description>Zeppelin - The Apache Software Foundation</description>
<link>http://zeppelin-project.org</link>
<link>http://zeppelin-project.org</link>
- <lastBuildDate>2015-06-27T11:07:27-07:00</lastBuildDate>
- <pubDate>2015-06-27T11:07:27-07:00</pubDate>
+ <lastBuildDate>2015-07-17T09:37:36-07:00</lastBuildDate>
+ <pubDate>2015-07-17T09:37:36-07:00</pubDate>
<ttl>1800</ttl>
