blob: 345bcd4ea73a61c2c82455f54408308c7b147e0b [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Apache Zeppelin 0.9.0 Documentation: Livy Interpreter for Apache Zeppelin</title>
<meta name="description" content="Livy is an open source REST interface for interacting with Spark from anywhere. It supports executing snippets of code or programs in a Spark context that runs locally or in YARN.">
<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.9.0/assets/themes/zeppelin/font-awesome.min.css" rel="stylesheet">
<!-- Le styles -->
<link href="/docs/0.9.0/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="/docs/0.9.0/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
<link href="/docs/0.9.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.9.0/assets/themes/zeppelin/jquery-1.10.2.min.js"></script>
<script src="/docs/0.9.0/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
<script src="/docs/0.9.0/assets/themes/zeppelin/js/docs.js"></script>
<script src="/docs/0.9.0/assets/themes/zeppelin/js/anchor.min.js"></script>
<script src="/docs/0.9.0/assets/themes/zeppelin/js/toc.js"></script>
<script src="/docs/0.9.0/assets/themes/zeppelin/js/lunr.min.js"></script>
<script src="/docs/0.9.0/assets/themes/zeppelin/js/search.js"></script>
<!-- atom & rss feed -->
<link href="/docs/0.9.0/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
<link href="/docs/0.9.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.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body>
<div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container navbar-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="/docs/0.9.0/assets/themes/zeppelin/img/zeppelin_logo.png" width="50"
style="margin-top: -2px;" alt="I'm zeppelin">
<span style="margin-left: 5px; font-size: 27px;">Zeppelin</span>
<a class="navbar-brand-version" href="/docs/0.9.0"
style="font-size: 15px; color: white;"> 0.9.0
</a>
</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 class="title"><span>Getting Started</span></li>
<li><a href="/docs/0.9.0/quickstart/install.html">Install</a></li>
<li><a href="/docs/0.9.0/quickstart/explore_ui.html">Explore UI</a></li>
<li><a href="/docs/0.9.0/quickstart/tutorial.html">Tutorial</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Run Mode</span></li>
<li><a href="/docs/0.9.0/quickstart/kubernetes.html">Kubernetes</a></li>
<li><a href="/docs/0.9.0/quickstart/docker.html">Docker</a></li>
<li><a href="/docs/0.9.0/quickstart/yarn.html">Yarn</a></li>
<li role="separator" class="divider"></li>
<li><a href="/docs/0.9.0/quickstart/spark_with_zeppelin.html">Spark with Zeppelin</a></li>
<li><a href="/docs/0.9.0/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
<li><a href="/docs/0.9.0/quickstart/python_with_zeppelin.html">Python with Zeppelin</a></li>
</ul>
</li>
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Usage<b class="caret"></b></a>
<ul class="dropdown-menu scrollable-menu">
<li class="title"><span>Dynamic Form</span></li>
<li><a href="/docs/0.9.0/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Display System</span></li>
<li><a href="/docs/0.9.0/usage/display_system/basic.html#text">Text Display</a></li>
<li><a href="/docs/0.9.0/usage/display_system/basic.html#html">HTML Display</a></li>
<li><a href="/docs/0.9.0/usage/display_system/basic.html#table">Table Display</a></li>
<li><a href="/docs/0.9.0/usage/display_system/basic.html#network">Network Display</a></li>
<li><a href="/docs/0.9.0/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li>
<li><a href="/docs/0.9.0/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Interpreter</span></li>
<li><a href="/docs/0.9.0/usage/interpreter/overview.html">Overview</a></li>
<li><a href="/docs/0.9.0/usage/interpreter/interpreter_binding_mode.html">Interpreter Binding Mode</a></li>
<li><a href="/docs/0.9.0/usage/interpreter/user_impersonation.html">User Impersonation</a></li>
<li><a href="/docs/0.9.0/usage/interpreter/dependency_management.html">Dependency Management</a></li>
<li><a href="/docs/0.9.0/usage/interpreter/installation.html">Installing Interpreters</a></li>
<!--<li><a href="/docs/0.9.0/usage/interpreter/dynamic_loading.html">Dynamic Interpreter Loading (Experimental)</a></li>-->
<li><a href="/docs/0.9.0/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Other Features</span></li>
<li><a href="/docs/0.9.0/usage/other_features/publishing_paragraphs.html">Publishing Paragraphs</a></li>
<li><a href="/docs/0.9.0/usage/other_features/personalized_mode.html">Personalized Mode</a></li>
<li><a href="/docs/0.9.0/usage/other_features/customizing_homepage.html">Customizing Zeppelin Homepage</a></li>
<li><a href="/docs/0.9.0/usage/other_features/notebook_actions.html">Notebook Actions</a></li>
<li><a href="/docs/0.9.0/usage/other_features/cron_scheduler.html">Cron Scheduler</a></li>
<li><a href="/docs/0.9.0/usage/other_features/zeppelin_context.html">Zeppelin Context</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>REST API</span></li>
<li><a href="/docs/0.9.0/usage/rest_api/interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/notebook.html">Notebook API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/configuration.html">Configuration API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/credential.html">Credential API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/helium.html">Helium API</a></li>
<li class="title"><span>Zeppelin SDK</span></li>
<li><a href="/docs/0.9.0/usage/zeppelin_sdk/client_api.html">Client API</a></li>
<li><a href="/docs/0.9.0/usage/zeppelin_sdk/session_api.html">Session API</a></li>
</ul>
</li>
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b class="caret"></b></a>
<ul class="dropdown-menu scrollable-menu">
<li class="title"><span>Basics</span></li>
<li><a href="/docs/0.9.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
<li><a href="/docs/0.9.0/setup/basics/hadoop_integration.html">Hadoop Integration</a></li>
<li><a href="/docs/0.9.0/setup/basics/multi_user_support.html">Multi-user Support</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Deployment</span></li>
<!--<li><a href="/docs/0.9.0/setup/deployment/docker.html">Docker Image for Zeppelin</a></li>-->
<li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark Cluster Mode: Standalone</a></li>
<li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark Cluster Mode: YARN</a></li>
<li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark Cluster Mode: Mesos</a></li>
<li><a href="/docs/0.9.0/setup/deployment/flink_and_spark_cluster.html">Zeppelin with Flink, Spark Cluster</a></li>
<li><a href="/docs/0.9.0/setup/deployment/cdh.html">Zeppelin on CDH</a></li>
<li><a href="/docs/0.9.0/setup/deployment/virtual_machine.html">Zeppelin on VM: Vagrant</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Security</span></li>
<li><a href="/docs/0.9.0/setup/security/authentication_nginx.html">HTTP Basic Auth using NGINX</a></li>
<li><a href="/docs/0.9.0/setup/security/shiro_authentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.9.0/setup/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.9.0/setup/security/datasource_authorization.html">Data Source Authorization</a></li>
<li><a href="/docs/0.9.0/setup/security/http_security_headers.html">HTTP Security Headers</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Notebook Storage</span></li>
<li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
<li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-oss">OSS Storage</a></li>
<li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
<li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Operation</span></li>
<li><a href="/docs/0.9.0/setup/operation/configuration.html">Configuration</a></li>
<li><a href="/docs/0.9.0/setup/operation/proxy_setting.html">Proxy Setting</a></li>
<li><a href="/docs/0.9.0/setup/operation/upgrading.html">Upgrading</a></li>
<li><a href="/docs/0.9.0/setup/operation/trouble_shooting.html">Trouble Shooting</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 class="title"><span>Interpreters</span></li>
<li><a href="/docs/0.9.0/usage/interpreter/overview.html">Overview</a></li>
<li role="separator" class="divider"></li>
<li><a href="/docs/0.9.0/interpreter/spark.html">Spark</a></li>
<li><a href="/docs/0.9.0/interpreter/jdbc.html">JDBC</a></li>
<li><a href="/docs/0.9.0/interpreter/python.html">Python</a></li>
<li><a href="/docs/0.9.0/interpreter/r.html">R</a></li>
<li role="separator" class="divider"></li>
<li><a href="/docs/0.9.0/interpreter/alluxio.html">Alluxio</a></li>
<li><a href="/docs/0.9.0/interpreter/beam.html">Beam</a></li>
<li><a href="/docs/0.9.0/interpreter/bigquery.html">BigQuery</a></li>
<li><a href="/docs/0.9.0/interpreter/cassandra.html">Cassandra</a></li>
<li><a href="/docs/0.9.0/interpreter/elasticsearch.html">Elasticsearch</a></li>
<li><a href="/docs/0.9.0/interpreter/flink.html">Flink</a></li>
<li><a href="/docs/0.9.0/interpreter/geode.html">Geode</a></li>
<li><a href="/docs/0.9.0/interpreter/groovy.html">Groovy</a></li>
<li><a href="/docs/0.9.0/interpreter/hazelcastjet.html">Hazelcast Jet</a></li>
<li><a href="/docs/0.9.0/interpreter/hbase.html">HBase</a></li>
<li><a href="/docs/0.9.0/interpreter/hdfs.html">HDFS</a></li>
<li><a href="/docs/0.9.0/interpreter/hive.html">Hive</a></li>
<li><a href="/docs/0.9.0/interpreter/ignite.html">Ignite</a></li>
<li><a href="/docs/0.9.0/interpreter/influxdb.html">influxDB</a></li>
<li><a href="/docs/0.9.0/interpreter/java.html">Java</a></li>
<li><a href="/docs/0.9.0/interpreter/jupyter.html">Jupyter</a></li>
<li><a href="/docs/0.9.0/interpreter/kotlin.html">Kotlin</a></li>
<li><a href="/docs/0.9.0/interpreter/ksql.html">KSQL</a></li>
<li><a href="/docs/0.9.0/interpreter/kylin.html">Kylin</a></li>
<li><a href="/docs/0.9.0/interpreter/lens.html">Lens</a></li>
<li><a href="/docs/0.9.0/interpreter/livy.html">Livy</a></li>
<li><a href="/docs/0.9.0/interpreter/mahout.html">Mahout</a></li>
<li><a href="/docs/0.9.0/interpreter/markdown.html">Markdown</a></li>
<li><a href="/docs/0.9.0/interpreter/mongodb.html">MongoDB</a></li>
<li><a href="/docs/0.9.0/interpreter/neo4j.html">Neo4j</a></li>
<li><a href="/docs/0.9.0/interpreter/pig.html">Pig</a></li>
<li><a href="/docs/0.9.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
<li><a href="/docs/0.9.0/interpreter/sap.html">SAP</a></li>
<li><a href="/docs/0.9.0/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.9.0/interpreter/scio.html">Scio</a></li>
<li><a href="/docs/0.9.0/interpreter/shell.html">Shell</a></li>
<li><a href="/docs/0.9.0/interpreter/sparql.html">Sparql</a></li>
<li><a href="/docs/0.9.0/interpreter/submarine.html">Submarine</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>Extending Zeppelin</span></li>
<li><a href="/docs/0.9.0/development/writing_zeppelin_interpreter.html">Writing Zeppelin Interpreter</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Helium (Experimental)</span></li>
<li><a href="/docs/0.9.0/development/helium/overview.html">Overview</a></li>
<li><a href="/docs/0.9.0/development/helium/writing_application.html">Writing Helium Application</a></li>
<li><a href="/docs/0.9.0/development/helium/writing_spell.html">Writing Helium Spell</a></li>
<li><a href="/docs/0.9.0/development/helium/writing_visualization_basic.html">Writing Helium Visualization: Basics</a></li>
<li><a href="/docs/0.9.0/development/helium/writing_visualization_transformation.html">Writing Helium Visualization: Transformation</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Contributing to Zeppelin</span></li>
<li><a href="/docs/0.9.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
<li><a href="/docs/0.9.0/development/contribution/useful_developer_tools.html">Useful Developer Tools</a></li>
<li><a href="/docs/0.9.0/development/contribution/how_to_contribute_code.html">How to Contribute (code)</a></li>
<li><a href="/docs/0.9.0/development/contribution/how_to_contribute_website.html">How to Contribute (website)</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>External Resources</span></li>
<li><a target="_blank" href="https://zeppelin.apache.org/community.html">Mailing List</a></li>
<li><a target="_blank" href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home">Apache Zeppelin Wiki</a></li>
<li><a target="_blank" href="http://stackoverflow.com/questions/tagged/apache-zeppelin">Stackoverflow Questions about Zeppelin</a></li>
</ul>
</li>
<li>
<a href="/docs/0.9.0/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 Livy Interpreter for 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>Livy Interpreter for Apache Zeppelin</h1>
<div id="toc"></div>
<h2>Overview</h2>
<p><a href="http://livy.io/">Livy</a> is an open source REST interface for interacting with Spark from anywhere. It supports executing snippets of code or programs in a Spark context that runs locally or in YARN.</p>
<ul>
<li>Interactive Scala, Python and R shells</li>
<li>Batch submissions in Scala, Java, Python</li>
<li>Multi users can share the same server (impersonation support)</li>
<li>Can be used for submitting jobs from anywhere with REST</li>
<li>Does not require any code change to your programs</li>
</ul>
<h3>Requirements</h3>
<p>Additional requirements for the Livy interpreter are:</p>
<ul>
<li>Spark 1.3 or above.</li>
<li>Livy server.</li>
</ul>
<h2>Configuration</h2>
<p>We added some common configurations for spark, and you can set any configuration you want.
You can find all Spark configurations in <a href="http://spark.apache.org/docs/latest/configuration.html#available-properties">here</a>.
And instead of starting property with <code>spark.</code> it should be replaced with <code>livy.spark.</code>.
Example: <code>spark.driver.memory</code> to <code>livy.spark.driver.memory</code></p>
<table class="table-configuration">
<tr>
<th>Property</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>zeppelin.livy.url</td>
<td>http://localhost:8998</td>
<td>URL where livy server is running</td>
</tr>
<tr>
<td>zeppelin.livy.spark.sql.maxResult</td>
<td>1000</td>
<td>Max number of Spark SQL result to display.</td>
</tr>
<tr>
<td>zeppelin.livy.spark.sql.field.truncate</td>
<td>true</td>
<td>Whether to truncate field values longer than 20 characters or not</td>
</tr>
<tr>
<td>zeppelin.livy.session.create_timeout</td>
<td>120</td>
<td>Timeout in seconds for session creation</td>
</tr>
<tr>
<td>zeppelin.livy.displayAppInfo</td>
<td>true</td>
<td>Whether to display app info</td>
</tr>
<tr>
<td>zeppelin.livy.pull_status.interval.millis</td>
<td>1000</td>
<td>The interval for checking paragraph execution status</td>
</tr>
<tr>
<td>livy.spark.driver.cores</td>
<td></td>
<td>Driver cores. ex) 1, 2.</td>
</tr>
<tr>
<td>livy.spark.driver.memory</td>
<td></td>
<td>Driver memory. ex) 512m, 32g.</td>
</tr>
<tr>
<td>livy.spark.executor.instances</td>
<td></td>
<td>Executor instances. ex) 1, 4.</td>
</tr>
<tr>
<td>livy.spark.executor.cores</td>
<td></td>
<td>Num cores per executor. ex) 1, 4.</td>
</tr>
<tr>
<td>livy.spark.executor.memory</td>
<td></td>
<td>Executor memory per worker instance. ex) 512m, 32g.</td>
</tr>
<tr>
<td>livy.spark.dynamicAllocation.enabled</td>
<td></td>
<td>Use dynamic resource allocation. ex) True, False.</td>
</tr>
<tr>
<td>livy.spark.dynamicAllocation.cachedExecutorIdleTimeout</td>
<td></td>
<td>Remove an executor which has cached data blocks.</td>
</tr>
<tr>
<td>livy.spark.dynamicAllocation.minExecutors</td>
<td></td>
<td>Lower bound for the number of executors.</td>
</tr>
<tr>
<td>livy.spark.dynamicAllocation.initialExecutors</td>
<td></td>
<td>Initial number of executors to run.</td>
</tr>
<tr>
<td>livy.spark.dynamicAllocation.maxExecutors</td>
<td></td>
<td>Upper bound for the number of executors.</td>
</tr>
<tr>
<td>livy.spark.jars.packages</td>
<td></td>
<td>Adding extra libraries to livy interpreter</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.trustStore</td>
<td></td>
<td>client trustStore file. Used when livy ssl is enabled</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.trustStorePassword</td>
<td></td>
<td>password for trustStore file. Used when livy ssl is enabled</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.trustStoreType</td>
<td>JKS</td>
<td>type of truststore. Either JKS or PKCS12.</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.keyStore</td>
<td></td>
<td>client keyStore file. Needed if Livy requires two way SSL authentication.</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.keyStorePassword</td>
<td></td>
<td>password for keyStore file.</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.keyStoreType</td>
<td>JKS</td>
<td>type of keystore. Either JKS or PKCS12.</td>
</tr>
<tr>
<td>zeppelin.livy.ssl.keyPassword</td>
<td></td>
<td>password for key in the keyStore file. Defaults to zeppelin.livy.ssl.keyStorePassword.</td>
</tr>
<tr>
<td>zeppelin.livy.http.headers</td>
<td>key_1: value_1; key_2: value_2</td>
<td>custom http headers when calling livy rest api. Each http header is separated by `;`, and each header is one key value pair where key value is separated by `:`</td>
</tr>
</table>
<p><strong>We remove livy.spark.master in zeppelin-0.7. Because we sugguest user to use livy 0.3 in zeppelin-0.7. And livy 0.3 don&#39;t allow to specify livy.spark.master, it enfornce yarn-cluster mode.</strong></p>
<h2>Adding External libraries</h2>
<p>You can load dynamic library to livy interpreter by set <code>livy.spark.jars.packages</code> property to comma-separated list of maven coordinates of jars to include on the driver and executor classpaths. The format for the coordinates should be groupId:artifactId:version.</p>
<p>Example</p>
<table class="table-configuration">
<tr>
<th>Property</th>
<th>Example</th>
<th>Description</th>
</tr>
<tr>
<td>livy.spark.jars.packages</td>
<td>io.spray:spray-json_2.10:1.3.1</td>
<td>Adding extra libraries to livy interpreter</td>
</tr>
</table>
<h2>How to use</h2>
<p>Basically, you can use</p>
<p><strong>spark</strong></p>
<div class="highlight"><pre><code class="scala language-scala" data-lang="scala"><span class="o">%</span><span class="n">livy</span><span class="o">.</span><span class="n">spark</span>
<span class="n">sc</span><span class="o">.</span><span class="n">version</span>
</code></pre></div>
<p><strong>pyspark</strong></p>
<div class="highlight"><pre><code class="python language-python" data-lang="python"><span class="o">%</span><span class="n">livy</span><span class="o">.</span><span class="n">pyspark</span>
<span class="k">print</span> <span class="s">&quot;1&quot;</span>
</code></pre></div>
<p><strong>sparkR</strong></p>
<div class="highlight"><pre><code class="r language-r" data-lang="r"><span class="o">%livy.sparkr</span>
<span class="o">hello &lt;- function( name ) {</span>
<span class="o"> sprintf( &quot;Hello, %</span>s<span class="s">&quot;, name );</span>
<span class="s">}</span>
<span class="s">hello(&quot;</span>livy<span class="s">&quot;</span><span class="err">)</span>
</code></pre></div>
<h2>Impersonation</h2>
<p>When Zeppelin server is running with authentication enabled,
then this interpreter utilizes Livy’s user impersonation feature
i.e. sends extra parameter for creating and running a session (&quot;proxyUser&quot;: &quot;${loggedInUser}&quot;).
This is particularly useful when multi users are sharing a Notebook server.</p>
<h2>Apply Zeppelin Dynamic Forms</h2>
<p>You can leverage <a href="../usage/dynamic_form/intro.html">Zeppelin Dynamic Form</a>. Form templates is only avalible for livy sql interpreter.</p>
<div class="highlight"><pre><code class="sql language-sql" data-lang="sql"><span class="o">%</span><span class="n">livy</span><span class="p">.</span><span class="k">sql</span>
<span class="k">select</span> <span class="o">*</span> <span class="k">from</span> <span class="n">products</span> <span class="k">where</span> <span class="err">${</span><span class="n">product_id</span><span class="o">=</span><span class="mi">1</span><span class="err">}</span>
</code></pre></div>
<p>And creating dynamic formst programmatically is not feasible in livy interpreter, because ZeppelinContext is not available in livy interpreter.</p>
<h2>Shared SparkContext</h2>
<p>Starting from livy 0.5 which is supported by Zeppelin 0.8.0, SparkContext is shared between scala, python, r and sql.
That means you can query the table via <code>%livy.sql</code> when this table is registered in <code>%livy.spark</code>, <code>%livy.pyspark</code>, <code>$livy.sparkr</code>.</p>
<h2>FAQ</h2>
<p>Livy debugging: If you see any of these in error console</p>
<blockquote>
<p>Connect to livyhost:8998 [livyhost/127.0.0.1, livyhost/0:0:0:0:0:0:0:1] failed: Connection refused</p>
</blockquote>
<p>Looks like the livy server is not up yet or the config is wrong</p>
<blockquote>
<p>Exception: Session not found, Livy server would have restarted, or lost session.</p>
</blockquote>
<p>The session would have timed out, you may need to restart the interpreter.</p>
<blockquote>
<p>Blacklisted configuration values in session config: spark.master</p>
</blockquote>
<p>Edit <code>conf/spark-blacklist.conf</code> file in livy server and comment out <code>#spark.master</code> line.</p>
<p>If you choose to work on livy in <code>apps/spark/java</code> directory in <a href="https://github.com/cloudera/hue">https://github.com/cloudera/hue</a>,
copy <code>spark-user-configurable-options.template</code> to <code>spark-user-configurable-options.conf</code> file in livy server and comment out <code>#spark.master</code>.</p>
</div>
</div>
<hr>
<footer>
<!-- <p>&copy; 2021 The Apache Software Foundation</p>-->
</footer>
</div>
</body>
</html>