blob: 9bbfc4a98657e3108ed9d404301470777fd38660 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Interpreter Installation</title>
<meta name="description" content="">
<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="/docs/0.6.0/assets/themes/zeppelin/font-awesome.min.css" rel="stylesheet">
<!-- Le styles -->
<link href="/docs/0.6.0/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="/docs/0.6.0/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
<link href="/docs/0.6.0/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="/docs/0.6.0/assets/themes/zeppelin/jquery-1.10.2.min.js"></script>
<script src="/docs/0.6.0/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
<script src="/docs/0.6.0/assets/themes/zeppelin/js/docs.js"></script>
<script src="/docs/0.6.0/assets/themes/zeppelin/js/anchor.min.js"></script>
<script src="/docs/0.6.0/assets/themes/zeppelin/js/toc.js"></script>
<!-- atom & rss feed -->
<link href="/docs/0.6.0/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
<link href="/docs/0.6.0/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push["setDoNotTrack", true];
_paq.push["disableCookies"];
_paq.push['trackPageView'];
_paq.push['enableLinkTracking'];
function {
var u="https://analytics.apache.org/";
_paq.push['setTrackerUrl', u+'matomo.php'];
_paq.push['setSiteId', '69'];
var d=document, g=d.createElement'script', s=d.getElementsByTagName'script'[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBeforeg,s;
};
</script>
<!-- End Matomo Code -->
</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>
<a class="navbar-brand" href="/docs/0.6.0">
<img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
<span style="vertical-align:middle">Zeppelin</span>
<span style="vertical-align:baseline"><small>0.6.0</small></span>
</a>
</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.6.0/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.6.0/install/install.html">Install</a></li>
<li><a href="/docs/0.6.0/install/install.html#apache-zeppelin-configuration">Configuration</a></li>
<li><a href="/docs/0.6.0/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
<li><a href="/docs/0.6.0/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.6.0/manual/dynamicform.html">Dynamic Form</a></li>
<li><a href="/docs/0.6.0/manual/publish.html">Publish your Paragraph</a></li>
<li><a href="/docs/0.6.0/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.6.0/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
<li><a href="/docs/0.6.0/install/upgrade.html">Upgrade Zeppelin Version</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.6.0/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.6.0/manual/interpreterinstallation.html">Interpreter Installation</a></li>
<!--<li><a href="/docs/0.6.0/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
<li><a href="/docs/0.6.0/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>Available Interpreters</b><span></li>
<li><a href="/docs/0.6.0/interpreter/alluxio.html">Alluxio</a></li>
<li><a href="/docs/0.6.0/interpreter/cassandra.html">Cassandra</a></li>
<li><a href="/docs/0.6.0/interpreter/elasticsearch.html">Elasticsearch</a></li>
<li><a href="/docs/0.6.0/interpreter/flink.html">Flink</a></li>
<li><a href="/docs/0.6.0/interpreter/geode.html">Geode</a></li>
<li><a href="/docs/0.6.0/interpreter/hbase.html">HBase</a></li>
<li><a href="/docs/0.6.0/interpreter/hdfs.html">HDFS</a></li>
<li><a href="/docs/0.6.0/interpreter/hive.html">Hive</a></li>
<li><a href="/docs/0.6.0/interpreter/ignite.html">Ignite</a></li>
<li><a href="/docs/0.6.0/interpreter/jdbc.html">JDBC</a></li>
<li><a href="/docs/0.6.0/interpreter/lens.html">Lens</a></li>
<li><a href="/docs/0.6.0/interpreter/livy.html">Livy</a></li>
<li><a href="/docs/0.6.0/interpreter/markdown.html">Markdown</a></li>
<li><a href="/docs/0.6.0/interpreter/python.html">Python</a></li>
<li><a href="/docs/0.6.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
<li><a href="/docs/0.6.0/interpreter/r.html">R</a></li>
<li><a href="/docs/0.6.0/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0/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.6.0/displaysystem/basicdisplaysystem.html#text">Text</a></li>
<li><a href="/docs/0.6.0/displaysystem/basicdisplaysystem.html#html">Html</a></li>
<li><a href="/docs/0.6.0/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.6.0/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
<li><a href="/docs/0.6.0/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.6.0/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
<li><a href="/docs/0.6.0/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.6.0/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.6.0/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.6.0/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0/rest-api/rest-notebook.html">Notebook API</a></li>
<li><a href="/docs/0.6.0/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>Security</b><span></li>
<li><a href="/docs/0.6.0/security/authentication.html">Authentication for NGINX</a></li>
<li><a href="/docs/0.6.0/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.6.0/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.6.0/security/interpreter_authorization.html">Interpreter & Data Resource Authorization</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>Contibute</b><span></li>
<li><a href="/docs/0.6.0/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
<li><a href="/docs/0.6.0/development/howtocontribute.html">How to contribute (code)</a></li>
<li><a href="/docs/0.6.0/development/howtocontributewebsite.html">How to contribute (website)</a></li>
</ul>
</li>
</ul>
</nav><!--/.navbar-collapse -->
</div>
</div>
<div class="content">
<!--<div class="hero-unit Interpreter Installation">
<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>
<p>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&#39;s transitive dependencies into <code>interpreter/interpreter1</code> directory.</p>
<p>Once you have installed interpreters, you&#39;ll need to add interpreter class name into <code>zeppelin.interpreters</code> property in <a href="../install/install.html#apache-zeppelin-configuration">configuration</a>.
And then restart Zeppelin, <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.6.0</td>
<td>Alluxio interpreter</td>
</tr>
<tr>
<td>angular</td>
<td>org.apache.zeppelin:zeppelin-angular:0.6.0</td>
<td>HTML and AngularJS view rendering</td>
</tr>
<tr>
<td>cassandra</td>
<td>org.apache.zeppelin:zeppelin-cassandra:0.6.0</td>
<td>Cassandra interpreter</td>
</tr>
<tr>
<td>elasticsearch</td>
<td>org.apache.zeppelin:zeppelin-elasticsearch:0.6.0</td>
<td>Elasticsearch interpreter</td>
</tr>
<tr>
<td>file</td>
<td>org.apache.zeppelin:zeppelin-file:0.6.0</td>
<td>HDFS file interpreter</td>
</tr>
<tr>
<td>flink</td>
<td>org.apache.zeppelin:zeppelin-flink:0.6.0</td>
<td>Flink interpreter</td>
</tr>
<tr>
<td>hbase</td>
<td>org.apache.zeppelin:zeppelin-hbase:0.6.0</td>
<td>Hbase interpreter</td>
</tr>
<tr>
<td>ignite</td>
<td>org.apache.zeppelin:zeppelin-ignite:0.6.0</td>
<td>Ignite interpreter</td>
</tr>
<tr>
<td>jdbc</td>
<td>org.apache.zeppelin:zeppelin-jdbc:0.6.0</td>
<td>Jdbc interpreter</td>
</tr>
<tr>
<td>kylin</td>
<td>org.apache.zeppelin:zeppelin-kylin:0.6.0</td>
<td>Kylin interpreter</td>
</tr>
<tr>
<td>lens</td>
<td>org.apache.zeppelin:zeppelin-lens:0.6.0</td>
<td>Lens interpreter</td>
</tr>
<tr>
<td>livy</td>
<td>org.apache.zeppelin:zeppelin-livy:0.6.0</td>
<td>Livy interpreter</td>
</tr>
<tr>
<td>md</td>
<td>org.apache.zeppelin:zeppelin-markdown:0.6.0</td>
<td>Markdown support</td>
</tr>
<tr>
<td>postgresql</td>
<td>org.apache.zeppelin:zeppelin-postgresql:0.6.0</td>
<td>Postgresql interpreter</td>
</tr>
<tr>
<td>python</td>
<td>org.apache.zeppelin:zeppelin-python:0.6.0</td>
<td>Python interpreter</td>
</tr>
<tr>
<td>shell</td>
<td>org.apache.zeppelin:zeppelin-shell:0.6.0</td>
<td>Shell command</td>
</tr>
</table></p>
</div>
</div>
<hr>
<footer>
<!-- <p>&copy; 2016 The Apache Software Foundation</p>-->
</footer>
</div>
</body>
</html>