You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2017/05/15 15:03:56 UTC
svn commit: r1795220 [1/2] - in /zeppelin/site/docs/0.8.0-SNAPSHOT: ./
assets/themes/zeppelin/img/screenshots/ displaysystem/ install/
interpreter/ manual/ quickstart/ security/
Author: moon
Date: Mon May 15 15:03:55 2017
New Revision: 1795220
URL: http://svn.apache.org/viewvc?rev=1795220&view=rev
Log:
update doc
Added:
zeppelin/site/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/img/screenshots/interpreter_precode.png (with props)
Modified:
zeppelin/site/docs/0.8.0-SNAPSHOT/atom.xml
zeppelin/site/docs/0.8.0-SNAPSHOT/displaysystem/back-end-angular.html
zeppelin/site/docs/0.8.0-SNAPSHOT/install/docker.html
zeppelin/site/docs/0.8.0-SNAPSHOT/install/install.html
zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/groovy.html
zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/jdbc.html
zeppelin/site/docs/0.8.0-SNAPSHOT/manual/dynamicform.html
zeppelin/site/docs/0.8.0-SNAPSHOT/manual/interpreters.html
zeppelin/site/docs/0.8.0-SNAPSHOT/quickstart/explorezeppelinui.html
zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml
zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json
zeppelin/site/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html
Added: zeppelin/site/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/img/screenshots/interpreter_precode.png
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/img/screenshots/interpreter_precode.png?rev=1795220&view=auto
==============================================================================
Binary file - no diff available.
Propchange: zeppelin/site/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/img/screenshots/interpreter_precode.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/atom.xml
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/atom.xml?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/atom.xml (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/atom.xml Mon May 15 15:03:55 2017
@@ -4,7 +4,7 @@
<title>Apache Zeppelin</title>
<link href="http://zeppelin.apache.org/" rel="self"/>
<link href="http://zeppelin.apache.org"/>
- <updated>2017-04-17T15:59:29+09:00</updated>
+ <updated>2017-05-15T08:03:12-07:00</updated>
<id>http://zeppelin.apache.org</id>
<author>
<name>The Apache Software Foundation</name>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/displaysystem/back-end-angular.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/displaysystem/back-end-angular.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/displaysystem/back-end-angular.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/displaysystem/back-end-angular.html Mon May 15 15:03:55 2017
@@ -304,7 +304,7 @@ When the button is clicked, you'll s
</code></pre></div>
<h3>Display Element</h3>
<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="c1">// automatically convert to string and print with %angular display system directive in front.</span>
-<span class="o"><</span><span class="n">div</span><span class="o">><</span><span class="n">div</span><span class="o">>.</span><span class="n">display</span>
+<span class="o"><</span><span class="n">div</span><span class="o">></</span><span class="n">div</span><span class="o">>.</span><span class="n">display</span>
</code></pre></div>
<h3>Event Handler</h3>
<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="c1">// on click</span>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/install/docker.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/install/docker.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/install/docker.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/install/docker.html Mon May 15 15:03:55 2017
@@ -217,7 +217,7 @@ See the License for the specific languag
limitations under the License.
-->
-<h1>Apache Zeppelin Releases Docker Images</h1>
+<h1>Docker Image for Apache Zeppelin Releases</h1>
<div id="toc"></div>
@@ -231,47 +231,27 @@ limitations under the License.
<p>You need to <a href="https://docs.docker.com/engine/installation/">install docker</a> on your machine.</p>
-<h3>Creating and Publishing Zeppelin docker image</h3>
-
-<ul>
-<li><p>In order to be able to create and/or publish an image, you need to set the <strong>DockerHub</strong> credentials <code>DOCKER_USERNAME, DOCKER_PASSWORD, DOCKER_EMAIL</code> variables as environment variables.</p></li>
-<li><p>To create an image for some release use :
-<code>create_release.sh <release-version> <git-tag></code>.</p></li>
-<li><p>To publish the created image use :
-<code>publish_release.sh <release-version> <git-tag></code></p></li>
-</ul>
-
-<h3>Running a Zeppelin docker image</h3>
-
+<h3>Running docker image</h3>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">docker run -p 8080:8080 --rm --name zeppelin apache/zeppelin:<release-version>
+</code></pre></div>
<ul>
-<li>To start Zeppelin, you need to pull the zeppelin release image:
-```
-docker pull ${DOCKER_USERNAME}/zeppelin-release:<release-version></li>
+<li>Zeppelin will run at <code>http://localhost:8080</code>.</li>
</ul>
-<p>docker run --rm -it -p 7077:7077 -p 8080:8080 ${DOCKER_USERNAME}/zeppelin-release:<release-version> -c bash
-``<code>
-* Then a docker container will start with a Zeppelin release on path :
-</code>/usr/local/zeppelin/`</p>
-
-<ul>
-<li><p>Run zeppelin inside docker:
-<code>
-/usr/local/zeppelin/bin/zeppelin.sh
-</code></p></li>
-<li><p>To Run Zeppelin in daemon mode
-Mounting logs and notebooks zeppelin to folders on your host machine</p></li>
-</ul>
-<div class="highlight"><pre><code class="text language-text" data-lang="text">docker run -p 7077:7077 -p 8080:8080 --privileged=true -v $PWD/logs:/logs -v $PWD/notebook:/notebook \
--e ZEPPELIN_NOTEBOOK_DIR='/notebook' \
+<p>If you want to specify <code>logs</code> and <code>notebook</code> dir, </p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">docker run -p 8080:8080 --rm \
+-v $PWD/logs:/logs \
+-v $PWD/notebook:/notebook \
-e ZEPPELIN_LOG_DIR='/logs' \
--d ${DOCKER_USERNAME}/zeppelin-release:<release-version> \
-/usr/local/zeppelin/bin/zeppelin.sh
+-e ZEPPELIN_NOTEBOOK_DIR='/notebook' \
+--name zeppelin apache/zeppelin:<release-version> # e.g '0.7.1'
</code></pre></div>
-<ul>
-<li>Zeppelin will run at <code>http://localhost:8080</code>.</li>
-</ul>
+<h3>Building dockerfile locally</h3>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">cd $ZEPPELIN_HOME
+cd scripts/docker/zeppelin/bin
+docker build -t my-zeppelin:my-tag ./
+</code></pre></div>
</div>
</div>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/install/install.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/install/install.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/install/install.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/install/install.html Mon May 15 15:03:55 2017
@@ -342,7 +342,7 @@ exec bin/zeppelin-daemon.sh upstart
<li>For more informations, go to <strong>More</strong> -> <strong>Security</strong> section.</li>
</ul>
-<h4>Other useful informations ...</h4>
+<h4>Other useful information ...</h4>
<ul>
<li>Learn how <a href="../displaysystem/basicdisplaysystem.html">Display System</a> works.</li>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/groovy.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/groovy.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/groovy.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/groovy.html Mon May 15 15:03:55 2017
@@ -234,7 +234,8 @@ limitations under the License.
<span class="nl">headers:</span> <span class="o">[</span>
<span class="s1">'Accept'</span><span class="o">:</span><span class="s1">'application/json'</span><span class="o">,</span>
<span class="c1">//'Authorization:' : g.getProperty('search_auth'),</span>
- <span class="o">]</span>
+ <span class="o">],</span>
+ <span class="n">ssl</span> <span class="o">:</span> <span class="n">g</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="s1">'search_ssl'</span><span class="o">)</span> <span class="c1">// assume groovy interpreter property search_ssl = HTTP.getNaiveSSLContext()</span>
<span class="o">)</span>
<span class="c1">//check response code</span>
<span class="k">if</span><span class="o">(</span> <span class="n">r</span><span class="o">.</span><span class="na">response</span><span class="o">.</span><span class="na">code</span><span class="o">==</span><span class="mi">200</span> <span class="o">)</span> <span class="o">{</span>
@@ -265,50 +266,52 @@ limitations under the License.
<h3>the <code>g</code> object</h3>
<ul>
-<li><code>g.angular(String name)</code></li>
-</ul>
-
-<p>Returns angular object by name. Look up notebook scope first and then global scope.</p>
-
-<ul>
-<li><code>g.angularBind(String name, Object value)</code></li>
-</ul>
-
-<p>Assign a new <code>value</code> into angular object <code>name</code></p>
+<li><p><code>g.angular(String name)</code></p>
-<ul>
-<li><code>java.util.Properties g.getProperties()</code></li>
-</ul>
+<p>Returns angular object by name. Look up notebook scope first and then global scope.</p></li>
+<li><p><code>g.angularBind(String name, Object value)</code></p>
-<p>returns all properties defined for this interpreter</p>
+<p>Assign a new <code>value</code> into angular object <code>name</code></p></li>
+<li><p><code>java.util.Properties g.getProperties()</code></p>
-<ul>
-<li><code>String g.getProperty('PROPERTY_NAME')</code>
+<p>returns all properties defined for this interpreter</p></li>
+<li><p><code>String g.getProperty('PROPERTY_NAME')</code>
<code>groovy
g.PROPERTY_NAME
g.'PROPERTY_NAME'
g['PROPERTY_NAME']
g.getProperties().getProperty('PROPERTY_NAME')
-</code></li>
-</ul>
+</code></p>
<p>All above the accessor to named property defined in groovy interpreter.
-In this case with name <code>PROPERTY_NAME</code></p>
-
-<ul>
-<li><code>groovy.xml.MarkupBuilder g.html()</code></li>
-</ul>
+In this case with name <code>PROPERTY_NAME</code></p></li>
+<li><p><code>groovy.xml.MarkupBuilder g.html()</code></p>
<p>Starts or continues rendering of <code>%angular</code> to output and returns <a href="http://groovy-lang.org/processing-xml.html#_markupbuilder">groovy.xml.MarkupBuilder</a>
-MarkupBuilder is usefull to generate html (xml)</p>
-
-<ul>
-<li><code>void g.table(obj)</code></li>
-</ul>
+MarkupBuilder is usefull to generate html (xml)</p></li>
+<li><p><code>void g.table(obj)</code></p>
<p>starts or continues rendering table rows.</p>
-<p>obj: List(rows) of List(columns) where first line is a header </p>
+<p>obj: List(rows) of List(columns) where first line is a header </p></li>
+<li><p><code>g.input(name, value )</code></p>
+
+<p>Creates <code>text</code> input with value specified. The parameter <code>value</code> is optional.</p></li>
+<li><p><code>g.select(name, default, Map<Object, String> options)</code></p>
+
+<p>Creates <code>select</code> input with defined options. The parameter <code>default</code> is optional.</p>
+
+<p><code>g.select('sex', 'm', ['m':'man', 'w':'woman'])</code></p></li>
+<li><p><code>g.checkbox(name, Collection checked, Map<Object, String> options)</code></p>
+
+<p>Creates <code>checkbox</code> input.</p></li>
+<li><p><code>g.get(name, default)</code></p>
+
+<p>Returns interpreter-based variable. Visibility depends on interpreter scope. The parameter <code>default</code> is optional.</p></li>
+<li><p><code>g.put(name, value)</code></p>
+
+<p>Stores new value into interpreter-based variable. Visibility depends on interpreter scope.</p></li>
+</ul>
</div>
</div>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/jdbc.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/jdbc.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/jdbc.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/interpreter/jdbc.html Mon May 15 15:03:55 2017
@@ -402,7 +402,7 @@ For example, if a connection needs a sch
<p><img src="../assets/themes/zeppelin/img/docs-img/click_interpreter_binding_button.png" width="600px" /></p>
-<p>Select(blue) or deselect(white) the interpreter buttons depending on your use cases.
+<p>Select(blue) or deselect(white) the interpreter buttons depending on your use cases.
If you need to use more than one interpreter in the notebook, activate several buttons.
Don't forget to click <code>Save</code> button, or you will face <code>Interpreter *** is not found</code> error.</p>
@@ -486,7 +486,7 @@ So you don't need to type this prefi
<h5>Usage</h5>
-<p>Test of execution <em>precode</em> for each data source. </p>
+<p>Test of execution <em>precode</em> for each data source.</p>
<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">jdbc</span>
<span class="k">show</span> <span class="n">search_path</span>
</code></pre></div>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/manual/dynamicform.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/manual/dynamicform.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/manual/dynamicform.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/manual/dynamicform.html Mon May 15 15:03:55 2017
@@ -266,7 +266,7 @@ You can control this by unchecking the b
<p><img src="../assets/themes/zeppelin/img/screenshots/form_checkbox.png"></p>
-<p>Besides, you can specify the delimiter using <code>${checkbox(delimiter):formName=...}</code>:</p>
+<p>You can specify the delimiter using <code>${checkbox(delimiter):formName=...}</code>:</p>
<p><img src="../assets/themes/zeppelin/img/screenshots/form_checkbox_delimiter.png"></p>
@@ -280,9 +280,9 @@ You can control this by unchecking the b
<h2>Creates Programmatically</h2>
-<p>Some language backend uses programmatic way to create form. For example <a href="../interpreter/spark.html#zeppelincontext">ZeppelinContext</a> provides form creation API</p>
+<p>Some language backends can programmatically create forms. For example <a href="../interpreter/spark.html#zeppelincontext">ZeppelinContext</a> provides a form creation API</p>
-<p>Here're some examples.</p>
+<p>Here are some examples:</p>
<h3>Text input form</h3>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/manual/interpreters.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/manual/interpreters.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/manual/interpreters.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/manual/interpreters.html Mon May 15 15:03:55 2017
@@ -308,6 +308,12 @@ interpreter.start()
<p><img src="../assets/themes/zeppelin/img/screenshots/existing_interpreter.png" width="450px"></p>
+<h2>Precode</h2>
+
+<p>Snippet of code (language of interpreter) that executes after initialization of the interpreter depends on <a href="#interpreter-binding-mode">Binding mode</a>. To configure add parameter with class of interpreter (<code>zeppelin.<ClassName>.precode</code>) except JDBCInterpreter (<a href="../interpreter/jdbc.md#usage-precode">JDBC precode</a>). </p>
+
+<p><img src="../assets/themes/zeppelin/img/screenshots/interpreter_precode.png" width="800px"></p>
+
</div>
</div>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/quickstart/explorezeppelinui.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/quickstart/explorezeppelinui.html?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/quickstart/explorezeppelinui.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/quickstart/explorezeppelinui.html Mon May 15 15:03:55 2017
@@ -223,7 +223,7 @@ limitations under the License.
<h2>Main home</h2>
-<p>The first time you connect to Zeppelin, you'll land at the main page similar to the below screen capture.</p>
+<p>The first time you connect to Zeppelin (<a href="http://localhost:8080/">default installations start on http://localhost:8080</a>), you'll land at the main page similar to the below screen capture.</p>
<p><img src="../assets/themes/zeppelin/img/ui-img/homepage.png" /></p>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml?rev=1795220&r1=1795219&r2=1795220&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml Mon May 15 15:03:55 2017
@@ -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>2017-04-17T15:59:29+09:00</lastBuildDate>
- <pubDate>2017-04-17T15:59:29+09:00</pubDate>
+ <lastBuildDate>2017-05-15T08:03:12-07:00</lastBuildDate>
+ <pubDate>2017-05-15T08:03:12-07:00</pubDate>
<ttl>1800</ttl>