Added: zeppelin/site/docs/0.7.3/manual/dynamicinterpreterload.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/manual/dynamicinterpreterload.html?rev=1809223&view=auto ============================================================================== --- zeppelin/site/docs/0.7.3/manual/dynamicinterpreterload.html (added) +++ zeppelin/site/docs/0.7.3/manual/dynamicinterpreterload.html Thu Sep 21 20:33:57 2017 @@ -0,0 +1,343 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Apache Zeppelin 0.7.3 Documentation: Dynamic Interpreter Loading using REST API</title> + <meta name="description" content="Apache Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this page, we will introduce dynamic interpreter loading using REST API."> + <meta name="author" content="The Apache Software Foundation"> + + <!-- Enable responsive viewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> + <!--[if lt IE 9]> + <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> + <![endif]--> + + <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet"> + + <!-- Le styles --> + <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" /> + <!-- Le fav and touch icons --> + <!-- Update these with your own images + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + --> + + <!-- Js --> + <script src="https://code.jquery.com/jquery-1.10.2.min.js";></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script> + + <!-- atom & rss feed --> + <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed"> + <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed"> + </head> + + <body> + + <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <div class="navbar-brand"> + <a class="navbar-brand-main" href="http://zeppelin.apache.org";> + <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin"> + <span style="vertical-align:middle">Zeppelin</span> + </a> + <a class="navbar-brand-version" href="/docs/0.7.3"> + <span><small>0.7.3</small></span> + </a> + </div> + </div> + <nav class="navbar-collapse collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Getting Started</b><span></li> + <li><a href="/docs/0.7.3/install/install.html">Install</a></li> + <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li> + <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li> + <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Basic Feature Guide</b><span></li> + <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li> + <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li> + <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>More</b><span></li> + <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li> + <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li> + <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu"> + <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Usage</b><span></li> + <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li> + <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>--> + <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li> + <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li> + <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Available Interpreters</b><span></li> + <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li> + <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li> + <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li> + <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li> + <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li> + <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li> + <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li> + <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li> + <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li> + <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li> + <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li> + <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li> + <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li> + <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li> + <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li> + <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li> + <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li> + <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li> + <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li> + <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li> + <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li> + <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li> + <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li> + <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li class="title"><span><b>Basic Display System</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Angular API</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li> + <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> + <li class="title"><span><b>Notebook Storage</b><span></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>REST API</b><span></li> + <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Security</b><span></li> + <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li> + <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li> + <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li> + <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li> + <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Advanced</b><span></li> + <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li> + <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Contibute</b><span></li> + <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li> + <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li> + </ul> + </li> + <li> + <a href="/docs/0.7.3/search.html" class="nav-search-link"> + <span class="fa fa-search nav-search-icon"></span> + </a> + </li> + </ul> + </nav><!--/.navbar-collapse --> + </div> + </div> + + + + <div class="content"> + +<!--<div class="hero-unit Dynamic Interpreter Loading using REST API"> + <h1></h1> +</div> +--> + +<div class="row"> + <div class="col-md-12"> + <!-- +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 at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed 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 and +limitations under the License. +--> + +<h1>Dynamic Interpreter Loading using REST API</h1> + +<div id="toc"></div> + +<p>Apache Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this section, we will introduce <strong>Dynamic interpreter loading</strong> using <strong>REST API</strong>. This concept actually comes from <a href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal";>Zeppelin Helium Proposal</a>. +Before we start, if you are not familiar with the concept of <strong>Zeppelin interpreter</strong>, you can check out <a href="../manual/interpreters.html">Overview of Zeppelin interpreter</a> first.</p> + +<h2>Overview</h2> + +<p>In the past, Zeppelin was loading interpreter binaries from <code>/interpreter/[interpreter_name]</code> directory. They were configured by <code>zeppelin.interpreters</code> property in <code>conf/zeppelin-site.xml</code> or <code>ZEPPELIN_INTERPRETERS</code> env variables in <code>conf/zeppelin-env.sh</code>. They were loaded on Zeppelin server startup and stayed alive until the server was stopped. +In order to simplify using 3rd party interpreters, we changed this way to <strong>dynamically</strong> load interpreters from <strong>Maven Repository</strong> using <strong>REST API</strong>. Hopefully, the picture below will help you to understand the process. +<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin_user.png" height="85%" width="85%"></center></p> + +<h2>Load & Unload Interpreters Using REST API</h2> + +<h3>Load</h3> + +<p>You can <strong>load</strong> interpreters located in Maven repository using REST API, like this:</p> + +<p>( Maybe, you are unfamiliar with <code>[interpreter_group_name]</code> or <code>[interpreter_name]</code>. If so, please checkout <a href="../manual/interpreter.html">Interpreters in Zeppelin</a> again. )</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">http://[zeppelin-server]:[zeppelin-port]/api/interpreter/load/[interpreter_group_name]/[interpreter_name] +</code></pre></div> +<p>The Restful method will be <code><strong>POST</strong></code>. And the parameters you need are:</p> + +<ol> +<li><p><strong>Artifact:</strong> Maven artifact ( groupId:artifactId:version ) </p></li> +<li><p><strong>Class Name:</strong> Package name + Interpreter class name</p></li> +<li><p><strong>Repository ( optional ):</strong> Additional maven repository address</p></li> +</ol> + +<p>For example, if you want to load <code>markdown</code> interpreter to your Zeppelin, the parameters and URL you need may look like:</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">http://127.0.0.1:8080/api/interpreter/load/md/markdown +</code></pre></div><div class="highlight"><pre><code class="text language-text" data-lang="text">{ + "artifact": "org.apache.zeppelin:zeppelin-markdown:0.6.0-SNAPSHOT", + "className": "org.apache.zeppelin.markdown.Markdown", + "repository": { + "url": "http://dl.bintray.com/spark-packages/maven", + "snapshot": false + } +} +</code></pre></div> +<p>The meaning of each parameters is: </p> + +<ol> +<li><strong>Artifact</strong></li> +<li>groupId: org.apache.zeppelin</li> +<li>artifactId: zeppelin-markdown</li> +<li><p>version: 0.6.0-SNAPSHOT</p></li> +<li><p><strong>Class Name</strong></p></li> +<li><p>Package Name: org.apache.zeppelin</p></li> +<li><p>Interpreter Class Name: markdown.Markdown</p></li> +<li><p><strong>Repository ( optional )</strong></p></li> +<li><p>Url: http://dl.bintray.com/spark-packages/maven</p></li> +<li><p>Snapshot: false</p></li> +</ol> + +<blockquote> +<p><b>Please note: </b>The interpreters you downloaded need to be <strong>reload</strong>, when your Zeppelin server is down. </p> +</blockquote> + +<h3>Unload</h3> + +<p>If you want to <strong>unload</strong> the interpreters using REST API, </p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">http://[zeppelin-server]:[zeppelin-port]/api/interpreter/unload/[interpreter_group_name]/[interpreter_name] +</code></pre></div> +<p>In this case, the Restful method will be <code><strong>DELETE</strong></code>.</p> + +<p><br/></p> + +<h2>What is the next step after Loading ?</h2> + +<h3>Q1. Where is the location of interpreters you downloaded ?</h3> + +<p>Actually, the answer about this question is in the above picture. Once the REST API is called, the <code>.jar</code> files of interpreters you get are saved under <code>ZEPPELIN_HOME/local-repo</code> first. Then, they will be copied to <code>ZEPPELIN_HOME/interpreter</code> directory. So, please checkout your <code>ZEPPELIN_HOME/interpreter</code>.</p> + +<h3>Q2. Then, how can I use this interpreter ?</h3> + +<p>After loading an interpreter, you can use it by creating and configuring it in Zeppelin's <strong>Interpreter tab</strong>.</p> + +<p>Oh, you don't need to restart your Zeppelin server. Because it is <strong>Dynamic Loading</strong>, you can configure and load it <strong>at runtime</strong> !</p> + +<ol> +<li><p>After Zeppelin server up, browse Zeppelin home and click <strong>Interpreter tab</strong>. +<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_1.png" height="85%" width="85%"></center></p></li> +<li><p>At the <strong>Interpreter</strong> section, click <strong>+Create</strong> button. +<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_2.png" height="85%" width="85%"></center></p></li> +<li><p>Then, you can verify the interpreter list that you loaded. +<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_3.png" height="85%" width="85%"></center></p></li> +<li><p>After choosing an interpreter, you can configure and use it. Don't forget to save it.</p></li> +<li><p>Create a new notebook in the <strong>Notebook</strong> section, then you can bind the interpreters from your interpreter list. Just drag and drop ! +<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_1.png" height="85%" width="85%"></center> +<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_2.png" height="85%" width="85%"></center></p></li> +<li><p>At last, you can use your interpreter !</p></li> +</ol> + +<p>If you want to get the specific information about respective interpreters, please checkout each interpreter documentation. </p> + + </div> +</div> + + + <hr> + <footer> + <!-- <p>© 2017 The Apache Software Foundation</p>--> + </footer> + </div> + + + + + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-45176241-5', 'zeppelin.apache.org'); + ga('require', 'linkid', 'linkid.js'); + ga('send', 'pageview'); + +</script> + + + + </body> +</html> +
Added: zeppelin/site/docs/0.7.3/manual/interpreterexechooks.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/manual/interpreterexechooks.html?rev=1809223&view=auto ============================================================================== --- zeppelin/site/docs/0.7.3/manual/interpreterexechooks.html (added) +++ zeppelin/site/docs/0.7.3/manual/interpreterexechooks.html Thu Sep 21 20:33:57 2017 @@ -0,0 +1,293 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Apache Zeppelin 0.7.3 Documentation: Interpreter Execution Hooks (Experimental)</title> + <meta name="description" content="Apache Zeppelin allows for users to specify additional code to be executed by an interpreter at pre and post-paragraph code execution."> + <meta name="author" content="The Apache Software Foundation"> + + <!-- Enable responsive viewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> + <!--[if lt IE 9]> + <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> + <![endif]--> + + <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet"> + + <!-- Le styles --> + <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" /> + <!-- Le fav and touch icons --> + <!-- Update these with your own images + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + --> + + <!-- Js --> + <script src="https://code.jquery.com/jquery-1.10.2.min.js";></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script> + + <!-- atom & rss feed --> + <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed"> + <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed"> + </head> + + <body> + + <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <div class="navbar-brand"> + <a class="navbar-brand-main" href="http://zeppelin.apache.org";> + <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin"> + <span style="vertical-align:middle">Zeppelin</span> + </a> + <a class="navbar-brand-version" href="/docs/0.7.3"> + <span><small>0.7.3</small></span> + </a> + </div> + </div> + <nav class="navbar-collapse collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Getting Started</b><span></li> + <li><a href="/docs/0.7.3/install/install.html">Install</a></li> + <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li> + <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li> + <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Basic Feature Guide</b><span></li> + <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li> + <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li> + <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>More</b><span></li> + <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li> + <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li> + <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu"> + <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Usage</b><span></li> + <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li> + <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>--> + <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li> + <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li> + <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Available Interpreters</b><span></li> + <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li> + <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li> + <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li> + <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li> + <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li> + <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li> + <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li> + <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li> + <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li> + <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li> + <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li> + <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li> + <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li> + <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li> + <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li> + <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li> + <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li> + <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li> + <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li> + <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li> + <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li> + <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li> + <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li> + <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li class="title"><span><b>Basic Display System</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Angular API</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li> + <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> + <li class="title"><span><b>Notebook Storage</b><span></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>REST API</b><span></li> + <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Security</b><span></li> + <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li> + <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li> + <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li> + <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li> + <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Advanced</b><span></li> + <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li> + <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Contibute</b><span></li> + <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li> + <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li> + </ul> + </li> + <li> + <a href="/docs/0.7.3/search.html" class="nav-search-link"> + <span class="fa fa-search nav-search-icon"></span> + </a> + </li> + </ul> + </nav><!--/.navbar-collapse --> + </div> + </div> + + + + <div class="content"> + +<!--<div class="hero-unit Interpreter Execution Hooks (Experimental)"> + <h1></h1> +</div> +--> + +<div class="row"> + <div class="col-md-12"> + <!-- +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 at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed 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 and +limitations under the License. +--> + +<h1>Interpreter Execution Hooks (Experimental)</h1> + +<div id="toc"></div> + +<h2>Overview</h2> + +<p>Apache Zeppelin allows for users to specify additional code to be executed by an interpreter at pre and post-paragraph code execution. +This is primarily useful if you need to run the same set of code for all of the paragraphs within your notebook at specific times. +Currently, this feature is only available for the spark and pyspark interpreters. +To specify your hook code, you may use <code>z.registerHook()</code>. +For example, enter the following into one paragraph:</p> +<div class="highlight"><pre><code class="python language-python" data-lang="python"><span class="o">%</span><span class="n">pyspark</span> +<span class="n">z</span><span class="o">.</span><span class="n">registerHook</span><span class="p">(</span><span class="s">"post_exec"</span><span class="p">,</span> <span class="s">"print 'This code should be executed before the parapgraph code!'"</span><span class="p">)</span> +<span class="n">z</span><span class="o">.</span><span class="n">registerHook</span><span class="p">(</span><span class="s">"pre_exec"</span><span class="p">,</span> <span class="s">"print 'This code should be executed after the paragraph code!'"</span><span class="p">)</span> +</code></pre></div> +<p>These calls will not take into effect until the next time you run a paragraph. </p> + +<p>In another paragraph, enter</p> +<div class="highlight"><pre><code class="python language-python" data-lang="python"><span class="o">%</span><span class="n">pyspark</span> +<span class="k">print</span> <span class="s">"This code should be entered into the paragraph by the user!"</span> +</code></pre></div> +<p>The output should be:</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">This code should be executed before the paragraph code! +This code should be entered into the paragraph by the user! +This code should be executed after the paragraph code! +</code></pre></div> +<p>If you ever need to know the hook code, use <code>z.getHook()</code>:</p> +<div class="highlight"><pre><code class="python language-python" data-lang="python"><span class="o">%</span><span class="n">pyspark</span> +<span class="k">print</span> <span class="n">z</span><span class="o">.</span><span class="n">getHook</span><span class="p">(</span><span class="s">"post_exec"</span><span class="p">)</span> + +<span class="k">print</span> <span class="s">'This code should be executed after the paragraph code!'</span> +</code></pre></div> +<p>Any call to <code>z.registerHook()</code> will automatically overwrite what was previously registered. +To completely unregister a hook event, use <code>z.unregisterHook(eventCode)</code>. +Currently only <code>"post_exec"</code> and <code>"pre_exec"</code> are valid event codes for the Zeppelin Hook Registry system.</p> + +<p>Finally, the hook registry is internally shared by other interpreters in the same group. +This would allow for hook code for one interpreter REPL to be set by another as follows:</p> +<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="o">%</span><span class="n">spark</span> +<span class="n">z</span><span class="o">.</span><span class="n">unregisterHook</span><span class="o">(</span><span class="s">"post_exec"</span><span class="o">,</span> <span class="s">"pyspark"</span><span class="o">)</span> +</code></pre></div> +<p>The API is identical for both the spark (scala) and pyspark (python) implementations.</p> + +<h3>Caveats</h3> + +<p>Calls to <code>z.registerHook("pre_exec", ...)</code> should be made with care. If there are errors in your specified hook code, this will cause the interpreter REPL to become unable to execute any code pass the pre-execute stage making it impossible for direct calls to <code>z.unregisterHook()</code> to take into effect. Current workarounds include calling <code>z.unregisterHook()</code> from a different interpreter REPL in the same interpreter group (see above) or manually restarting the interpreter group in the UI. </p> + + </div> +</div> + + + <hr> + <footer> + <!-- <p>© 2017 The Apache Software Foundation</p>--> + </footer> + </div> + + + + + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-45176241-5', 'zeppelin.apache.org'); + ga('require', 'linkid', 'linkid.js'); + ga('send', 'pageview'); + +</script> + + + + </body> +</html> + Added: zeppelin/site/docs/0.7.3/manual/interpreterinstallation.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/manual/interpreterinstallation.html?rev=1809223&view=auto ============================================================================== --- zeppelin/site/docs/0.7.3/manual/interpreterinstallation.html (added) +++ zeppelin/site/docs/0.7.3/manual/interpreterinstallation.html Thu Sep 21 20:33:57 2017 @@ -0,0 +1,442 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Apache Zeppelin 0.7.3 Documentation: Interpreter Installation in Netinst Binary Package</title> + <meta name="description" content="Apache Zeppelin provides Interpreter Installation mechanism for whom downloaded Zeppelin netinst binary package, or just want to install another 3rd party interpreters."> + <meta name="author" content="The Apache Software Foundation"> + + <!-- Enable responsive viewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> + <!--[if lt IE 9]> + <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> + <![endif]--> + + <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet"> + + <!-- Le styles --> + <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" /> + <!-- Le fav and touch icons --> + <!-- Update these with your own images + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + --> + + <!-- Js --> + <script src="https://code.jquery.com/jquery-1.10.2.min.js";></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script> + + <!-- atom & rss feed --> + <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed"> + <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed"> + </head> + + <body> + + <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <div class="navbar-brand"> + <a class="navbar-brand-main" href="http://zeppelin.apache.org";> + <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin"> + <span style="vertical-align:middle">Zeppelin</span> + </a> + <a class="navbar-brand-version" href="/docs/0.7.3"> + <span><small>0.7.3</small></span> + </a> + </div> + </div> + <nav class="navbar-collapse collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Getting Started</b><span></li> + <li><a href="/docs/0.7.3/install/install.html">Install</a></li> + <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li> + <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li> + <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Basic Feature Guide</b><span></li> + <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li> + <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li> + <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>More</b><span></li> + <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li> + <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li> + <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu"> + <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Usage</b><span></li> + <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li> + <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>--> + <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li> + <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li> + <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Available Interpreters</b><span></li> + <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li> + <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li> + <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li> + <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li> + <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li> + <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li> + <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li> + <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li> + <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li> + <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li> + <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li> + <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li> + <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li> + <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li> + <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li> + <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li> + <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li> + <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li> + <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li> + <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li> + <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li> + <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li> + <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li> + <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li class="title"><span><b>Basic Display System</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Angular API</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li> + <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> + <li class="title"><span><b>Notebook Storage</b><span></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>REST API</b><span></li> + <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Security</b><span></li> + <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li> + <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li> + <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li> + <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li> + <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Advanced</b><span></li> + <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li> + <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Contibute</b><span></li> + <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li> + <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li> + </ul> + </li> + <li> + <a href="/docs/0.7.3/search.html" class="nav-search-link"> + <span class="fa fa-search nav-search-icon"></span> + </a> + </li> + </ul> + </nav><!--/.navbar-collapse --> + </div> + </div> + + + + <div class="content"> + +<!--<div class="hero-unit Interpreter Installation in Netinst Binary Package"> + <h1></h1> +</div> +--> + +<div class="row"> + <div class="col-md-12"> + <!-- +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 at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed 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 and +limitations under the License. +--> + +<h1>Interpreter Installation</h1> + +<div id="toc"></div> + +<p>Apache Zeppelin provides <strong>Interpreter Installation</strong> mechanism for whom downloaded Zeppelin <code>netinst</code> binary package, or just want to install another 3rd party interpreters.</p> + +<h2>Community managed interpreters</h2> + +<p>Apache Zeppelin provides several interpreters as <a href="#available-community-managed-interpreters">community managed interpreters</a>. +If you downloaded <code>netinst</code> binary package, you need to install by using below commands.</p> + +<h4>Install all community managed interpreters</h4> +<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/install-interpreter.sh --all +</code></pre></div> +<h4>Install specific interpreters</h4> +<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/install-interpreter.sh --name md,shell,jdbc,python +</code></pre></div> +<p>You can get full list of community managed interpreters by running</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/install-interpreter.sh --list +</code></pre></div> +<h4>Install interpreter built with Scala 2.10</h4> + +<p>Zeppelin support both Scala 2.10 and 2.11 for several interpreters as below:</p> + +<table class="table-configuration"> + <tr> + <th>Name</th> + <th>Maven Artifact for Scala 2.10</th> + <th>Maven Artifact for Scala 2.11</th> + </tr> + <tr> + <td>cassandra</td> + <td>org.apache.zeppelin:zeppelin-cassandra_2.10:0.7.3</td> + <td>org.apache.zeppelin:zeppelin-cassandra_2.11:0.7.3</td> + </tr> + <tr> + <td>flink</td> + <td>org.apache.zeppelin:zeppelin-flink_2.10:0.7.3</td> + <td>org.apache.zeppelin:zeppelin-flink_2.11:0.7.3</td> + </tr> + <tr> + <td>ignite</td> + <td>org.apache.zeppelin:zeppelin-ignite_2.10:0.7.3</td> + <td>org.apache.zeppelin:zeppelin-ignite_2.11:0.7.3</td> + </tr> + <tr> + <td>scio</td> + <td>org.apache.zeppelin:zeppelin-scio_2.10:0.7.3</td> + <td>org.apache.zeppelin:zeppelin-scio_2.11:0.7.3</td> + </tr> + <tr> + <td>spark</td> + <td>org.apache.zeppelin:zeppelin-spark_2.10:0.7.3</td> + <td>org.apache.zeppelin:zeppelin-spark_2.11:0.7.3</td> + </tr> +</table> + +<p>If you install one of these interpreters only with <code>--name</code> option, installer will download interpreter built with Scala 2.11 by default. If you want to specify Scala version, you will need to add <code>--artifact</code> option. Here is the example of installing flink interpreter built with Scala 2.10.</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/install-interpreter.sh --name flink --artifact org.apache.zeppelin:zeppelin-flink_2.10:0.7.3 +</code></pre></div> +<h4>Install Spark interpreter built with Scala 2.10</h4> + +<p>Spark distribution package has been built with Scala 2.10 until 1.6.2. If you have <code>SPARK_HOME</code> set pointing to Spark version earlier than 2.0.0, you need to download Spark interpreter packaged with Scala 2.10. To do so, use follow command:</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">rm -rf ./interpreter/spark +./bin/install-interpreter.sh --name spark --artifact org.apache.zeppelin:zeppelin-spark_2.10:0.7.3 +</code></pre></div> +<p><br /> +Once you have installed interpreters, you need to restart Zeppelin. And then <a href="../manual/interpreters.html#what-is-zeppelin-interpreter">create interpreter setting</a> and <a href="../manual/interpreters.html#what-is-zeppelin-interpreter-setting">bind it with your notebook</a>.</p> + +<h2>3rd party interpreters</h2> + +<p>You can also install 3rd party interpreters located in the maven repository by using below commands.</p> + +<h4>Install 3rd party interpreters</h4> +<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/install-interpreter.sh --name interpreter1 --artifact groupId1:artifact1:version1 +</code></pre></div> +<p>The above command will download maven artifact <code>groupId1:artifact1:version1</code> and all of it's transitive dependencies into <code>interpreter/interpreter1</code> directory.</p> + +<p>After restart Zeppelin, then <a href="../manual/interpreters.html#what-is-zeppelin-interpreter">create interpreter setting</a> and <a href="../manual/interpreters.html#what-is-zeppelin-interpreter-setting">bind it with your notebook</a>.</p> + +<h4>Install multiple 3rd party interpreters at once</h4> +<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/install-interpreter.sh --name interpreter1,interpreter2 --artifact groupId1:artifact1:version1,groupId2:artifact2:version2 +</code></pre></div> +<p><code>--name</code> and <code>--artifact</code> arguments will recieve comma separated list.</p> + +<h2>Available community managed interpreters</h2> + +<p>You can also find the below community managed interpreter list in <code>conf/interpreter-list</code> file. +<table class="table-configuration"> + <tr> + <th>Name</th> + <th>Maven Artifact</th> + <th>Description</th> + </tr> + <tr> + <td>alluxio</td> + <td>org.apache.zeppelin:zeppelin-alluxio:0.7.3</td> + <td>Alluxio interpreter</td> + </tr> + <tr> + <td>angular</td> + <td>org.apache.zeppelin:zeppelin-angular:0.7.3</td> + <td>HTML and AngularJS view rendering</td> + </tr> + <tr> + <td>beam</td> + <td>org.apache.zeppelin:zeppelin-beam:0.7.3</td> + <td>Beam interpreter</td> + </tr> + <tr> + <td>bigquery</td> + <td>org.apache.zeppelin:zeppelin-bigquery:0.7.3</td> + <td>BigQuery interpreter</td> + </tr> + <tr> + <td>cassandra</td> + <td>org.apache.zeppelin:zeppelin-cassandra_2.11:0.7.3</td> + <td>Cassandra interpreter built with Scala 2.11</td> + </tr> + <tr> + <td>elasticsearch</td> + <td>org.apache.zeppelin:zeppelin-elasticsearch:0.7.3</td> + <td>Elasticsearch interpreter</td> + </tr> + <tr> + <td>file</td> + <td>org.apache.zeppelin:zeppelin-file:0.7.3</td> + <td>HDFS file interpreter</td> + </tr> + <tr> + <td>flink</td> + <td>org.apache.zeppelin:zeppelin-flink_2.11:0.7.3</td> + <td>Flink interpreter built with Scala 2.11</td> + </tr> + <tr> + <td>hbase</td> + <td>org.apache.zeppelin:zeppelin-hbase:0.7.3</td> + <td>Hbase interpreter</td> + </tr> + <tr> + <td>ignite</td> + <td>org.apache.zeppelin:zeppelin-ignite_2.11:0.7.3</td> + <td>Ignite interpreter built with Scala 2.11</td> + </tr> + <tr> + <td>jdbc</td> + <td>org.apache.zeppelin:zeppelin-jdbc:0.7.3</td> + <td>Jdbc interpreter</td> + </tr> + <tr> + <td>kylin</td> + <td>org.apache.zeppelin:zeppelin-kylin:0.7.3</td> + <td>Kylin interpreter</td> + </tr> + <tr> + <td>lens</td> + <td>org.apache.zeppelin:zeppelin-lens:0.7.3</td> + <td>Lens interpreter</td> + </tr> + <tr> + <td>livy</td> + <td>org.apache.zeppelin:zeppelin-livy:0.7.3</td> + <td>Livy interpreter</td> + </tr> + <tr> + <td>md</td> + <td>org.apache.zeppelin:zeppelin-markdown:0.7.3</td> + <td>Markdown support</td> + </tr> + <tr> + <td>pig</td> + <td>org.apache.zeppelin:zeppelin-pig:0.7.3</td> + <td>Pig interpreter</td> + </tr> + <tr> + <td>postgresql</td> + <td>org.apache.zeppelin:zeppelin-postgresql:0.7.3</td> + <td>Postgresql interpreter</td> + </tr> + <tr> + <td>python</td> + <td>org.apache.zeppelin:zeppelin-python:0.7.3</td> + <td>Python interpreter</td> + </tr> + <tr> + <td>scio</td> + <td>org.apache.zeppelin:zeppelin-scio_2.11:0.7.3</td> + <td>Scio interpreter built with Scala 2.11</td> + </tr> + <tr> + <td>shell</td> + <td>org.apache.zeppelin:zeppelin-shell:0.7.3</td> + <td>Shell command</td> + </tr> +</table></p> + + </div> +</div> + + + <hr> + <footer> + <!-- <p>© 2017 The Apache Software Foundation</p>--> + </footer> + </div> + + + + + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-45176241-5', 'zeppelin.apache.org'); + ga('require', 'linkid', 'linkid.js'); + ga('send', 'pageview'); + +</script> + + + + </body> +</html> + Added: zeppelin/site/docs/0.7.3/manual/interpreters.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/manual/interpreters.html?rev=1809223&view=auto ============================================================================== --- zeppelin/site/docs/0.7.3/manual/interpreters.html (added) +++ zeppelin/site/docs/0.7.3/manual/interpreters.html Thu Sep 21 20:33:57 2017 @@ -0,0 +1,305 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Apache Zeppelin 0.7.3 Documentation: Interpreters in Apache Zeppelin</title> + <meta name="description" content="This document explains about the role of interpreters, interpreters group and interpreter settings in Apache Zeppelin. The concept of Zeppelin interpreter allows any language/data-processing-backend to be plugged into Zeppelin."> + <meta name="author" content="The Apache Software Foundation"> + + <!-- Enable responsive viewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> + <!--[if lt IE 9]> + <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> + <![endif]--> + + <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet"> + + <!-- Le styles --> + <link href="/docs/0.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css"> + <link href="/docs/0.7.3/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" /> + <!-- Le fav and touch icons --> + <!-- Update these with your own images + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + --> + + <!-- Js --> + <script src="https://code.jquery.com/jquery-1.10.2.min.js";></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script> + <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script> + + <!-- atom & rss feed --> + <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed"> + <link href="/docs/0.7.3/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed"> + </head> + + <body> + + <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <div class="navbar-brand"> + <a class="navbar-brand-main" href="http://zeppelin.apache.org";> + <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin"> + <span style="vertical-align:middle">Zeppelin</span> + </a> + <a class="navbar-brand-version" href="/docs/0.7.3"> + <span><small>0.7.3</small></span> + </a> + </div> + </div> + <nav class="navbar-collapse collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Getting Started</b><span></li> + <li><a href="/docs/0.7.3/install/install.html">Install</a></li> + <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li> + <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li> + <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Basic Feature Guide</b><span></li> + <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li> + <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li> + <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>More</b><span></li> + <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li> + <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li> + <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu"> + <li><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Usage</b><span></li> + <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li> + <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>--> + <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li> + <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li> + <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Available Interpreters</b><span></li> + <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li> + <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li> + <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li> + <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li> + <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li> + <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li> + <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li> + <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li> + <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li> + <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li> + <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li> + <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li> + <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li> + <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li> + <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li> + <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li> + <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li> + <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li> + <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li> + <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li> + <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li> + <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li> + <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li> + <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li class="title"><span><b>Basic Display System</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li> + <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Angular API</b><span></li> + <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li> + <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</a></li> + </ul> + </li> + <li> + <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a> + <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> + <li class="title"><span><b>Notebook Storage</b><span></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li> + <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>REST API</b><span></li> + <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li> + <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Security</b><span></li> + <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li> + <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li> + <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li> + <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li> + <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Advanced</b><span></li> + <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li> + <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li> + <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li> + <li role="separator" class="divider"></li> + <li class="title"><span><b>Contibute</b><span></li> + <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li> + <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li> + <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li> + </ul> + </li> + <li> + <a href="/docs/0.7.3/search.html" class="nav-search-link"> + <span class="fa fa-search nav-search-icon"></span> + </a> + </li> + </ul> + </nav><!--/.navbar-collapse --> + </div> + </div> + + + + <div class="content"> + +<!--<div class="hero-unit Interpreters in Apache Zeppelin"> + <h1></h1> +</div> +--> + +<div class="row"> + <div class="col-md-12"> + <!-- +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 at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed 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 and +limitations under the License. +--> + +<h1>Interpreters in Apache Zeppelin</h1> + +<div id="toc"></div> + +<h2>Overview</h2> + +<p>In this section, we will explain about the role of interpreters, interpreters group and interpreter settings in Zeppelin. +The concept of Zeppelin interpreter allows any language/data-processing-backend to be plugged into Zeppelin. +Currently, Zeppelin supports many interpreters such as Scala ( with Apache Spark ), Python ( with Apache Spark ), Spark SQL, JDBC, Markdown, Shell and so on.</p> + +<h2>What is Zeppelin interpreter?</h2> + +<p>Zeppelin Interpreter is a plug-in which enables Zeppelin users to use a specific language/data-processing-backend. For example, to use Scala code in Zeppelin, you need <code>%spark</code> interpreter.</p> + +<p>When you click the <code>+Create</code> button in the interpreter page, the interpreter drop-down list box will show all the available interpreters on your server.</p> + +<p><img src="../assets/themes/zeppelin/img/screenshots/interpreter_create.png" width="280px"></p> + +<h2>What is interpreter setting?</h2> + +<p>Zeppelin interpreter setting is the configuration of a given interpreter on Zeppelin server. For example, the properties are required for hive JDBC interpreter to connect to the Hive server.</p> + +<p><img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting.png" width="500px"></p> + +<p>Properties are exported as environment variable when property name is consisted of upper characters, numbers and underscore ([A-Z_0-9]). Otherwise set properties as JVM property.</p> + +<p>Each notebook can be bound to multiple Interpreter Settings using setting icon on upper right corner of the notebook.</p> + +<p><img src="../assets/themes/zeppelin/img/screenshots/interpreter_binding.png" width="800px"></p> + +<h2>What is interpreter group?</h2> + +<p>Every Interpreter is belonged to an <strong>Interpreter Group</strong>. Interpreter Group is a unit of start/stop interpreter. +By default, every interpreter is belonged to a single group, but the group might contain more interpreters. For example, Spark interpreter group is including Spark support, pySpark, Spark SQL and the dependency loader.</p> + +<p>Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout <a href="../development/writingzeppelininterpreter.html">here</a>.</p> + +<p>Each interpreters is belonged to a single group and registered together. All of their properties are listed in the interpreter setting like below image.</p> + +<p><img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png" width="500px"></p> + +<h2>Interpreter binding mode</h2> + +<p>Each Interpreter Setting can choose one of 'shared', 'scoped', 'isolated' interpreter binding mode. +In 'shared' mode, every notebook bound to the Interpreter Setting will share the single Interpreter instance. In 'scoped' mode, each notebook will create new Interpreter instance in the same interpreter process. In 'isolated' mode, each notebook will create new Interpreter process.</p> + +<p><img src="../assets/themes/zeppelin/img/screenshots/interpreter_persession.png" width="400px"></p> + +<h2>Connecting to the existing remote interpreter</h2> + +<p>Zeppelin users can start interpreter thread embedded in their service. This will provide flexibility to user to start interpreter on remote host. To start interpreter along with your service you have to create an instance of <code>RemoteInterpreterServer</code> and start it as follows:</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">RemoteInterpreterServer interpreter=new RemoteInterpreterServer(3678); +// Here, 3678 is the port on which interpreter will listen. +interpreter.start() +</code></pre></div> +<p>The above code will start interpreter thread inside your process. Once the interpreter is started you can configure zeppelin to connect to RemoteInterpreter by checking <strong>Connect to existing process</strong> checkbox and then provide <strong>Host</strong> and <strong>Port</strong> on which interpreter process is listening as shown in the image below:</p> + +<p><img src="../assets/themes/zeppelin/img/screenshots/existing_interpreter.png" width="450px"></p> + + </div> +</div> + + + <hr> + <footer> + <!-- <p>© 2017 The Apache Software Foundation</p>--> + </footer> + </div> + + + + + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-45176241-5', 'zeppelin.apache.org'); + ga('require', 'linkid', 'linkid.js'); + ga('send', 'pageview'); + +</script> + + + + </body> +</html> +
