You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mi...@apache.org on 2017/09/21 20:34:02 UTC
svn commit: r1809223 [29/30] - in /zeppelin/site: ./ contribution/
contribution/zeppelinweb/ docs/0.7.3/ docs/0.7.3/assets/
docs/0.7.3/assets/themes/ docs/0.7.3/assets/themes/zeppelin/
docs/0.7.3/assets/themes/zeppelin/bootstrap/ docs/0.7.3/assets/them...
Added: zeppelin/site/docs/0.7.3/security/notebook_authorization.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/security/notebook_authorization.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/security/notebook_authorization.html (added)
+++ zeppelin/site/docs/0.7.3/security/notebook_authorization.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,307 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Notebook Authorization in Apache Zeppelin</title>
+ <meta name="description" content="This page will guide you how you can set the permission for Zeppelin notebooks. This document assumes that Apache Shiro authentication was set up.">
+ <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 Notebook Authorization 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>Zeppelin Notebook Authorization</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>We assume that there is an <strong>Shiro Authentication</strong> component that associates a user string and a set of group strings with every NotebookSocket.
+If you don't set the authentication components yet, please check <a href="./shiroauthentication.html">Shiro authentication for Apache Zeppelin</a> first.</p>
+
+<h2>Authorization Setting</h2>
+
+<p>You can set Zeppelin notebook permissions in each notebooks. Of course only <strong>notebook owners</strong> can change this configuration.
+Just click <strong>Lock icon</strong> and open the permission setting page in your notebook.</p>
+
+<p>As you can see, each Zeppelin notebooks has 3 entities :</p>
+
+<ul>
+<li>Owners ( users or groups )</li>
+<li>Readers ( users or groups )</li>
+<li>Writers ( users or groups )</li>
+</ul>
+
+<p><center><img src="../assets/themes/zeppelin/img/docs-img/permission_setting.png"></center></p>
+
+<p>Fill out the each forms with comma seperated <strong>users</strong> and <strong>groups</strong> configured in <code>conf/shiro.ini</code> file.
+If the form is empty (*), it means that any users can perform that operation.</p>
+
+<p>If someone who doesn't have <strong>read</strong> permission is trying to access the notebook or someone who doesn't have <strong>write</strong> permission is trying to edit the notebook, Zeppelin will ask to login or block the user.</p>
+
+<p><center><img src="../assets/themes/zeppelin/img/docs-img/insufficient_privileges.png"></center></p>
+
+<h2>Separate notebook workspaces (public vs. private)</h2>
+
+<p>By default, the authorization rights allow other users to see the newly created note, meaning the workspace is <code>public</code>. This behavior is controllable and can be set through either <code>ZEPPELIN_NOTEBOOK_PUBLIC</code> variable in <code>conf/zeppelin-env.sh</code>, or through <code>zeppelin.notebook.public</code> property in <code>conf/zeppelin-site.xml</code>. Thus, in order to make newly created note appear only in your <code>private</code> workspace by default, you can set either <code>ZEPPELIN_NOTEBOOK_PUBLIC</code> to <code>false</code> in your <code>conf/zeppelin-env.sh</code> as follows:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELIN_NOTEBOOK_PUBLIC="false"
+</code></pre></div>
+<p>or set <code>zeppelin.notebook.public</code> property to <code>false</code> in <code>conf/zeppelin-site.xml</code> as follows:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.public</name>
+ <value>false</value>
+ <description>Make notebook public by default when created, private otherwise</description>
+</property>
+</code></pre></div>
+<p>Behind the scenes, when you create a new note only the <code>owners</code> field is filled with current user, leaving <code>readers</code> and <code>writers</code> fields empty. All the notes with at least one empty authorization field are considered to be in <code>public</code> workspace. Thus when setting <code>zeppelin.notebook.public</code> (or corresponding <code>ZEPPELIN_NOTEBOOK_PUBLIC</code>) to false, newly created notes have <code>readers</code> and <code>writers</code> fields filled with current user, making note appear as in <code>private</code> workspace.</p>
+
+<h2>How it works</h2>
+
+<p>In this section, we will explain the detail about how the notebook authorization works in backend side.</p>
+
+<h3>NotebookServer</h3>
+
+<p>The <a href="https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/socket/NotebookServer.java">NotebookServer</a> classifies every notebook operations into three categories: <strong>Read</strong>, <strong>Write</strong>, <strong>Manage</strong>.
+Before executing a notebook operation, it checks if the user and the groups associated with the <code>NotebookSocket</code> have permissions.
+For example, before executing a <strong>Read</strong> operation, it checks if the user and the groups have at least one entity that belongs to the <strong>Reader</strong> entities.</p>
+
+<h3>Notebook REST API call</h3>
+
+<p>Zeppelin executes a <a href="https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/rest/NotebookRestApi.java">REST API call</a> for the notebook permission information.
+In the backend side, Zeppelin gets the user information for the connection and allows the operation if the users and groups
+associated with the current user have at least one entity that belongs to owner entities for the notebook.</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/security/shiroauthentication.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/security/shiroauthentication.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/security/shiroauthentication.html (added)
+++ zeppelin/site/docs/0.7.3/security/shiroauthentication.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,474 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Apache Shiro Authentication for Apache Zeppelin</title>
+ <meta name="description" content="Apache Shiro is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. This document explains step by step how Shiro can be used for Zeppelin notebook authentication.">
+ <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 Apache Shiro Authentication 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>Apache Shiro authentication for Apache Zeppelin</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p><a href="http://shiro.apache.org/">Apache Shiro</a> is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. In this documentation, we will explain step by step how Shiro works for Zeppelin notebook authentication.</p>
+
+<p>When you connect to Apache Zeppelin, you will be asked to enter your credentials. Once you logged in, then you have access to all notes including other user's notes.</p>
+
+<h2>Security Setup</h2>
+
+<p>You can setup <strong>Zeppelin notebook authentication</strong> in some simple steps.</p>
+
+<h3>1. Enable Shiro</h3>
+
+<p>By default in <code>conf</code>, you will find <code>shiro.ini.template</code>, this file is used as an example and it is strongly recommended
+to create a <code>shiro.ini</code> file by doing the following command line</p>
+<div class="highlight"><pre><code class="bash language-bash" data-lang="bash">cp conf/shiro.ini.template conf/shiro.ini
+</code></pre></div>
+<p>For the further information about <code>shiro.ini</code> file format, please refer to <a href="http://shiro.apache.org/configuration.html#Configuration-INISections">Shiro Configuration</a>.</p>
+
+<h3>2. Secure the Websocket channel</h3>
+
+<p>Set to property <strong>zeppelin.anonymous.allowed</strong> to <strong>false</strong> in <code>conf/zeppelin-site.xml</code>. If you don't have this file yet, just copy <code>conf/zeppelin-site.xml.template</code> to <code>conf/zeppelin-site.xml</code>.</p>
+
+<h3>3. Start Zeppelin</h3>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">bin/zeppelin-daemon.sh start (or restart)
+</code></pre></div>
+<p>Then you can browse Zeppelin at <a href="http://localhost:8080">http://localhost:8080</a>.</p>
+
+<h3>4. Login</h3>
+
+<p>Finally, you can login using one of the below <strong>username/password</strong> combinations.</p>
+
+<p><center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin-login.png"></center></p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">[users]
+
+admin = password1, admin
+user1 = password2, role1, role2
+user2 = password3, role3
+user3 = password4, role2
+</code></pre></div>
+<p>You can set the roles for each users next to the password.</p>
+
+<h2>Groups and permissions (optional)</h2>
+
+<p>In case you want to leverage user groups and permissions, use one of the following configuration for LDAP or AD under <code>[main]</code> segment in <code>shiro.ini</code>.</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">activeDirectoryRealm = org.apache.zeppelin.realm.ActiveDirectoryGroupRealm
+activeDirectoryRealm.systemUsername = userNameA
+activeDirectoryRealm.systemPassword = passwordA
+activeDirectoryRealm.searchBase = CN=Users,DC=SOME_GROUP,DC=COMPANY,DC=COM
+activeDirectoryRealm.url = ldap://ldap.test.com:389
+activeDirectoryRealm.groupRolesMap = "CN=aGroupName,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM":"group1"
+activeDirectoryRealm.authorizationCachingEnabled = false
+activeDirectoryRealm.principalSuffix = @corp.company.net
+
+ldapRealm = org.apache.zeppelin.server.LdapGroupRealm
+# search base for ldap groups (only relevant for LdapGroupRealm):
+ldapRealm.contextFactory.environment[ldap.searchBase] = dc=COMPANY,dc=COM
+ldapRealm.contextFactory.url = ldap://ldap.test.com:389
+ldapRealm.userDnTemplate = uid={0},ou=Users,dc=COMPANY,dc=COM
+ldapRealm.contextFactory.authenticationMechanism = simple
+</code></pre></div>
+<p>also define roles/groups that you want to have in system, like below;</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">[roles]
+admin = *
+hr = *
+finance = *
+group1 = *
+</code></pre></div>
+<h2>Configure Realm (optional)</h2>
+
+<p>Realms are responsible for authentication and authorization in Apache Zeppelin. By default, Apache Zeppelin uses <a href="https://shiro.apache.org/static/latest/apidocs/org/apache/shiro/realm/text/IniRealm.html">IniRealm</a> (users and groups are configurable in <code>conf/shiro.ini</code> file under <code>[user]</code> and <code>[group]</code> section). You can also leverage Shiro Realms like <a href="https://shiro.apache.org/static/latest/apidocs/org/apache/shiro/realm/ldap/JndiLdapRealm.html">JndiLdapRealm</a>, <a href="https://shiro.apache.org/static/latest/apidocs/org/apache/shiro/realm/jdbc/JdbcRealm.html">JdbcRealm</a> or create <a href="https://shiro.apache.org/static/latest/apidocs/org/apache/shiro/realm/AuthorizingRealm.html">our own</a>.
+To learn more about Apache Shiro Realm, please check <a href="http://shiro.apache.org/realm.html">this documentation</a>.</p>
+
+<p>We also provide community custom Realms.</p>
+
+<h3>Active Directory</h3>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">activeDirectoryRealm = org.apache.zeppelin.realm.ActiveDirectoryGroupRealm
+activeDirectoryRealm.systemUsername = userNameA
+activeDirectoryRealm.systemPassword = passwordA
+activeDirectoryRealm.hadoopSecurityCredentialPath = jceks://file/user/zeppelin/conf/zeppelin.jceks
+activeDirectoryRealm.searchBase = CN=Users,DC=SOME_GROUP,DC=COMPANY,DC=COM
+activeDirectoryRealm.url = ldap://ldap.test.com:389
+activeDirectoryRealm.groupRolesMap = "CN=aGroupName,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM":"group1"
+activeDirectoryRealm.authorizationCachingEnabled = false
+activeDirectoryRealm.principalSuffix = @corp.company.net
+</code></pre></div>
+<p>Also instead of specifying systemPassword in clear text in shiro.ini administrator can choose to specify the same in "hadoop credential".
+Create a keystore file using the hadoop credential commandline, for this the hadoop commons should be in the classpath
+<code>hadoop credential create activeDirectoryRealm.systempassword -provider jceks://file/user/zeppelin/conf/zeppelin.jceks</code></p>
+
+<p>Change the following values in the Shiro.ini file, and uncomment the line:
+<code>activeDirectoryRealm.hadoopSecurityCredentialPath = jceks://file/user/zeppelin/conf/zeppelin.jceks</code></p>
+
+<h3>LDAP</h3>
+
+<p>Two options exist for configuring an LDAP Realm. The simpler to use is the LdapGroupRealm. How ever it has limited
+flexibility with mapping of ldap groups to users and for authorization for user groups. A sample configuration file for
+this realm is given below.</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">ldapRealm = org.apache.zeppelin.realm.LdapGroupRealm
+# search base for ldap groups (only relevant for LdapGroupRealm):
+ldapRealm.contextFactory.environment[ldap.searchBase] = dc=COMPANY,dc=COM
+ldapRealm.contextFactory.url = ldap://ldap.test.com:389
+ldapRealm.userDnTemplate = uid={0},ou=Users,dc=COMPANY,dc=COM
+ldapRealm.contextFactory.authenticationMechanism = simple
+</code></pre></div>
+<p>The other more flexible option is to use the LdapRealm. It allows for mapping of ldapgroups to roles and also allows for
+ role/group based authentication into the zeppelin server. Sample configuration for this realm is given below.
+ ```
+[main]
+ldapRealm=org.apache.zeppelin.realm.LdapRealm</p>
+
+<p>ldapRealm.contextFactory.authenticationMechanism=simple
+ldapRealm.contextFactory.url=ldap://localhost:33389
+ldapRealm.userDnTemplate=uid={0},ou=people,dc=hadoop,dc=apache,dc=org</p>
+
+<h1>Ability to set ldap paging Size if needed default is 100</h1>
+
+<p>ldapRealm.pagingSize = 200
+ldapRealm.authorizationEnabled=true
+ldapRealm.contextFactory.systemAuthenticationMechanism=simple
+ldapRealm.searchBase=dc=hadoop,dc=apache,dc=org
+ldapRealm.userSearchBase = dc=hadoop,dc=apache,dc=org
+ldapRealm.groupSearchBase = ou=groups,dc=hadoop,dc=apache,dc=org
+ldapRealm.groupObjectClass=groupofnames</p>
+
+<h1>Allow userSearchAttribute to be customized</h1>
+
+<p>ldapRealm.userSearchAttributeName = sAMAccountName
+ldapRealm.memberAttribute=member</p>
+
+<h1>force usernames returned from ldap to lowercase useful for AD</h1>
+
+<p>ldapRealm.userLowerCase = true </p>
+
+<h1>ability set searchScopes subtree (default), one, base</h1>
+
+<p>ldapRealm.userSearchScope = subtree;
+ldapRealm.groupSearchScope = subtree;
+ldapRealm.memberAttributeValueTemplate=cn={0},ou=people,dc=hadoop,dc=apache,dc=org
+ldapRealm.contextFactory.systemUsername=uid=guest,ou=people,dc=hadoop,dc=apache,dc=org
+ldapRealm.contextFactory.systemPassword=S{ALIAS=ldcSystemPassword}</p>
+
+<h1>enable support for nested groups using the LDAP<em>MATCHING</em>RULE<em>IN</em>CHAIN operator</h1>
+
+<p>ldapRealm.groupSearchEnableMatchingRuleInChain = true</p>
+
+<h1>optional mapping from physical groups to logical application roles</h1>
+
+<p>ldapRealm.rolesByGroup = LDN<em>USERS: user</em>role, NYK<em>USERS: user</em>role, HKG<em>USERS: user</em>role, GLOBAL<em>ADMIN: admin</em>role</p>
+
+<h1>optional list of roles that are allowed to authenticate. Incase not present all groups are allowed to authenticate (login).</h1>
+
+<h1>This changes nothing for url specific permissions that will continue to work as specified in [urls].</h1>
+
+<p>ldapRealm.allowedRolesForAuthentication = admin<em>role,user</em>role
+ldapRealm.permissionsByRole= user<em>role = <em>:ToDoItemsJdo:</em>:<em>, *:ToDoItem:</em>:*; admin</em>role = *
+securityManager.sessionManager = $sessionManager
+securityManager.realms = $ldapRealm
+ ```</p>
+
+<h3>PAM</h3>
+
+<p><a href="https://en.wikipedia.org/wiki/Pluggable_authentication_module">PAM</a> authentication support allows the reuse of existing authentication
+moduls on the host where Zeppelin is running. On a typical system modules are configured per service for example sshd, passwd, etc. under <code>/etc/pam.d/</code>. You can
+either reuse one of these services or create your own for Zeppelin. Activiting PAM authentication requires two parameters:
+ 1. realm: The Shiro realm being used
+ 2. service: The service configured under <code>/etc/pam.d/</code> to be used. The name here needs to be the same as the file name under <code>/etc/pam.d/</code></p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">[main]
+ pamRealm=org.apache.zeppelin.realm.PamRealm
+ pamRealm.service=sshd
+</code></pre></div>
+<h3>ZeppelinHub</h3>
+
+<p><a href="https://www.zeppelinhub.com">ZeppelinHub</a> is a service that synchronize your Apache Zeppelin notebooks and enables you to collaborate easily.</p>
+
+<p>To enable login with your ZeppelinHub credential, apply the following change in <code>conf/shiro.ini</code> under <code>[main]</code> section.</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">### A sample for configuring ZeppelinHub Realm
+zeppelinHubRealm = org.apache.zeppelin.realm.ZeppelinHubRealm
+## Url of ZeppelinHub
+zeppelinHubRealm.zeppelinhubUrl = https://www.zeppelinhub.com
+securityManager.realms = $zeppelinHubRealm
+</code></pre></div>
+<blockquote>
+<p>Note: ZeppelinHub is not releated to Apache Zeppelin project.</p>
+</blockquote>
+
+<h2>Secure Cookie for Zeppelin Sessions (optional)</h2>
+
+<p>Zeppelin can be configured to set <code>HttpOnly</code> flag in the session cookie. With this configuration, Zeppelin cookies can
+not be accessed via client side scripts thus preventing majority of Cross-site scripting (XSS) attacks.</p>
+
+<p>To enable secure cookie support via Shiro, add the following lines in <code>conf/shiro.ini</code> under <code>[main]</code> section, after
+defining a <code>sessionManager</code>.</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">cookie = org.apache.shiro.web.servlet.SimpleCookie
+cookie.name = JSESSIONID
+cookie.secure = true
+cookie.httpOnly = true
+sessionManager.sessionIdCookie = $cookie
+</code></pre></div>
+<h2>Secure your Zeppelin information (optional)</h2>
+
+<p>By default, anyone who defined in <code>[users]</code> can share <strong>Interpreter Setting</strong>, <strong>Credential</strong> and <strong>Configuration</strong> information in Apache Zeppelin.
+Sometimes you might want to hide these information for your use case.
+Since Shiro provides <strong>url-based security</strong>, you can hide the information by commenting or uncommenting these below lines in <code>conf/shiro.ini</code>.</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">[urls]
+
+/api/interpreter/** = authc, roles[admin]
+/api/configurations/** = authc, roles[admin]
+/api/credential/** = authc, roles[admin]
+</code></pre></div>
+<p>In this case, only who have <code>admin</code> role can see <strong>Interpreter Setting</strong>, <strong>Credential</strong> and <strong>Configuration</strong> information.
+If you want to grant this permission to other users, you can change <strong>roles[ ]</strong> as you defined at <code>[users]</code> section.</p>
+
+<p><br/></p>
+
+<blockquote>
+<p><strong>NOTE :</strong> All of the above configurations are defined in the <code>conf/shiro.ini</code> file.</p>
+</blockquote>
+
+<h2>Other authentication methods</h2>
+
+<ul>
+<li><a href="./authentication.html">HTTP Basic Authentication using NGINX</a></li>
+</ul>
+
+ </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/sitemap.txt
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/sitemap.txt?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/sitemap.txt (added)
+++ zeppelin/site/docs/0.7.3/sitemap.txt Thu Sep 21 20:33:57 2017
@@ -0,0 +1,78 @@
+
+http://zeppelin.apache.org/assets/themes/zeppelin/js/search.js
+http://zeppelin.apache.org/atom.xml
+http://zeppelin.apache.org/development/howtocontribute.html
+http://zeppelin.apache.org/development/howtocontributewebsite.html
+http://zeppelin.apache.org/development/writingzeppelinapplication.html
+http://zeppelin.apache.org/development/writingzeppelininterpreter.html
+http://zeppelin.apache.org/development/writingzeppelinvisualization.html
+http://zeppelin.apache.org/displaysystem/back-end-angular.html
+http://zeppelin.apache.org/displaysystem/basicdisplaysystem.html
+http://zeppelin.apache.org/displaysystem/front-end-angular.html
+http://zeppelin.apache.org/index.html
+http://zeppelin.apache.org/install/build.html
+http://zeppelin.apache.org/install/cdh.html
+http://zeppelin.apache.org/install/configuration.html
+http://zeppelin.apache.org/install/docker.html
+http://zeppelin.apache.org/install/install.html
+http://zeppelin.apache.org/install/spark_cluster_mode.html
+http://zeppelin.apache.org/install/upgrade.html
+http://zeppelin.apache.org/install/virtual_machine.html
+http://zeppelin.apache.org/install/yarn_install.html
+http://zeppelin.apache.org/interpreter/alluxio.html
+http://zeppelin.apache.org/interpreter/beam.html
+http://zeppelin.apache.org/interpreter/bigquery.html
+http://zeppelin.apache.org/interpreter/cassandra.html
+http://zeppelin.apache.org/interpreter/elasticsearch.html
+http://zeppelin.apache.org/interpreter/flink.html
+http://zeppelin.apache.org/interpreter/geode.html
+http://zeppelin.apache.org/interpreter/hbase.html
+http://zeppelin.apache.org/interpreter/hdfs.html
+http://zeppelin.apache.org/interpreter/hive.html
+http://zeppelin.apache.org/interpreter/ignite.html
+http://zeppelin.apache.org/interpreter/jdbc.html
+http://zeppelin.apache.org/interpreter/kylin.html
+http://zeppelin.apache.org/interpreter/lens.html
+http://zeppelin.apache.org/interpreter/livy.html
+http://zeppelin.apache.org/interpreter/mahout.html
+http://zeppelin.apache.org/interpreter/markdown.html
+http://zeppelin.apache.org/interpreter/pig.html
+http://zeppelin.apache.org/interpreter/postgresql.html
+http://zeppelin.apache.org/interpreter/python.html
+http://zeppelin.apache.org/interpreter/r.html
+http://zeppelin.apache.org/interpreter/scalding.html
+http://zeppelin.apache.org/interpreter/scio.html
+http://zeppelin.apache.org/interpreter/shell.html
+http://zeppelin.apache.org/interpreter/spark.html
+http://zeppelin.apache.org/manual/dependencymanagement.html
+http://zeppelin.apache.org/manual/dynamicform.html
+http://zeppelin.apache.org/manual/dynamicinterpreterload.html
+http://zeppelin.apache.org/manual/interpreterexechooks.html
+http://zeppelin.apache.org/manual/interpreterinstallation.html
+http://zeppelin.apache.org/manual/interpreters.html
+http://zeppelin.apache.org/manual/notebookashomepage.html
+http://zeppelin.apache.org/manual/publish.html
+http://zeppelin.apache.org/manual/userimpersonation.html
+http://zeppelin.apache.org/pleasecontribute.html
+http://zeppelin.apache.org/quickstart/explorezeppelinui.html
+http://zeppelin.apache.org/quickstart/install_with_flink_and_spark_cluster.html
+http://zeppelin.apache.org/quickstart/tutorial.html
+http://zeppelin.apache.org/rest-api/rest-configuration.html
+http://zeppelin.apache.org/rest-api/rest-credential.html
+http://zeppelin.apache.org/rest-api/rest-helium.html
+http://zeppelin.apache.org/rest-api/rest-interpreter.html
+http://zeppelin.apache.org/rest-api/rest-notebook.html
+http://zeppelin.apache.org/rest-api/rest-notebookRepo.html
+http://zeppelin.apache.org/rss.xml
+http://zeppelin.apache.org/screenshots.html
+http://zeppelin.apache.org/search.html
+http://zeppelin.apache.org/search_data.json
+http://zeppelin.apache.org/security/authentication.html
+http://zeppelin.apache.org/security/datasource_authorization.html
+http://zeppelin.apache.org/security/helium_authorization.html
+http://zeppelin.apache.org/security/http_security_headers.html
+http://zeppelin.apache.org/security/notebook_authorization.html
+http://zeppelin.apache.org/security/shiroauthentication.html
+http://zeppelin.apache.org/sitemap.txt
+http://zeppelin.apache.org/storage/storage.html
+
Added: zeppelin/site/docs/0.7.3/storage/storage.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/storage/storage.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/storage/storage.html (added)
+++ zeppelin/site/docs/0.7.3/storage/storage.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,430 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Notebook Storage for Apache Zeppelin</title>
+ <meta name="description" content="Apache Zeppelin has a pluggable notebook storage mechanism controlled by zeppelin.notebook.storage configuration option with multiple implementations."">
+ <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 Notebook Storage 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>Notebook storage options for Apache Zeppelin</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>Apache Zeppelin has a pluggable notebook storage mechanism controlled by <code>zeppelin.notebook.storage</code> configuration option with multiple implementations.
+There are few notebook storage systems available for a use out of the box:</p>
+
+<ul>
+<li>(default) use local file system and version it using local Git repository - <code>GitNotebookRepo</code></li>
+<li>all notes are saved in the notebook folder in your local File System - <code>VFSNotebookRepo</code></li>
+<li>storage using Amazon S3 service - <code>S3NotebookRepo</code></li>
+<li>storage using Azure service - <code>AzureNotebookRepo</code></li>
+</ul>
+
+<p>Multiple storage systems can be used at the same time by providing a comma-separated list of the class-names in the configuration.
+By default, only first two of them will be automatically kept in sync by Zeppelin.</p>
+
+<p></br></p>
+
+<h2>Notebook Storage in local Git repository <a name="Git"></a></h2>
+
+<p>To enable versioning for all your local notebooks though a standard Git repository - uncomment the next property in <code>zeppelin-site.xml</code> in order to use GitNotebookRepo class:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+</code></pre></div>
+<p></br></p>
+
+<h2>Notebook Storage in S3 <a name="S3"></a></h2>
+
+<p>Notebooks may be stored in S3, and optionally encrypted. The <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html"><code>DefaultAWSCredentialsProviderChain</code></a> credentials provider is used for credentials and checks the following:</p>
+
+<ul>
+<li>The <code>AWS_ACCESS_KEY_ID</code> and <code>AWS_SECRET_ACCESS_KEY</code> environment variables</li>
+<li>The <code>aws.accessKeyId</code> and <code>aws.secretKey</code> Java System properties</li>
+<li>Credential profiles file at the default location (<code>~/.aws/credentials</code>) used by the AWS CLI</li>
+<li>Instance profile credentials delivered through the Amazon EC2 metadata service</li>
+</ul>
+
+<p></br>
+The following folder structure will be created in S3:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">s3://bucket_name/username/notebook-id/
+</code></pre></div>
+<p>Configure by setting environment variables in the file <strong>zeppelin-env.sh</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELIN_NOTEBOOK_S3_BUCKET = bucket_name
+export ZEPPELIN_NOTEBOOK_S3_USER = username
+</code></pre></div>
+<p>Or using the file <strong>zeppelin-site.xml</strong> uncomment and complete the S3 settings:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.s3.bucket</name>
+ <value>bucket_name</value>
+ <description>bucket name for notebook storage</description>
+</property>
+<property>
+ <name>zeppelin.notebook.s3.user</name>
+ <value>username</value>
+ <description>user name for s3 folder structure</description>
+</property>
+</code></pre></div>
+<p>Uncomment the next property for use S3NotebookRepo class:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.S3NotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+</code></pre></div>
+<p>Comment out the next property to disable local git notebook storage (the default):</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value>
+ <description>versioned notebook persistence layer implementation</description>
+</property>
+</code></pre></div>
+<h3>Data Encryption in S3</h3>
+
+<h4>AWS KMS encryption keys</h4>
+
+<p>To use an <a href="https://aws.amazon.com/kms/">AWS KMS</a> encryption key to encrypt notebooks, set the following environment variable in the file <strong>zeppelin-env.sh</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID = kms-key-id
+</code></pre></div>
+<p>Or using the following setting in <strong>zeppelin-site.xml</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.s3.kmsKeyID</name>
+ <value>AWS-KMS-Key-UUID</value>
+ <description>AWS KMS key ID used to encrypt notebook data in S3</description>
+</property>
+</code></pre></div>
+<p>In order to set custom KMS key region, set the following environment variable in the file <strong>zeppelin-env.sh</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_REGION = kms-key-region
+</code></pre></div>
+<p>Or using the following setting in <strong>zeppelin-site.xml</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.s3.kmsKeyRegion</name>
+ <value>target-region</value>
+ <description>AWS KMS key region in your AWS account</description>
+</property>
+</code></pre></div>
+<p>Format of <code>target-region</code> is described in more details <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#kms_region">here</a> in second <code>Region</code> column (e.g. <code>us-east-1</code>).</p>
+
+<h4>Custom Encryption Materials Provider class</h4>
+
+<p>You may use a custom <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/model/EncryptionMaterialsProvider.html"><code>EncryptionMaterialsProvider</code></a> class as long as it is available in the classpath and able to initialize itself from system properties or another mechanism. To use this, set the following environment variable in the file <strong>zeppelin-env.sh</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELIN_NOTEBOOK_S3_EMP = class-name
+</code></pre></div>
+<p>Or using the following setting in <strong>zeppelin-site.xml</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.s3.encryptionMaterialsProvider</name>
+ <value>provider implementation class name</value>
+ <description>Custom encryption materials provider used to encrypt notebook data in S3</description>
+</code></pre></div>
+<p></br></p>
+
+<h2>Notebook Storage in Azure <a name="Azure"></a></h2>
+
+<p>Using <code>AzureNotebookRepo</code> you can connect your Zeppelin with your Azure account for notebook storage.</p>
+
+<p>First of all, input your <code>AccountName</code>, <code>AccountKey</code>, and <code>Share Name</code> in the file <strong>zeppelin-site.xml</strong> by commenting out and completing the next properties:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.azure.connectionString</name>
+ <value>DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey></value>
+ <description>Azure account credentials</description>
+</property>
+
+<property>
+ <name>zeppelin.notebook.azure.share</name>
+ <value>zeppelin</value>
+ <description>share name for notebook storage</description>
+</property>
+</code></pre></div>
+<p>Secondly, you can initialize <code>AzureNotebookRepo</code> class in the file <strong>zeppelin-site.xml</strong> by commenting the next property:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value>
+ <description>versioned notebook persistence layer implementation</description>
+</property>
+</code></pre></div>
+<p>and commenting out:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.AzureNotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+</code></pre></div>
+<p>In case you want to use simultaneously your local git storage with Azure storage use the following property instead:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo, apache.zeppelin.notebook.repo.AzureNotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+</code></pre></div>
+<p>Optionally, you can specify Azure folder structure name in the file <strong>zeppelin-site.xml</strong> by commenting out the next property:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"> <property>
+ <name>zeppelin.notebook.azure.user</name>
+ <value>user</value>
+ <description>optional user name for Azure folder structure</description>
+</property>
+</code></pre></div>
+<p></br></p>
+
+<h2>Storage in ZeppelinHub <a name="ZeppelinHub"></a></h2>
+
+<p>ZeppelinHub storage layer allows out of the box connection of Zeppelin instance with your ZeppelinHub account. First of all, you need to either comment out the following property in <strong>zeppelin-site.xml</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><!-- For connecting your Zeppelin with ZeppelinHub -->
+<!--
+<property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo, org.apache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo</value>
+ <description>two notebook persistence layers (local + ZeppelinHub)</description>
+</property>
+-->
+</code></pre></div>
+<p>or set the environment variable in the file <strong>zeppelin-env.sh</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELIN_NOTEBOOK_STORAGE="org.apache.zeppelin.notebook.repo.GitNotebookRepo, org.apache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo"
+</code></pre></div>
+<p>Secondly, you need to set the environment variables in the file <strong>zeppelin-env.sh</strong>:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">export ZEPPELINHUB_API_TOKEN = ZeppelinHub token
+export ZEPPELINHUB_API_ADDRESS = address of ZeppelinHub service (e.g. https://www.zeppelinhub.com)
+</code></pre></div>
+<p>You can get more information on generating <code>token</code> and using authentication on the corresponding <a href="http://help.zeppelinhub.com/zeppelin_integration/#add-a-new-zeppelin-instance-and-generate-a-token">help page</a>.</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>
+
Modified: zeppelin/site/documentation.html
URL: http://svn.apache.org/viewvc/zeppelin/site/documentation.html?rev=1809223&r1=1809222&r2=1809223&view=diff
==============================================================================
--- zeppelin/site/documentation.html (original)
+++ zeppelin/site/documentation.html Thu Sep 21 20:33:57 2017
@@ -73,7 +73,7 @@
</div>
<nav class="navbar-collapse collapse" role="navigation">
<ul class="nav navbar-nav navbar-right">
- <li><a href="/docs/0.7.2/install/install.html">Quick Start</a></li>
+ <li><a href="/docs/0.7.3/install/install.html">Quick Start</a></li>
<!-- Download -->
<li class="docs">
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Download<b class="caret"></b></a>
@@ -87,8 +87,8 @@
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Docs<b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="title"><span><b>Release</b><span></li>
+ <li><a href="/docs/0.7.3">0.7.3</a></li>
<li><a href="/docs/0.7.2">0.7.2</a></li>
- <li><a href="/docs/0.7.1">0.7.1</a></li>
<li><a href="/docs/0.6.2">0.6.2</a></li>
<li><a href="/docs/0.6.1">0.6.1</a></li>
<li><a href="documentation.html">Older Versions</a></li>
@@ -153,6 +153,7 @@ limitations under the License.
<h1>Apache Zeppelin Documentation</h1>
<ul>
+<li><a href="docs/0.7.1">Zeppelin 0.7.1</a></li>
<li><a href="docs/0.7.0">Zeppelin 0.7.0</a></li>
<li><a href="docs/0.6.0">Zeppelin 0.6.0</a></li>
<li><a href="docs/0.5.6-incubating">Zeppelin 0.5.6-incubating</a></li>