You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by ah...@apache.org on 2017/04/17 07:01:50 UTC
svn commit: r1791664 [4/5] - in /zeppelin/site/docs/0.8.0-SNAPSHOT: ./
development/ displaysystem/ install/ interpreter/ manual/ quickstart/
rest-api/ security/ storage/
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/search.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/search.html?rev=1791664&r1=1791663&r2=1791664&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/search.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/search.html Mon Apr 17 07:01:48 2017
@@ -164,10 +164,11 @@
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
- <li class="title"><span><b>Helium Framework</b><span></li>
- <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
- <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinspell.html">Writing Zeppelin Spell (Experimental)</a></li>
- <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li class="title"><span><b>Helium Framework (Experimental)</b></span></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinapplication.html">Writing Zeppelin Application</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinspell.html">Writing Zeppelin Spell</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization: Basics</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization_transformation.html">Writing Zeppelin Visualization: Transformation</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>Advanced</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json?rev=1791664&r1=1791663&r2=1791664&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json Mon Apr 17 07:01:48 2017
@@ -26,8 +26,8 @@
"/development/writingzeppelinapplication.html": {
- "title": "Writing a new Application(Experimental)",
- "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 Application (Experimental)What is Apache Zeppelin ApplicationApache Zeppelin Application is a package that runs on Interpreter process and displays it&#39;s output inside of the notebook. While application runs on Interpreter process, it&#39;s able to access resources provided by Interpreter through ResourcePool. Output is always rendered by AngularDisplaySystem. Therefore application provides all the possibli
ties of making interactive graphical application that uses data and processing power of any Interpreter.Make your own ApplicationWriting Application means extending org.apache.zeppelin.helium.Application. You can use your favorite IDE and language while Java class files are packaged into jar. Application class looks like/** * Constructor. Invoked when application is loaded */public Application(ApplicationContext context);/** * Invoked when there&#39;re (possible) updates in required resource set. * i.e. invoked after application load and after paragraph finishes. */public abstract void run(ResourceSet args);/** * Invoked before application unload. * Application is automatically unloaded with paragraph/notebook removal */public abstract void unload();You can check example applications under ./zeppelin-examples directory.Development modeIn the development mode, you can run your Application in your IDE as a normal java application and see the result inside of Zeppelin notebook.org.
apache.zeppelin.helium.ZeppelinApplicationDevServer can run Zeppelin Application in development mode.// entry point for development modepublic static void main(String[] args) throws Exception { // add resources for development mode LocalResourcePool pool = new LocalResourcePool(&quot;dev&quot;); pool.put(&quot;date&quot;, new Date()); // run application in devlopment mode with given resource // in this case, Clock.class.getName() will be the application class name org.apache.zeppelin.helium.ZeppelinApplicationDevServer devServer = new org.apache.zeppelin.helium.ZeppelinApplicationDevServer( Clock.class.getName(), pool.getAll()); // start development mode devServer.start(); devServer.join();}In the Zeppelin notebook, run %dev run will connect to application running in development mode.Package filePackage file is a json file that provides information about the application.Json file contains the following information{ name : &quot;[organization].[name
]&quot;, description : &quot;Description&quot;, artifact : &quot;groupId:artifactId:version&quot;, className : &quot;your.package.name.YourApplicationClass&quot;, resources : [ [&quot;resource.name&quot;, &quot;:resource.class.name&quot;], [&quot;alternative.resource.name&quot;, &quot;:alternative.class.name&quot;] ], icon : &quot;&lt;i class=&quot;icon&quot;&gt;&lt;/i&gt;&quot;}nameName is a string in [group].[name] format.[group] and [name] allow only [A-Za-z0-9_].Group is normally the name of an organization who creates this application.descriptionA short description about the applicationartifactLocation of the jar artifact.&quot;groupId:artifactId:version&quot; will load artifact from maven repository.If jar exists in the local filesystem, absolute/relative can be used.e.g.When artifact exists in Maven repositoryartifact: &quot;org.apache.zeppelin:zeppelin-examples
:0.6.0&quot;When artifact exists in the local filesystemartifact: &quot;zeppelin-example/target/zeppelin-example-0.6.0.jar&quot;classNameEntry point. Class that extends org.apache.zeppelin.helium.ApplicationresourcesTwo dimensional array that defines required resources by name or by className. Helium Application launcher will compare resources in the ResourcePool with the information in this field and suggest application only when all required resources are available in the ResourcePool.Resouce name is a string which will be compared with the name of objects in the ResourcePool. className is a string with &quot;:&quot; prepended, which will be compared with className of the objects in the ResourcePool.Application may require two or more resources. Required resources can be listed inside of the json array. For example, if the application requires object &quot;name1&quot;, &quot;name2&quot; and &quot;className1&quot; type of object to run, r
esources field can beresources: [ [ &quot;name1&quot;, &quot;name2&quot;, &quot;:className1&quot;, ...]]If Application can handle alternative combination of required resources, alternative set can be listed as below.resources: [ [ &quot;name&quot;, &quot;:className&quot;], [ &quot;altName&quot;, &quot;:altClassName1&quot;], ...]Easier way to understand this scheme isresources: [ [ &#39;resource&#39; AND &#39;resource&#39; AND ... ] OR [ &#39;resource&#39; AND &#39;resource&#39; AND ... ] OR ...]iconIcon to be used on the application button. String in this field will be rendered as a HTML tag.e.g.icon: &quot;&lt;i class=&#39;fa fa-clock-o&#39;&gt;&lt;/i&gt;&quot;",
+ "title": "Writing a new Application",
+ "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 ApplicationWhat is Apache Zeppelin ApplicationApache Zeppelin Application is a package that runs on Interpreter process and displays it&#39;s output inside of the notebook. While application runs on Interpreter process, it&#39;s able to access resources provided by Interpreter through ResourcePool. Output is always rendered by AngularDisplaySystem. Therefore application provides all the possiblities of making
interactive graphical application that uses data and processing power of any Interpreter.Make your own ApplicationWriting Application means extending org.apache.zeppelin.helium.Application. You can use your favorite IDE and language while Java class files are packaged into jar. Application class looks like/** * Constructor. Invoked when application is loaded */public Application(ApplicationContext context);/** * Invoked when there&#39;re (possible) updates in required resource set. * i.e. invoked after application load and after paragraph finishes. */public abstract void run(ResourceSet args);/** * Invoked before application unload. * Application is automatically unloaded with paragraph/notebook removal */public abstract void unload();You can check example applications under ./zeppelin-examples directory.Development modeIn the development mode, you can run your Application in your IDE as a normal java application and see the result inside of Zeppelin notebook.org.apache.zeppelin
.helium.ZeppelinApplicationDevServer can run Zeppelin Application in development mode.// entry point for development modepublic static void main(String[] args) throws Exception { // add resources for development mode LocalResourcePool pool = new LocalResourcePool(&quot;dev&quot;); pool.put(&quot;date&quot;, new Date()); // run application in devlopment mode with given resource // in this case, Clock.class.getName() will be the application class name org.apache.zeppelin.helium.ZeppelinApplicationDevServer devServer = new org.apache.zeppelin.helium.ZeppelinApplicationDevServer( Clock.class.getName(), pool.getAll()); // start development mode devServer.start(); devServer.join();}In the Zeppelin notebook, run %dev run will connect to application running in development mode.Package filePackage file is a json file that provides information about the application.Json file contains the following information{ &quot;name&quot; : &quot;[organization].
[name]&quot;, &quot;description&quot; : &quot;Description&quot;, &quot;artifact&quot; : &quot;groupId:artifactId:version&quot;, &quot;className&quot; : &quot;your.package.name.YourApplicationClass&quot;, &quot;resources&quot; : [ [&quot;resource.name&quot;, &quot;:resource.class.name&quot;], [&quot;alternative.resource.name&quot;, &quot;:alternative.class.name&quot;] ], &quot;icon&quot; : &quot;&lt;i class=&#39;icon&#39;&gt;&lt;/i&gt;&quot;}nameName is a string in [group].[name] format.[group] and [name] allow only [A-Za-z0-9_].Group is normally the name of an organization who creates this application.descriptionA short description about the applicationartifactLocation of the jar artifact.&quot;groupId:artifactId:version&quot; will load artifact from maven repository.If jar exists in the local filesystem, absolute/relative can be use
d.e.g.When artifact exists in Maven repositoryartifact: &quot;org.apache.zeppelin:zeppelin-examples:0.6.0&quot;When artifact exists in the local filesystemartifact: &quot;zeppelin-example/target/zeppelin-example-0.6.0.jar&quot;classNameEntry point. Class that extends org.apache.zeppelin.helium.ApplicationresourcesTwo dimensional array that defines required resources by name or by className. Helium Application launcher will compare resources in the ResourcePool with the information in this field and suggest application only when all required resources are available in the ResourcePool.Resouce name is a string which will be compared with the name of objects in the ResourcePool. className is a string with &quot;:&quot; prepended, which will be compared with className of the objects in the ResourcePool.Application may require two or more resources. Required resources can be listed inside of the json array. For example, if the application requires object &quot
;name1&quot;, &quot;name2&quot; and &quot;className1&quot; type of object to run, resources field can beresources: [ [ &quot;name1&quot;, &quot;name2&quot;, &quot;:className1&quot;, ...]]If Application can handle alternative combination of required resources, alternative set can be listed as below.resources: [ [ &quot;name&quot;, &quot;:className&quot;], [ &quot;altName&quot;, &quot;:altClassName1&quot;], ...]Easier way to understand this scheme isresources: [ [ &#39;resource&#39; AND &#39;resource&#39; AND ... ] OR [ &#39;resource&#39; AND &#39;resource&#39; AND ... ] OR ...]iconIcon to be used on the application button. String in this field will be rendered as a HTML tag.e.g.icon: &quot;&lt;i class=&#39;fa fa-clock-o&#39;&gt;&lt;/i&gt;&quot;",
"url": " /development/writingzeppelinapplication.html",
"group": "development",
"excerpt": "Apache Zeppelin Application is a package that runs on Interpreter process and displays it's output inside of the notebook. Make your own Application in Apache Zeppelin is quite easy."
@@ -48,8 +48,8 @@
"/development/writingzeppelinspell.html": {
- "title": "Writing a new Spell(Experimental)",
- "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 Spell (Experimental)What is Apache Zeppelin SpellSpell is a kind of interpreter that runs on browser not on backend. So, technically it&#39;s the frontend interpreter. It can provide many benefits.Spell is pluggable frontend interpreter. So it can be installed and removed easily using helium registry. Every spell is written in javascript. It means you can use existing javascript libraries whatever you want.Spell r
uns on browser like display system (%html, %table). In other words, every spell can be used as display system as well.How it worksHelium Spell works like Helium Visualization.Every helium packages are loaded from central (online) registry or local registryYou can see loaded packages in /helium page.When you enable a spell, it&#39;s built from server and sent to clientFinally it will be loaded into browser.How to use spell1. EnablingFind a spell what you want to use in /helium package and click Enable button.2. UsingSpell works like an interpreter. Use the MAGIC value to execute spell in a note. (you might need to refresh after enabling)For example, Use %echo for the Echo Spell.Write a new SpellMaking a new spell is similar to Helium Visualization#write-new-visualization.Add framework dependency called zeppelin-spell into package.jsonWrite code using frameworkPublish your spell to npm1. Create a npm packageCreate a package.json in new directory for spell. You have to add a framew
ork called zeppelin-spell as a dependency to create spell (zeppelin-spell)Also, you can add any dependencies you want to utilise.Here&#39;s an example{ &quot;name&quot;: &quot;zeppelin-echo-spell&quot;, &quot;description&quot;: &quot;Zeppelin Echo Spell (example)&quot;, &quot;version&quot;: &quot;1.0.0&quot;, &quot;main&quot;: &quot;index&quot;, &quot;author&quot;: &quot;&quot;, &quot;license&quot;: &quot;Apache-2.0&quot;, &quot;dependencies&quot;: { &quot;zeppelin-spell&quot;: &quot;*&quot; }, &quot;helium&quot;: { &quot;icon&quot; : &quot;&lt;i class=&#39;fa fa-repeat&#39;&gt;&lt;/i&gt;&quot;, &quot;spell&quot;: { &quot;magic&quot;: &quot;%echo&quot;, &quot;usage&quot;: &quot;%echo &lt;TEXT&gt;&quot; } }}2. Write spell using framewor
kHere are some examples you can referEcho SpellMarkdown Spell: Using libraryFlowchart Spell: Using DOMGoogle Translation API Spell: Using API (returning promise)Now, you need to write code to create spell which processing text.import { SpellBase, SpellResult, DefaultDisplayType,} from &#39;zeppelin-spell&#39;;export default class EchoSpell extends SpellBase { constructor() { /** pass magic to super class&#39;s constructor parameter */ super(&quot;%echo&quot;); } interpret(paragraphText) { const processed = paragraphText + &#39;!&#39;; /** * should return `SpellResult` which including `data` and `type` * default type is `TEXT` if you don&#39;t specify. */ return new SpellResult(processed); }}Here is another example. Let&#39;s say we want to create markdown spell. First of all, we should add a dependency for markdown in package.json// package.json &quot;dependenci
es&quot;: { &quot;markdown&quot;: &quot;0.5.0&quot;, &quot;zeppelin-spell&quot;: &quot;*&quot; },And here is spell code.import { SpellBase, SpellResult, DefaultDisplayType,} from &#39;zeppelin-spell&#39;;import md from &#39;markdown&#39;;const markdown = md.markdown;export default class MarkdownSpell extends SpellBase { constructor() { super(&quot;%markdown&quot;); } interpret(paragraphText) { const parsed = markdown.toHTML(paragraphText); /** * specify `DefaultDisplayType.HTML` since `parsed` will contain DOM * otherwise it will be rendered as `DefaultDisplayType.TEXT` (default) */ return new SpellResult(parsed, DefaultDisplayType.HTML); }}You might want to manipulate DOM directly (e.g google d3.js), then refer Flowchart Spell You might want to return promise not string (e.g API call), then refer Google Translation API Spell3. Create Helium pac
kage file for local deploymentYou don&#39;t want to publish your package every time you make a change in your spell. Zeppelin provides local deploy.The only thing you need to do is creating a Helium Package file (JSON) for local deploy. It&#39;s automatically created when you publish to npm repository but in local case, you should make it by yourself.{ &quot;type&quot; : &quot;SPELL&quot;, &quot;name&quot; : &quot;zeppelin-echo-spell&quot;, &quot;version&quot;: &quot;1.0.0&quot;, &quot;description&quot; : &quot;Return just what receive (example)&quot;, &quot;artifact&quot; : &quot;./zeppelin-examples/zeppelin-example-spell-echo&quot;, &quot;license&quot; : &quot;Apache-2.0&quot;, &quot;spell&quot;: { &quot;magic&quot;: &quot;%echo&quot;, &quot;usage&quot;: &quot;%echo &lt;TEXT&gt;&quot; }}Place this file in your local r
egistry directory (default $ZEPPELIN_HOME/helium).type should be SPELLMake sure that artifact should be same as your spell directory. You can get information about other fields in Helium Visualization#3-create-helium-package-file-and-locally-deploy.4. Run in dev modecd zeppelin-webyarn run dev:helium You can browse localhost:9000. Every time refresh your browser, Zeppelin will rebuild your spell and reload changes.5. Publish your spell to the npm repositorySee Publishing npm packages",
+ "title": "Writing a new Spell",
+ "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 SpellWhat is Apache Zeppelin SpellSpell is a kind of interpreter that runs on browser not on backend. So, technically it&#39;s the frontend interpreter.It can provide many benefits.Spell is pluggable frontend interpreter. So it can be installed and removed easily using helium registry.Every spell is written in javascript. It means you can use existing javascript libraries whatever you want.Spell runs on browser li
ke display system (%html, %table). In other words, every spell can be used as display system as well.How it worksHelium Spell works like Helium Visualization.Every helium packages are loaded from central (online) registry or local registryYou can see loaded packages in /helium page.When you enable a spell, it&#39;s built from server and sent to clientFinally it will be loaded into browser.How to use spell1. EnablingFind a spell what you want to use in /helium package and click Enable button.2. UsingSpell works like an interpreter. Use the MAGIC value to execute spell in a note. (you might need to refresh after enabling)For example, Use %echo for the Echo Spell.Write a new SpellMaking a new spell is similar to Helium Visualization#write-new-visualization.Add framework dependency called zeppelin-spell into package.jsonWrite code using frameworkPublish your spell to npm1. Create a npm packageCreate a package.json in new directory for spell.You have to add a framework called zeppeli
n-spell as a dependency to create spell (zeppelin-spell)Also, you can add any dependencies you want to utilise.Here&#39;s an example{ &quot;name&quot;: &quot;zeppelin-echo-spell&quot;, &quot;description&quot;: &quot;Zeppelin Echo Spell (example)&quot;, &quot;version&quot;: &quot;1.0.0&quot;, &quot;main&quot;: &quot;index&quot;, &quot;author&quot;: &quot;&quot;, &quot;license&quot;: &quot;Apache-2.0&quot;, &quot;dependencies&quot;: { &quot;zeppelin-spell&quot;: &quot;*&quot; }, &quot;helium&quot;: { &quot;icon&quot; : &quot;&lt;i class=&#39;fa fa-repeat&#39;&gt;&lt;/i&gt;&quot;, &quot;spell&quot;: { &quot;magic&quot;: &quot;%echo&quot;, &quot;usage&quot;: &quot;%echo &lt;TEXT&gt;&quot; } }}2. Write spell using frameworkHere are some exa
mples you can referEcho SpellMarkdown Spell: Using libraryFlowchart Spell: Using DOMGoogle Translation API Spell: Using API (returning promise)Now, you need to write code to create spell which processing text.import { SpellBase, SpellResult, DefaultDisplayType,} from &#39;zeppelin-spell&#39;;export default class EchoSpell extends SpellBase { constructor() { /** pass magic to super class&#39;s constructor parameter */ super(&quot;%echo&quot;); } interpret(paragraphText) { const processed = paragraphText + &#39;!&#39;; /** * should return `SpellResult` which including `data` and `type` * default type is `TEXT` if you don&#39;t specify. */ return new SpellResult(processed); }}Here is another example. Let&#39;s say we want to create markdown spell. First of all, we should add a dependency for markdown in package.json// package.json &quot;dependencies&quot;: {
&quot;markdown&quot;: &quot;0.5.0&quot;, &quot;zeppelin-spell&quot;: &quot;*&quot; },And here is spell code.import { SpellBase, SpellResult, DefaultDisplayType,} from &#39;zeppelin-spell&#39;;import md from &#39;markdown&#39;;const markdown = md.markdown;export default class MarkdownSpell extends SpellBase { constructor() { super(&quot;%markdown&quot;); } interpret(paragraphText) { const parsed = markdown.toHTML(paragraphText); /** * specify `DefaultDisplayType.HTML` since `parsed` will contain DOM * otherwise it will be rendered as `DefaultDisplayType.TEXT` (default) */ return new SpellResult(parsed, DefaultDisplayType.HTML); }}You might want to manipulate DOM directly (e.g google d3.js), then refer Flowchart SpellYou might want to return promise not string (e.g API call), then refer Google Translation API Spell3. Create Helium package file for local
deploymentYou don&#39;t want to publish your package every time you make a change in your spell. Zeppelin provides local deploy.The only thing you need to do is creating a Helium Package file (JSON) for local deploy.It&#39;s automatically created when you publish to npm repository but in local case, you should make it by yourself.{ &quot;type&quot; : &quot;SPELL&quot;, &quot;name&quot; : &quot;zeppelin-echo-spell&quot;, &quot;version&quot;: &quot;1.0.0&quot;, &quot;description&quot; : &quot;Return just what receive (example)&quot;, &quot;artifact&quot; : &quot;./zeppelin-examples/zeppelin-example-spell-echo&quot;, &quot;license&quot; : &quot;Apache-2.0&quot;, &quot;spell&quot;: { &quot;magic&quot;: &quot;%echo&quot;, &quot;usage&quot;: &quot;%echo &lt;TEXT&gt;&quot; }}Place this file in your local registry directory (de
fault $ZEPPELIN_HOME/helium).type should be SPELLMake sure that artifact should be same as your spell directory.You can get information about other fields in Helium Visualization#3-create-helium-package-file-and-locally-deploy.4. Run in dev modecd zeppelin-webyarn run dev:heliumYou can browse localhost:9000. Every time refresh your browser, Zeppelin will rebuild your spell and reload changes.5. Publish your spell to the npm repositorySee Publishing npm packages",
"url": " /development/writingzeppelinspell.html",
"group": "development",
"excerpt": "Spell is a kind of interpreter that runs on browser not on backend. So, technically it's the frontend interpreter. "
@@ -59,8 +59,8 @@
"/development/writingzeppelinvisualization.html": {
- "title": "Writing a new Visualization(Experimental)",
- "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 Visualization (Experimental)What is Apache Zeppelin VisualizationApache Zeppelin Visualization is a pluggable package that can be loaded/unloaded on runtime through Helium framework in Zeppelin. A Visualization is a javascript npm package and user can use them just like any other built-in visualization in notebook.How it works1. Load Helium package files from registryZeppelin needs to know what Visualization packages
are available. Zeppelin will read information of packages from both online and local registry.Registries are configurable through ZEPPELIN_HELIUM_LOCALREGISTRY_DEFAULT env variable or zeppelin.helium.localregistry.default property.2. Enable packagesOnce Zeppelin loads Helium package files from registries, available packages are displayed in Helium menu.Click &#39;enable&#39; button.3. Create and load visualization bundle on the flyOnce a Visualization package is enabled, HeliumBundleFactory creates a js bundle. The js bundle is served by helium/bundle/load rest api endpoint.4. Run visualizationZeppelin shows additional button for loaded Visualizations.User can use just like any other built-in visualizations.Write new Visualization1. Create a npm packageCreate a package.json in your new Visualization directory. Normally, you can add any dependencies in package.json however Zeppelin Visualization package only allows two dependencies: zeppelin-vis and zeppelin-tabledata.Here&am
p;#39;s an example{ &quot;name&quot;: &quot;zeppelin_horizontalbar&quot;, &quot;description&quot; : &quot;Horizontal Bar chart&quot;, &quot;version&quot;: &quot;1.0.0&quot;, &quot;main&quot;: &quot;horizontalbar&quot;, &quot;author&quot;: &quot;&quot;, &quot;license&quot;: &quot;Apache-2.0&quot;, &quot;dependencies&quot;: { &quot;zeppelin-tabledata&quot;: &quot;*&quot;, &quot;zeppelin-vis&quot;: &quot;*&quot; }}2. Create your own visualizationTo create your own visualization, you need to create a js file and import Visualization class from zeppelin-vis package and extend the class. zeppelin-tabledata package provides some useful transformations, like pivot, you can use in your visualization. (you can create your own transformation, too).Visualization class, there&#39;re several methods that you need to override and implement. Here&
amp;#39;s simple visualization that just prints Hello world.import Visualization from &#39;zeppelin-vis&#39;import PassthroughTransformation from &#39;zeppelin-tabledata/passthrough&#39;export default class helloworld extends Visualization { constructor(targetEl, config) { super(targetEl, config) this.passthrough = new PassthroughTransformation(config); } render(tableData) { this.targetEl.html(&#39;Hello world!&#39;) } getTransformation() { return this.passthrough }}To learn more about Visualization class, check visualization.js.You can check complete visualization package example here.Zeppelin&#39;s built-in visualization uses the same API, so you can check built-in visualizations as additional examples.3. Create Helium package file and locally deployHelium Package file is a json file that provides information about the application.Json file contains the following information{ &quot;type&quot; : &quot;VISUALIZATION&quot
;, &quot;name&quot; : &quot;zeppelin_horizontalbar&quot;, &quot;description&quot; : &quot;Horizontal Bar chart (example)&quot;, &quot;license&quot; : &quot;Apache-2.0&quot;, &quot;artifact&quot; : &quot;./zeppelin-examples/zeppelin-example-horizontalbar&quot;, &quot;icon&quot; : &quot;&lt;i class=&#39;fa fa-bar-chart rotate90flipX&#39;&gt;&lt;/i&gt;&quot;}Place this file in your local registry directory (default ./helium).typeWhen you&#39;re creating a visualization, &#39;type&#39; should be &#39;VISUALIZATION&#39;.Check application type if you&#39;re interested in the other types of package.nameName of visualization. Should be unique. Allows [A-Za-z90-9_].descriptionA short description about visualization.artifactLocation of the visualization npm package. Support npm package with version or local filesystem path.e.g.When artifact exists in npm reposit
oryartifact: &quot;my-visualiztion@1.0.0&quot;When artifact exists in local file systemartifact: &quot;/path/to/my/visualization&quot;licenseLicense information.e.g.license: &quot;Apache-2.0&quot;iconIcon to be used in visualization select button. String in this field will be rendered as a HTML tag.e.g.icon: &quot;&lt;i class=&#39;fa fa-coffee&#39;&gt;&lt;/i&gt;&quot;4. Run in dev modePlace your Helium package file in local registry (ZEPPELIN_HOME/helium).Run Zeppelin. And then run zeppelin-web in visualization dev mode.cd zeppelin-webyarn run dev:helium You can browse localhost:9000. Everytime refresh your browser, Zeppelin will rebuild your visualization and reload changes.5. Publish your visualizationOnce it&#39;s done, publish your visualization package using npm publish.That&#39;s it. With in an hour, your visualization will be available in Zeppelin&#39;s helium menu.",
+ "title": "Writing a new Visualization",
+ "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 VisualizationWhat is Apache Zeppelin VisualizationApache Zeppelin Visualization is a pluggable package that can be loaded/unloaded on runtime through Helium framework in Zeppelin. A Visualization is a javascript npm package and user can use them just like any other built-in visualization in notebook.How it works1. Load Helium package files from registryZeppelin needs to know what Visualization packages are available.
Zeppelin will read information of packages from both online and local registry.Registries are configurable through ZEPPELIN_HELIUM_LOCALREGISTRY_DEFAULT env variable or zeppelin.helium.localregistry.default property.2. Enable packagesOnce Zeppelin loads Helium package files from registries, available packages are displayed in Helium menu.Click &#39;enable&#39; button.3. Create and load visualization bundle on the flyOnce a Visualization package is enabled, HeliumBundleFactory creates a js bundle. The js bundle is served by helium/bundle/load rest api endpoint.4. Run visualizationZeppelin shows additional button for loaded Visualizations.User can use just like any other built-in visualizations.Write new Visualization1. Create a npm packageCreate a package.json in your new Visualization directory. You can add any dependencies in package.json, but you must include two dependencies: zeppelin-vis and zeppelin-tabledata.Here&#39;s an example{ &quot;name&quot;: &qu
ot;zeppelin_horizontalbar&quot;, &quot;description&quot; : &quot;Horizontal Bar chart&quot;, &quot;version&quot;: &quot;1.0.0&quot;, &quot;main&quot;: &quot;horizontalbar&quot;, &quot;author&quot;: &quot;&quot;, &quot;license&quot;: &quot;Apache-2.0&quot;, &quot;dependencies&quot;: { &quot;zeppelin-tabledata&quot;: &quot;*&quot;, &quot;zeppelin-vis&quot;: &quot;*&quot; }}2. Create your own visualizationTo create your own visualization, you need to create a js file and import Visualization class from zeppelin-vis package and extend the class. zeppelin-tabledata package provides some useful transformations, like pivot, you can use in your visualization. (you can create your own transformation, too).Visualization class, there&#39;re several methods that you need to override and implement. Here&#39;s simple visualization that just prints Hello
world.import Visualization from &#39;zeppelin-vis&#39;import PassthroughTransformation from &#39;zeppelin-tabledata/passthrough&#39;export default class helloworld extends Visualization { constructor(targetEl, config) { super(targetEl, config) this.passthrough = new PassthroughTransformation(config); } render(tableData) { this.targetEl.html(&#39;Hello world!&#39;) } getTransformation() { return this.passthrough }}To learn more about Visualization class, check visualization.js.You can check complete visualization package example here.Zeppelin&#39;s built-in visualization uses the same API, so you can check built-in visualizations as additional examples.3. Create Helium package file and locally deployHelium Package file is a json file that provides information about the application.Json file contains the following information{ &quot;type&quot; : &quot;VISUALIZATION&quot;, &quot;name&quot; : &quot;zeppelin_hori
zontalbar&quot;, &quot;description&quot; : &quot;Horizontal Bar chart (example)&quot;, &quot;license&quot; : &quot;Apache-2.0&quot;, &quot;artifact&quot; : &quot;./zeppelin-examples/zeppelin-example-horizontalbar&quot;, &quot;icon&quot; : &quot;&lt;i class=&#39;fa fa-bar-chart rotate90flipX&#39;&gt;&lt;/i&gt;&quot;}Place this file in your local registry directory (default ./helium).typeWhen you&#39;re creating a visualization, &#39;type&#39; should be &#39;VISUALIZATION&#39;.Check application type if you&#39;re interested in the other types of package.nameName of visualization. Should be unique. Allows [A-Za-z90-9_].descriptionA short description about visualization.artifactLocation of the visualization npm package. Support npm package with version or local filesystem path.e.g.When artifact exists in npm repository&quot;artifact&quot;: &quot;my-visualiz
tion@1.0.0&quot;When artifact exists in local file system&quot;artifact&quot;: &quot;/path/to/my/visualization&quot;licenseLicense information.e.g.&quot;license&quot;: &quot;Apache-2.0&quot;iconIcon to be used in visualization select button. String in this field will be rendered as a HTML tag.e.g.&quot;icon&quot;: &quot;&lt;i class=&#39;fa fa-coffee&#39;&gt;&lt;/i&gt;&quot;4. Run in dev modePlace your Helium package file in local registry (ZEPPELIN_HOME/helium).Run Zeppelin. And then run zeppelin-web in visualization dev mode.cd zeppelin-webyarn run dev:heliumYou can browse localhost:9000. Everytime refresh your browser, Zeppelin will rebuild your visualization and reload changes.5. Publish your visualizationOnce it&#39;s done, publish your visualization package using npm publish.That&#39;s it. With in an hour, your visualization will be available in Zeppelin&#39;s helium menu.",
"url": " /development/writingzeppelinvisualization.html",
"group": "development",
"excerpt": "Apache Zeppelin Visualization is a pluggable package that can be loaded/unloaded on runtime through Helium framework in Zeppelin. A Visualization is a javascript npm package and user can use them just like any other built-in visualization in a note."
@@ -69,6 +69,17 @@
+ "/development/writingzeppelinvisualization_transformation.html": {
+ "title": "Transformations for Zeppelin Visualization",
+ "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.-->Transformations for Zeppelin VisualizationOverviewTransformations renders setting which allows users to set columns and transforms table rows according to the configured columns.Zeppelin provides 4 types of transformations.1. PassthroughTransformationPassthroughTransformation is the simple transformation which does not convert original tabledata at all.See passthrough.js2. ColumnselectorTransformationColumnselectorTransformation is
uses when you need N axes but do not need aggregation. See columnselector.js3. PivotTransformationPivotTransformation provides group by and aggregation. Every chart using PivotTransformation has 3 axes. Keys, Groups and Values.See pivot.js4. AdvancedTransformationAdvancedTransformation has more detailed options while providing existing features of PivotTransformation and ColumnselectorTransformationmultiple sub chartsconfigurable chart axesparameter widgets: input, checkbox, option, textareaparsing parameters automatically based on their typesexpand / fold axis and parameter panelsmultiple transformation methods while supporting lazy converting re-initialize the whole configuration based on spec hash.SpecAdvancedTransformation requires spec which includes axis and parameter details for charts.Let&#39;s create 2 sub-charts called line and no-group. Each sub chart can have different axis and parameter depending on their requirements.class AwesomeVisualization extends Visualizatio
n { constructor(targetEl, config) { super(targetEl, config) const spec = { charts: { &#39;line&#39;: { transform: { method: &#39;object&#39;, }, sharedAxis: false, /** set if you want to share axes between sub charts, default is `false` */ axis: { &#39;xAxis&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;key&#39;, description: &#39;serial&#39;, }, &#39;yAxis&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;aggregator&#39;, description: &#39;serial&#39;, }, &#39;category&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;group&#39;, description: &#39;categorical&#39;, }, }, parameter: { &#39;xAxisUnit&#39;: { valueType: &#39;string&#39;, defaultValue: &#39;&#39;, description: &#39;unit of xAxis&#39;, }, &#3
9;yAxisUnit&#39;: { valueType: &#39;string&#39;, defaultValue: &#39;&#39;, description: &#39;unit of yAxis&#39;, }, &#39;lineWidth&#39;: { valueType: &#39;int&#39;, defaultValue: 0, description: &#39;width of line&#39;, }, }, }, &#39;no-group&#39;: { transform: { method: &#39;object&#39;, }, sharedAxis: false, axis: { &#39;xAxis&#39;: { dimension: &#39;single&#39;, axisType: &#39;key&#39;, }, &#39;yAxis&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;value&#39;, }, }, parameter: { &#39;xAxisUnit&#39;: { valueType: &#39;string&#39;, defaultValue: &#39;&#39;, description: &#39;unit of xAxis&#39;, }, &#39;yAxisUnit&#39;: { valueType: &#39;string&#39;, defaultValue: &#39;&#39;, description:
&#39;unit of yAxis&#39;, }, }, }, } this.transformation = new AdvancedTransformation(config, spec) } ... // `render` will be called whenever `axis` or `parameter` is changed render(data) { const { chart, parameter, column, transformer, } = data if (chart === &#39;line&#39;) { const transformed = transformer() // draw line chart } else if (chart === &#39;no-group&#39;) { const transformed = transformer() // draw no-group chart } }}Spec: axisField NameAvailable Values (type)DescriptiondimensionsingleAxis can contains only 1 columndimensionmultipleAxis can contains multiple columnsaxisTypekeyColumn(s) in this axis will be used as key like in PivotTransformation. These columns will be served in column.keyaxisTypeaggregatorColumn(s) in this axis will be used as value like in PivotTransformation. These columns will be served in column.aggregatoraxisTypegroupColumn(s) in this axis will be used as group like i
n PivotTransformation. These columns will be served in column.groupaxisType(string)Any string value can be used here. These columns will be served in column.custommaxAxisCount (optional)(int)The max number of columns that this axis can contain. (unlimited if undefined)minAxisCount (optional)(int)The min number of columns that this axis should contain to draw chart. (1 in case of single dimension)description (optional)(string)Description for the axis.Here is an example.axis: { &#39;xAxis&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;key&#39;, }, &#39;yAxis&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;aggregator&#39;}, &#39;category&#39;: { dimension: &#39;multiple&#39;, axisType: &#39;group&#39;, maxAxisCount: 2, valueType: &#39;string&#39;, },},Spec: sharedAxisIf you set sharedAxis: false for sub charts, then their axes are persisted in global space (shared). It&#39;s useful for
when you creating multiple sub charts sharing their axes but have different parameters. For example, basic-column, stacked-column, percent-columnpie and donutHere is an example. const spec = { charts: { &#39;column&#39;: { transform: { method: &#39;array&#39;, }, sharedAxis: true, axis: { ... }, parameter: { ... }, }, &#39;stacked&#39;: { transform: { method: &#39;array&#39;, }, sharedAxis: true, axis: { ... } parameter: { ... }, },Spec: parameterField NameAvailable Values (type)DescriptionvalueTypestringParameter which has string valuevalueTypeintParameter which has int valuevalueTypefloatParameter which has float valuevalueTypebooleanParameter which has boolean value used with checkbox widget usuallyvalueTypeJSONParameter which has JSON value used with textarea widget usually. defaultValue should be &quot;&quot; (empty string). Thisdes
cription(string)Description of this parameter. This value will be parsed as HTML for pretty outputwidgetinputUse input widget. This is the default widget (if widget is undefined)widgetcheckboxUse checkbox widget.widgettextareaUse textarea widget.widgetoptionUse select + option widget. This parameter should have optionValues field as well.optionValues(Array)Available option values used with the option widgetHere is an example.parameter: { // string type, input widget &#39;xAxisUnit&#39;: { valueType: &#39;string&#39;, defaultValue: &#39;&#39;, description: &#39;unit of xAxis&#39;, }, // boolean type, checkbox widget &#39;inverted&#39;: { widget: &#39;checkbox&#39;, valueType: &#39;boolean&#39;, defaultValue: false, description: &#39;invert x and y axes&#39;, }, // string type, option widget with `optionValues` &#39;graphType&#39;: { widget: &#39;option&#39;, valueType: &#39;string&#39;, defa
ultValue: &#39;line&#39;, description: &#39;graph type&#39;, optionValues: [ &#39;line&#39;, &#39;smoothedLine&#39;, &#39;step&#39;, ], }, // HTML in `description` &#39;dateFormat&#39;: { valueType: &#39;string&#39;, defaultValue: &#39;&#39;, description: &#39;format of date (&lt;a href=&quot;https://docs.amcharts.com/3/javascriptcharts/AmGraph#dateFormat&quot;&gt;doc&lt;/a&gt;) (e.g YYYY-MM-DD)&#39;, }, // JSON type, textarea widget &#39;yAxisGuides&#39;: { widget: &#39;textarea&#39;, valueType: &#39;JSON&#39;, defaultValue: &#39;&#39;, description: &#39;guides of yAxis &#39;, },Spec: transformField NameAvailable Values (type)Descriptionmethodobjectdesigned for rows requiring object manipulationmethodarraydesigned for rows requiring array manipulationmethodarray:2-keydesigned for xyz charts (e.g bubble chart)methoddrill-downdesigned for drill-d
own chartsmethodrawwill return the original tableData.rowsWhatever you specified as transform.method, the transformer value will be always function for lazy computation. // advanced-transformation.util#getTransformerif (transformSpec.method === &#39;raw&#39;) { transformer = () =&gt; { return rows; }} else if (transformSpec.method === &#39;array&#39;) { transformer = () =&gt; { ... return { ... } }}Here is actual usage.class AwesomeVisualization extends Visualization { constructor(...) { /** setup your spec */ } ... // `render` will be called whenever `axis` or `parameter` are changed render(data) { const { chart, parameter, column, transformer, } = data if (chart === &#39;line&#39;) { const transformed = transformer() // draw line chart } else if (chart === &#39;no-group&#39;) { const transformed = transformer() // draw no-group chart } } ...}",
+ "url": " /development/writingzeppelinvisualization_transformation.html",
+ "group": "development",
+ "excerpt": "Description for Transformations"
+ }
+ ,
+
+
+
"/displaysystem/back-end-angular.html": {
"title": "Back-end Angular API 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.-->Back-end Angular API in Apache ZeppelinOverviewAngular display system treats output as a view template for AngularJS.It compiles templates and displays them inside of Apache Zeppelin. Zeppelin provides a gateway between your interpreter and your compiled AngularJS view templates.Therefore, you can not only update scope variables from your interpreter but also watch them in the interpreter, which is JVM process.Basic UsagePrint Angu
larJS viewTo use angular display system, you should start with %angular.Since name is not defined, Hello will display Hello.Please Note: Display system is backend independent.Bind / Unbind VariablesThrough ZeppelinContext, you can bind / unbind variables to AngularJS view. Currently, it only works in Spark Interpreter ( scala ).// bind my &#39;object&#39; as angular scope variable &#39;name&#39; in current notebook.z.angularBind(String name, Object object)// bind my &#39;object&#39; as angular scope variable &#39;name&#39; in all notebooks related to current interpreter.z.angularBindGlobal(String name, Object object)// unbind angular scope variable &#39;name&#39; in current notebook.z.angularUnbind(String name)// unbind angular scope variable &#39;name&#39; in all notebooks related to current interpreter.z.angularUnbindGlobal(String name)Using the above example, let&#39;s bind world variable to name. Then you can see AngularJs view
is immediately updated.Watch / Unwatch VariablesThrough ZeppelinContext, you can watch / unwatch variables in AngularJs view. Currently, it only works in Spark Interpreter ( scala ).// register for angular scope variable &#39;name&#39; (notebook)z.angularWatch(String name, (before, after) =&gt; { ... })// unregister watcher for angular variable &#39;name&#39; (notebook)z.angularUnwatch(String name)// register for angular scope variable &#39;name&#39; (global)z.angularWatchGlobal(String name, (before, after) =&gt; { ... })// unregister watcher for angular variable &#39;name&#39; (global)z.angularUnwatchGlobal(String name)Let&#39;s make a button. When it is clicked, the value of run will be increased 1 by 1.z.angularBind(&quot;run&quot;, 0) will initialize run to zero. And then, it will be also applied to run in z.angularWatch().When the button is clicked, you&#39;ll see both run and numWatched are incremented by 1.Let&#39;s
make it Simpler and more IntuitiveIn this section, we will introduce a simpler and more intuitive way of using Angular Display System in Zeppelin.Here are some usages.Import// In notebook scopeimport org.apache.zeppelin.display.angular.notebookscope._import AngularElem._// In paragraph scopeimport org.apache.zeppelin.display.angular.paragraphscope._import AngularElem._Display Element// automatically convert to string and print with %angular display system directive in front.&lt;div&gt;&lt;div&gt;.displayEvent Handler// on click&lt;div&gt;&lt;/div&gt;.onClick(() =&gt; { my callback routine}).display// on change&lt;div&gt;&lt;/div&gt;.onChange(() =&gt; { my callback routine}).display// arbitrary event&lt;div&gt;&lt;/div&gt;.onEvent(&quot;ng-click&quot;, () =&gt; { my callback routine}).displayBind Model// bind model&lt;div&gt;&lt;/div&gt;.model(&quot;myModel&quot;).display/
/ bind model with initial value&lt;div&gt;&lt;/div&gt;.model(&quot;myModel&quot;, initialValue).displayInteract with Model// read modelAngularModel(&quot;myModel&quot;)()// update modelAngularModel(&quot;myModel&quot;, &quot;newValue&quot;)Example: Basic UsageUsing the above basic usages, you can apply them like below examples.Display Elements&lt;div style=&quot;color:blue&quot;&gt; &lt;h4&gt;Hello Angular Display System&lt;/h4&gt;&lt;/div&gt;.displayOnClick Event&lt;div class=&quot;btn btn-success&quot;&gt; Click me&lt;/div&gt;.onClick{() =&gt; // callback for button click}.displayBind Model &lt;div&gt;{{{{myModel}}}}&lt;/div&gt;.model(&quot;myModel&quot;, &quot;Initial Value&quot;).displayInteract With Model// read the valueAngularModel(&quot;myModel&quot;)()// update the valueAngularModel(&quot;myModel&quot;, &
quot;New value&quot;)Example: String ConverterUsing below example, you can convert the lowercase string to uppercase.// clear previously created angular object.AngularElem.disassociateval button = &lt;div class=&quot;btn btn-success btn-sm&quot;&gt;Convert&lt;/div&gt;.onClick{() =&gt; val inputString = AngularModel(&quot;input&quot;)().toString AngularModel(&quot;title&quot;, inputString.toUpperCase)}&lt;div&gt; { &lt;h4&gt; {{{{title}}}}&lt;/h4&gt;.model(&quot;title&quot;, &quot;Please type text to convert uppercase&quot;) } Your text { &lt;input type=&quot;text&quot;&gt;&lt;/input&gt;.model(&quot;input&quot;, &quot;&quot;) } {button}&lt;/div&gt;.display",
@@ -105,7 +116,7 @@
"/install/build.html": {
"title": "Build from Source",
- "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.-->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 JDK 1.7 If you haven&#39;t installed Git and Maven yet, check the Build requirements section and follow the step by step instructions from there.1. Clone the Apache Zeppelin repositorygit clone https://github.com/apache/zeppelin.git2. B
uild sourceYou can build Zeppelin with following maven command:mvn clean package -DskipTests [Options]If you&#39;re unsure about the options, use the same commands that creates official binary package.# update all pom.xml to use scala 2.11./dev/change_scala_version.sh 2.11# build zeppelin with all interpreters and include latest version of Apache spark support for local mode.mvn clean package -DskipTests -Pspark-2.0 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pr -Pscala-2.113. DoneYou can directly start Zeppelin by running after successful build:./bin/zeppelin-daemon.sh startCheck build-profiles section for further build options.If you are behind proxy, follow instructions in Proxy setting section.If you&#39;re interested in contribution, please check Contributing to Apache Zeppelin (Code) and Contributing to Apache Zeppelin (Website).Build profilesSpark InterpreterTo build with a specific Spark version, Hadoop version or specific features, define one or more of the following pr
ofiles and options:-Pspark-[version]Set spark major versionAvailable profiles are-Pspark-2.1-Pspark-2.0-Pspark-1.6-Pspark-1.5-Pspark-1.4-Pcassandra-spark-1.5-Pcassandra-spark-1.4-Pcassandra-spark-1.3-Pcassandra-spark-1.2-Pcassandra-spark-1.1minor version can be adjusted by -Dspark.version=x.x.x-Phadoop-[version]set hadoop major versionAvailable profiles are-Phadoop-0.23-Phadoop-1-Phadoop-2.2-Phadoop-2.3-Phadoop-2.4-Phadoop-2.6-Phadoop-2.7minor version can be adjusted by -Dhadoop.version=x.x.x-Pscala-[version] (optional)set scala version (default 2.10)Available profiles are-Pscala-2.10-Pscala-2.11-Pyarn (optional)enable YARN support for local modeYARN for local mode is not supported for Spark v1.5.0 or higher. Set SPARK_HOME instead.-Ppyspark (optional)enable PySpark support for local mode.-Pr (optional)enable R support with SparkR integration.-Psparkr (optional)another R support with SparkR integration as well as local mode support.-Pvendor-repo (optional)enable 3rd party vendor rep
ository (cloudera)-Pmapr[version] (optional)For the MapR Hadoop Distribution, these profiles will handle the Hadoop version. As MapR allows different versions of Spark to be installed, you should specify which version of Spark is installed on the cluster by adding a Spark profile (-Pspark-1.6, -Pspark-2.0, etc.) as needed.The correct Maven artifacts can be found for every version of MapR at http://doc.mapr.comAvailable profiles are-Pmapr3-Pmapr40-Pmapr41-Pmapr50-Pmapr51-Pexamples (optional)Bulid examples under zeppelin-examples directoryBuild command examplesHere are some examples with several options:# build with spark-2.1, scala-2.11./dev/change_scala_version.sh 2.11mvn clean package -Pspark-2.1 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11 -DskipTests# 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 -DskipTests# build with spark-1.6, scala-2.10mvn clean package -Pspark-1.6 -P
hadoop-2.4 -Pyarn -Ppyspark -Psparkr -DskipTests# spark-cassandra integrationmvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests -DskipTests# with CDHmvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests# with MapRmvn clean package -Pspark-1.5 -Pmapr50 -DskipTestsIgnite Interpretermvn clean package -Dignite.version=1.9.0 -DskipTestsScalding Interpretermvn clean package -Pscalding -DskipTestsBuild requirementsInstall requirementsIf you don&#39;t have requirements prepared, install it.(The installation method may vary according to your environment, example is for Ubuntu.)sudo apt-get updatesudo apt-get install gitsudo apt-get install openjdk-7-jdksudo apt-get install npmsudo apt-get install libfontconfigInstall mavenwget http://www.eu.apache.org/dist/maven/maven-3/3.3.9/binaries/apache-maven-3.3.9-bin.tar.gzsudo tar -zxf apache-maven-3.3.9-bin.tar.gz -C /usr/local/sudo ln -s /usr/local/apache-maven-
3.3.9/bin/mvn /usr/local/bin/mvnNotes: - Ensure node is installed by running node --version - Ensure maven is running version 3.1.x or higher with mvn -version - Configure maven to use more memory than usual by export MAVEN_OPTS=&quot;-Xmx2g -XX:MaxPermSize=1024m&quot;Proxy setting (optional)If you&#39;re behind the proxy, you&#39;ll need to configure maven and npm to pass through it.First of all, configure maven in your ~/.m2/settings.xml.&lt;settings&gt; &lt;proxies&gt; &lt;proxy&gt; &lt;id&gt;proxy-http&lt;/id&gt; &lt;active&gt;true&lt;/active&gt; &lt;protocol&gt;http&lt;/protocol&gt; &lt;host&gt;localhost&lt;/host&gt; &lt;port&gt;3128&lt;/port&gt; &lt;!-- &lt;username&gt;usr&lt;/username&gt; &lt;password&gt;pwd&lt;/password&gt; --&gt; &lt;nonProxyHosts&gt;localhost|127.0
.0.1&lt;/nonProxyHosts&gt; &lt;/proxy&gt; &lt;proxy&gt; &lt;id&gt;proxy-https&lt;/id&gt; &lt;active&gt;true&lt;/active&gt; &lt;protocol&gt;https&lt;/protocol&gt; &lt;host&gt;localhost&lt;/host&gt; &lt;port&gt;3128&lt;/port&gt; &lt;!-- &lt;username&gt;usr&lt;/username&gt; &lt;password&gt;pwd&lt;/password&gt; --&gt; &lt;nonProxyHosts&gt;localhost|127.0.0.1&lt;/nonProxyHosts&gt; &lt;/proxy&gt; &lt;/proxies&gt;&lt;/settings&gt;Then, next commands will configure npm.npm config set proxy http://localhost:3128npm config set https-proxy http://localhost:3128npm config set registry &quot;http://registry.npmjs.org/&quot;npm config set strict-ssl falseConfigure git as wellgit config --global http.proxy http://localhost:3128git config --global https.proxy h
ttp://localhost:3128git config --global url.&quot;http://&quot;.insteadOf git://To clean up, set active false in Maven settings.xml and run these commands.npm config rm proxynpm config rm https-proxygit config --global --unset http.proxygit config --global --unset https.proxygit config --global --unset url.&quot;http://&quot;.insteadOfNotes: - If you are behind NTLM proxy you can use Cntlm Authentication Proxy. - Replace localhost:3128 with the standard pattern http://user:pwd@host:port.PackageTo package the final distribution including the compressed archive, run:mvn clean package -Pbuild-distrTo build a distribution with specific profiles, run:mvn clean package -Pbuild-distr -Pspark-1.5 -Phadoop-2.4 -Pyarn -PpysparkThe profiles -Pspark-1.5 -Phadoop-2.4 -Pyarn -Ppyspark can be adjusted if you wish to build to a specific spark versions, or omit support such as yarn. The archive is generated under zeppelin-distribution/target directoryRun end-to-end testsZeppelin com
es with a set of end-to-end acceptance tests driving headless selenium browser# assumes zeppelin-server running on localhost:8080 (use -Durl=.. to override)mvn verify# or take care of starting/stoping zeppelin-server from packaged zeppelin-distribuion/targetmvn verify -P using-packaged-distr",
+ "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.-->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 JDK 1.7 If you haven&#39;t installed Git and Maven yet, check the Build requirements section and follow the step by step instructions from there.1. Clone the Apache Zeppelin repositorygit clone https://github.com/apache/zeppelin.git2. B
uild sourceYou can build Zeppelin with following maven command:mvn clean package -DskipTests [Options]If you&#39;re unsure about the options, use the same commands that creates official binary package.# update all pom.xml to use scala 2.11./dev/change_scala_version.sh 2.11# build zeppelin with all interpreters and include latest version of Apache spark support for local mode.mvn clean package -DskipTests -Pspark-2.0 -Phadoop-2.4 -Pr -Pscala-2.113. DoneYou can directly start Zeppelin by running after successful build:./bin/zeppelin-daemon.sh startCheck build-profiles section for further build options.If you are behind proxy, follow instructions in Proxy setting section.If you&#39;re interested in contribution, please check Contributing to Apache Zeppelin (Code) and Contributing to Apache Zeppelin (Website).Build profilesSpark InterpreterTo build with a specific Spark version, Hadoop version or specific features, define one or more of the following profiles and options:-Pspark
-[version]Set spark major versionAvailable profiles are-Pspark-2.1-Pspark-2.0-Pspark-1.6-Pspark-1.5-Pspark-1.4-Pcassandra-spark-1.5-Pcassandra-spark-1.4-Pcassandra-spark-1.3-Pcassandra-spark-1.2-Pcassandra-spark-1.1minor version can be adjusted by -Dspark.version=x.x.x-Phadoop-[version]set hadoop major versionAvailable profiles are-Phadoop-0.23-Phadoop-1-Phadoop-2.2-Phadoop-2.3-Phadoop-2.4-Phadoop-2.6-Phadoop-2.7minor version can be adjusted by -Dhadoop.version=x.x.x-Pscala-[version] (optional)set scala version (default 2.10)Available profiles are-Pscala-2.10-Pscala-2.11-Pr (optional)enable R support with SparkR integration.-Pvendor-repo (optional)enable 3rd party vendor repository (cloudera)-Pmapr[version] (optional)For the MapR Hadoop Distribution, these profiles will handle the Hadoop version. As MapR allows different versions of Spark to be installed, you should specify which version of Spark is installed on the cluster by adding a Spark profile (-Pspark-1.6, -Pspark-2.0, etc.)
as needed.The correct Maven artifacts can be found for every version of MapR at http://doc.mapr.comAvailable profiles are-Pmapr3-Pmapr40-Pmapr41-Pmapr50-Pmapr51-Pexamples (optional)Bulid examples under zeppelin-examples directoryBuild command examplesHere are some examples with several options:# build with spark-2.1, scala-2.11./dev/change_scala_version.sh 2.11mvn clean package -Pspark-2.1 -Phadoop-2.4 -Pscala-2.11 -DskipTests# build with spark-2.0, scala-2.11./dev/change_scala_version.sh 2.11mvn clean package -Pspark-2.0 -Phadoop-2.4 -Pscala-2.11 -DskipTests# build with spark-1.6, scala-2.10mvn clean package -Pspark-1.6 -Phadoop-2.4 -DskipTests# spark-cassandra integrationmvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests -DskipTests# with CDHmvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests# with MapRmvn clean package -Pspark-1.5 -Pmapr50 -DskipTestsIgnite Interpretermvn clean package -Dignite.
version=1.9.0 -DskipTestsScalding Interpretermvn clean package -Pscalding -DskipTestsBuild requirementsInstall requirementsIf you don&#39;t have requirements prepared, install it.(The installation method may vary according to your environment, example is for Ubuntu.)sudo apt-get updatesudo apt-get install gitsudo apt-get install openjdk-7-jdksudo apt-get install npmsudo apt-get install libfontconfigInstall mavenwget http://www.eu.apache.org/dist/maven/maven-3/3.3.9/binaries/apache-maven-3.3.9-bin.tar.gzsudo tar -zxf apache-maven-3.3.9-bin.tar.gz -C /usr/local/sudo ln -s /usr/local/apache-maven-3.3.9/bin/mvn /usr/local/bin/mvnNotes: - Ensure node is installed by running node --version - Ensure maven is running version 3.1.x or higher with mvn -version - Configure maven to use more memory than usual by export MAVEN_OPTS=&quot;-Xmx2g -XX:MaxPermSize=1024m&quot;Proxy setting (optional)If you&#39;re behind the proxy, you&#39;ll need to configure maven and npm to pass
through it.First of all, configure maven in your ~/.m2/settings.xml.&lt;settings&gt; &lt;proxies&gt; &lt;proxy&gt; &lt;id&gt;proxy-http&lt;/id&gt; &lt;active&gt;true&lt;/active&gt; &lt;protocol&gt;http&lt;/protocol&gt; &lt;host&gt;localhost&lt;/host&gt; &lt;port&gt;3128&lt;/port&gt; &lt;!-- &lt;username&gt;usr&lt;/username&gt; &lt;password&gt;pwd&lt;/password&gt; --&gt; &lt;nonProxyHosts&gt;localhost|127.0.0.1&lt;/nonProxyHosts&gt; &lt;/proxy&gt; &lt;proxy&gt; &lt;id&gt;proxy-https&lt;/id&gt; &lt;active&gt;true&lt;/active&gt; &lt;protocol&gt;https&lt;/protocol&gt; &lt;host&gt;localhost&lt;/host&gt; &lt;port&gt;3128&lt;/port&gt; &lt;!-- &lt;usern
ame&gt;usr&lt;/username&gt; &lt;password&gt;pwd&lt;/password&gt; --&gt; &lt;nonProxyHosts&gt;localhost|127.0.0.1&lt;/nonProxyHosts&gt; &lt;/proxy&gt; &lt;/proxies&gt;&lt;/settings&gt;Then, next commands will configure npm.npm config set proxy http://localhost:3128npm config set https-proxy http://localhost:3128npm config set registry &quot;http://registry.npmjs.org/&quot;npm config set strict-ssl falseConfigure git as wellgit config --global http.proxy http://localhost:3128git config --global https.proxy http://localhost:3128git config --global url.&quot;http://&quot;.insteadOf git://To clean up, set active false in Maven settings.xml and run these commands.npm config rm proxynpm config rm https-proxygit config --global --unset http.proxygit config --global --unset https.proxygit config --global --unset url.&quot;http://&quot;.insteadOfNotes: - If you are behind NTLM proxy y
ou can use Cntlm Authentication Proxy. - Replace localhost:3128 with the standard pattern http://user:pwd@host:port.PackageTo package the final distribution including the compressed archive, run:mvn clean package -Pbuild-distrTo build a distribution with specific profiles, run:mvn clean package -Pbuild-distr -Pspark-1.5 -Phadoop-2.4The profiles -Pspark-1.5 -Phadoop-2.4 can be adjusted if you wish to build to a specific spark versions. The archive is generated under zeppelin-distribution/target directoryRun end-to-end testsZeppelin comes with a set of end-to-end acceptance tests driving headless selenium browser# assumes zeppelin-server running on localhost:8080 (use -Durl=.. to override)mvn verify# or take care of starting/stoping zeppelin-server from packaged zeppelin-distribuion/targetmvn verify -P using-packaged-distr",
"url": " /install/build.html",
"group": "install",
"excerpt": "How to build Zeppelin from source"
@@ -171,7 +182,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.The support on Spark 1.1.x to 1.3.x is deprecated.From 0.7, we uses pegdown as the markdown.parser.type option for the %md interpreter. Ren
dered markdown might be different from what you expectedFrom 0.7 note.json format has been changed to support multiple outputs in a paragraph. Zeppelin will automatically convert old format to new format. 0.6 or lower version can read new note.json format but output will not be displayed. For the detail, see ZEPPELIN-212 and pull request.From 0.7 note storage layer will utilize GitNotebookRepo by default instead of VFSNotebookRepo storage layer, which is an extension of latter one with versioning capabilities on top of it.Upgrading from Zeppelin 0.7 to 0.8From 0.8, we recommend to use PYSPARK_PYTHON and PYSPARK_DRIVER_PYTHON instead of zeppelin.pyspark.python as zeppelin.pyspark.python only effects driver. You can use PYSPARK_PYTHON and PYSPARK_DRIVER_PYTHON as using them in spark.",
+ "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.From 0.7, we uses pegdown as the markdown.parser.type option for the %md interpreter. Ren
dered markdown might be different from what you expectedFrom 0.7 note.json format has been changed to support multiple outputs in a paragraph. Zeppelin will automatically convert old format to new format. 0.6 or lower version can read new note.json format but output will not be displayed. For the detail, see ZEPPELIN-212 and pull request.From 0.7 note storage layer will utilize GitNotebookRepo by default instead of VFSNotebookRepo storage layer, which is an extension of latter one with versioning capabilities on top of it.Upgrading from Zeppelin 0.7 to 0.8From 0.8, we recommend to use PYSPARK_PYTHON and PYSPARK_DRIVER_PYTHON instead of zeppelin.pyspark.python as zeppelin.pyspark.python only effects driver. You can use PYSPARK_PYTHON and PYSPARK_DRIVER_PYTHON as using them in spark.From 0.8, depending on your device, the keyboard shortcut Ctrl-L or Command-L which goes to the line somewhere user wants is not supported. ",
"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."
@@ -182,7 +193,7 @@
"/install/virtual_machine.html": {
"title": "Apache Zeppelin on Vagrant Virtual Machine",
- "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 on Vagrant Virtual MachineOverviewApache Zeppelin distribution includes a script directoryscripts/vagrant/zeppelin-devThis script creates a virtual machine that launches a repeatable, known set of core dependencies required for developing Zeppelin. It can also be used to run an existing Zeppelin build if you don&#39;t plan to build from source.For PySpark users, this script includes several helpful Python Librar
ies.For SparkR users, this script includes several helpful R Libraries.PrerequisitesThis script requires three applications, Ansible, Vagrant and Virtual Box. All of these applications are freely available as Open Source projects and extremely easy to set up on most operating systems.Create a Zeppelin Ready VMIf you are running Windows and don&#39;t yet have python installed, install Python 2.7.x first.Download and Install Vagrant: Vagrant DownloadsInstall Ansible: Ansible Python pip installsudo easy_install pipsudo pip install ansibleansible --versionAfter then, please check whether it reports ansible version 1.9.2 or higher.Install Virtual Box: Virtual Box DownloadsType vagrant up from within the /scripts/vagrant/zeppelin-dev directoryThats it ! You can now run vagrant ssh and this will place you into the guest machines terminal prompt.If you don&#39;t wish to build Zeppelin from scratch, run the z-manager installer script while running in the guest VM:curl -fsSL https
://raw.githubusercontent.com/NFLabs/z-manager/master/zeppelin-installer.sh | bashBuilding ZeppelinYou can now git clone git://git.apache.org/zeppelin.gitinto a directory on your host machine, or directly in your virtual machine.Cloning Zeppelin into the /scripts/vagrant/zeppelin-dev directory from the host, will allow the directory to be shared between your host and the guest machine.Cloning the project again may seem counter intuitive, since this script likely originated from the project repository. Consider copying just the vagrant/zeppelin-dev script from the Zeppelin project as a stand alone directory, then once again clone the specific branch you wish to build.Synced folders enable Vagrant to sync a folder on the host machine to the guest machine, allowing you to continue working on your project&#39;s files on your host machine, but use the resources in the guest machine to compile or run your project. (1) Synced Folder Description from Vagrant UpBy default, Vagrant will s
hare your project directory (the directory with the Vagrantfile) to /vagrant. Which means you should be able to build within the guest machine after youcd /vagrant/zeppelinWhat&#39;s in this VM?Running the following commands in the guest machine should display these expected versions:node --version should report v0.12.7mvn --version should report Apache Maven 3.3.9 and Java version: 1.7.0_85The virtual machine consists of:Ubuntu Server 14.04 LTSNode.js 0.12.7npm 2.11.3ruby 1.9.3 + rake, make and bundler (only required if building jekyll documentation)Maven 3.3.9GitUnziplibfontconfig to avoid phatomJs missing dependency issuesopenjdk-7-jdkPython addons: pip, matplotlib, scipy, numpy, pandasR and R Packages required to run the R Interpreter and the related R tutorial notebook, including: Knitr, devtools, repr, rCharts, ggplot2, googleVis, mplot, htmltools, base64enc, data.tableHow to build &amp; run ZeppelinThis assumes you&#39;ve already cloned the project either on the
host machine in the zeppelin-dev directory (to be shared with the guest machine) or cloned directly into a directory while running inside the guest machine. The following build steps will also include Python and R support via PySpark and SparkR:cd /zeppelinmvn clean package -Pspark-1.6 -Ppyspark -Phadoop-2.4 -Psparkr -DskipTests./bin/zeppelin-daemon.sh startOn your host machine browse to http://localhost:8080/If you turned off port forwarding in the Vagrantfile browse to http://192.168.51.52:8080Tweaking the Virtual MachineIf you plan to run this virtual machine along side other Vagrant images, you may wish to bind the virtual machine to a specific IP address, and not use port fowarding from your local host.Comment out the forward_port line, and uncomment the private_network line in Vagrantfile. The subnet that works best for your local network will vary so adjust 192.168.*.* accordingly.#config.vm.network &quot;forwarded_port&quot;, guest: 8080, host: 8080config.vm.netwo
rk &quot;private_network&quot;, ip: &quot;192.168.51.52&quot;vagrant halt followed by vagrant up will restart the guest machine bound to the IP address of 192.168.51.52.This approach usually is typically required if running other virtual machines that discover each other directly by IP address, such as Spark Masters and Slaves as well as Cassandra Nodes, Elasticsearch Nodes, and other Spark data sources. You may wish to launch nodes in virtual machines with IP addresses in a subnet that works for your local network, such as: 192.168.51.53, 192.168.51.54, 192.168.51.53, etc..ExtrasPython ExtrasWith Zeppelin running, Numpy, SciPy, Pandas and Matplotlib will be available. Create a pyspark notebook, and try the below code.%pysparkimport numpyimport scipyimport pandasimport matplotlibprint &quot;numpy &quot; + numpy.__version__print &quot;scipy &quot; + scipy.__version__print &quot;pandas &quot; + pandas.__version__print &quot;matplotlib &
;quot; + matplotlib.__version__To Test plotting using Matplotlib into a rendered %html SVG image, try%pysparkimport matplotlibmatplotlib.use(&#39;Agg&#39;) # turn off interactive charting so this works for server side SVG renderingimport matplotlib.pyplot as pltimport numpy as npimport StringIO# clear out any previous plots on this noteplt.clf()def show(p): img = StringIO.StringIO() p.savefig(img, format=&#39;svg&#39;) img.seek(0) print &quot;%html &lt;div style=&#39;width:600px&#39;&gt;&quot; + img.buf + &quot;&lt;/div&gt;&quot;# Example datapeople = (&#39;Tom&#39;, &#39;Dick&#39;, &#39;Harry&#39;, &#39;Slim&#39;, &#39;Jim&#39;)y_pos = np.arange(len(people))performance = 3 + 10 * np.random.rand(len(people))error = np.random.rand(len(people))plt.barh(y_pos, performance, xerr=error, align=&#39;center&#39;, alpha=0.4)plt.yticks(y_pos, people)plt.xlabel(&#39;Perform
ance&#39;)plt.title(&#39;How fast do you want to go today?&#39;)show(plt)R ExtrasWith zeppelin running, an R Tutorial notebook will be available. The R packages required to run the examples and graphs in this tutorial notebook were installed by this virtual machine.The installed R Packages include: Knitr, devtools, repr, rCharts, ggplot2, googleVis, mplot, htmltools, base64enc, data.table",
[... 23 lines stripped ...]
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html?rev=1791664&r1=1791663&r2=1791664&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html Mon Apr 17 07:01:48 2017
@@ -164,10 +164,11 @@
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
- <li class="title"><span><b>Helium Framework</b><span></li>
- <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
- <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinspell.html">Writing Zeppelin Spell (Experimental)</a></li>
- <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li class="title"><span><b>Helium Framework (Experimental)</b></span></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinapplication.html">Writing Zeppelin Application</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinspell.html">Writing Zeppelin Spell</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization: Basics</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization_transformation.html">Writing Zeppelin Visualization: Transformation</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>Advanced</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>