You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by ah...@apache.org on 2017/02/28 04:09:16 UTC
svn commit: r1784685 [3/3] - in /zeppelin/site/docs/0.8.0-SNAPSHOT: ./
development/ displaysystem/ install/ interpreter/ manual/ quickstart/
rest-api/ security/ storage/
Added: zeppelin/site/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html?rev=1784685&view=auto
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html (added)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html Tue Feb 28 04:09:15 2017
@@ -0,0 +1,405 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.8.0-SNAPSHOT Documentation: Apache Zeppelin notebook repository REST API</title>
+ <meta name="description" content="This page contains Apache Zeppelin notebook repository REST API information.">
+ <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.8.0-SNAPSHOT/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.8.0-SNAPSHOT/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.8.0-SNAPSHOT/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT">
+ <span><small>0.8.0-SNAPSHOT</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.8.0-SNAPSHOT/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.8.0-SNAPSHOT/install/install.html">Install</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/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.8.0-SNAPSHOT/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.8.0-SNAPSHOT/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.8.0-SNAPSHOT/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinspell.html">Writing Zeppelin Spell (Experimental)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.8.0-SNAPSHOT/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 Zeppelin notebook repository REST API">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Apache Zeppelin Notebook Repository API</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
+All REST APIs are available starting with the following endpoint <code>http://[zeppelin-server]:[zeppelin-port]/api</code>.
+Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as <a href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc">JSONView</a>.</p>
+
+<p>If you work with Apache Zeppelin and find a need for an additional REST API, please <a href="http://zeppelin.apache.org/community.html">file an issue or send us an email</a>.</p>
+
+<h2>Notebook Repository REST API List</h2>
+
+<h3>List all available notebook repositories</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method returns all the available notebook repositories.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": [
+ {
+ "name": "GitNotebookRepo",
+ "className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
+ "settings": [
+ {
+ "type": "INPUT",
+ "value": [],
+ "selected": "ZEPPELIN_HOME/zeppelin/notebook/",
+ "name": "Notebook Path"
+ }
+ ]
+ }
+ ]
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Reload a notebook repository</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method triggers reloading and broadcasting of the note list.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": ""
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Update a specific notebook repository</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method updates a specific notebook repository.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>
+ 404 when the specified notebook repository doesn't exist <br/>
+ 406 for invalid payload <br/>
+ 500 for any other errors
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON input</td>
+ <td>
+ <pre>
+{
+ "name":"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
+ "settings":{
+ "Notebook Path":"/tmp/notebook/"
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "name": "GitNotebookRepo",
+ "className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
+ "settings": [
+ {
+ "type": "INPUT",
+ "value": [],
+ "selected": "/tmp/notebook/",
+ "name": "Notebook Path"
+ }
+ ]
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/rss.xml Tue Feb 28 04:09:15 2017
@@ -5,8 +5,8 @@
<description>Apache Zeppelin - The Apache Software Foundation</description>
<link>http://zeppelin.apache.org</link>
<link>http://zeppelin.apache.org</link>
- <lastBuildDate>2017-02-19T18:28:37+09:00</lastBuildDate>
- <pubDate>2017-02-19T18:28:37+09:00</pubDate>
+ <lastBuildDate>2017-02-28T13:04:35+09:00</lastBuildDate>
+ <pubDate>2017-02-28T13:04:35+09:00</pubDate>
<ttl>1800</ttl>
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/screenshots.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/screenshots.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/screenshots.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/screenshots.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit ">
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/search.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/search.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/search.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/search.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit ">
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/search_data.json Tue Feb 28 04:09:15 2017
@@ -634,7 +634,7 @@
"/rest-api/rest-helium.html": {
"title": "Apache Zeppelin Helium REST API",
- "content" : "<!--Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.-->Apache Zeppelin Helium REST APIOverviewApache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.If you work with Apache Zeppelin and f
ind a need for an additional REST API, please file an issue or send us an email.Helium REST API ListList of all available helium packages Description This GET method returns all the available helium packages in configured registries. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/all Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;zeppelin.clock&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;APPLICATION&quot;, &quot;name&quot;: &quot;zeppelin.clock&quot;, &quot;description&quot;: &quot;Clock (example)&quot;, &quot;artifact&quot;: &quot;ze
ppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.example.app.clock.Clock&quot;, &quot;resources&quot;: [ [ &quot;:java.util.Date&quot; ] ], &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: false } ], &quot;zeppelin-bubblechart&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;VISUALIZATION&quot;, &quot;name&quot;: &quot;zeppelin-bubblechart&quot;, &quot;description&quot;: &quot;Animated bubble chart&quot;, &quot;artifact&quot;: &quot;./../helium/zeppelin-bubble&quot;, &quot;icon&quot;: &quot;icon&quot;
}, &quot;enabled&quot;: true }, { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;VISUALIZATION&quot;, &quot;name&quot;: &quot;zeppelin-bubblechart&quot;, &quot;description&quot;: &quot;Animated bubble chart&quot;, &quot;artifact&quot;: &quot;zeppelin-bubblechart@0.0.2&quot;, &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: false } ], &quot;zeppelinhorizontalbar&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;VISUALIZATION&quot;, &quot;name&quot;: &quot;zeppelinhorizontalbar&quot;, &quot;description&quot;: &quot;Horizontal Bar chart (example)&quot;,
&quot;artifact&quot;: &quot;./zeppelin-examples/zeppelin-example-horizontalbar&quot;, &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: true } ] }} Suggest Helium application Description This GET method returns suggested helium application for the paragraph. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/suggest/[Note ID]/[Paragraph ID] Success code 200 Fail code 404 on note or paragraph not exists 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;available&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;APPLICATION
&quot;, &quot;name&quot;: &quot;zeppelin.clock&quot;, &quot;description&quot;: &quot;Clock (example)&quot;, &quot;artifact&quot;: &quot;zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.example.app.clock.Clock&quot;, &quot;resources&quot;: [ [ &quot;:java.util.Date&quot; ] ], &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: true } ] }} Load helium Application on a paragraph Description This GET method returns a helium Application id on success. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/load/[Note ID]/[Paragraph ID] Success code 200 Fail code
404 on note or paragraph not exists 500 for any other errors Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: &quot;app2C5FYRZ1E-20170108-0404492068241472zeppelin_clock&quot;} Load bundled visualization script Description This GET method returns bundled helium visualization javascript. When refresh=true (optional) is provided, Zeppelin rebuild bundle. otherwise, provided from cache URL http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizations/load[?refresh=true] Success code 200 reponse body is executable javascript Fail code 200 reponse body is error message string starts with ERROR: Enable package Description This POST method enables a helium package. Needs artifact name in input payload
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/enable/[Package Name] Success code 200 Fail code 500 Sample input zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Disable package Description This POST method disables a helium package. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/disable/[Package Name] Success code 200 Fail code 500 Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Get visualization display order Description This GET method returns display order of enabled visualization packages. URL http://[zeppelin-server]:[zeppelin-port]/api/heli
um/visualizationOrder Success code 200 Fail code 500 Sample JSON response {&quot;status&quot;:&quot;OK&quot;,&quot;body&quot;:[&quot;zeppelin_horizontalbar&quot;,&quot;zeppelin-bubblechart&quot;]} Set visualization display order Description This POST method sets visualization packages display order. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder Success code 200 Fail code 500 Sample JSON input [&quot;zeppelin-bubblechart&quot;, &quot;zeppelin_horizontalbar&quot;] Sample JSON response {&quot;status&quot;:&quot;OK&quot;} ",
+ "content" : "<!--Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.-->Apache Zeppelin Helium REST APIOverviewApache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.If you work with Apache Zeppelin and f
ind a need for an additional REST API, please file an issue or send us an email.Helium REST API ListList of all available helium packages Description This GET method returns all the available helium packages in configured registries. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/all Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;zeppelin.clock&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;APPLICATION&quot;, &quot;name&quot;: &quot;zeppelin.clock&quot;, &quot;description&quot;: &quot;Clock (example)&quot;, &quot;artifact&quot;: &quot;ze
ppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.example.app.clock.Clock&quot;, &quot;resources&quot;: [ [ &quot;:java.util.Date&quot; ] ], &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: false } ], &quot;zeppelin-bubblechart&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;VISUALIZATION&quot;, &quot;name&quot;: &quot;zeppelin-bubblechart&quot;, &quot;description&quot;: &quot;Animated bubble chart&quot;, &quot;artifact&quot;: &quot;./../helium/zeppelin-bubble&quot;, &quot;icon&quot;: &quot;icon&quot;
}, &quot;enabled&quot;: true }, { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;VISUALIZATION&quot;, &quot;name&quot;: &quot;zeppelin-bubblechart&quot;, &quot;description&quot;: &quot;Animated bubble chart&quot;, &quot;artifact&quot;: &quot;zeppelin-bubblechart@0.0.2&quot;, &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: false } ], &quot;zeppelin_horizontalbar&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;VISUALIZATION&quot;, &quot;name&quot;: &quot;zeppelin_horizontalbar&quot;, &quot;description&quot;: &quot;Horizontal Bar chart (example)&quot;,
&quot;artifact&quot;: &quot;./zeppelin-examples/zeppelin-example-horizontalbar&quot;, &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: true } ] }} Suggest Helium application Description This GET method returns suggested helium application for the paragraph. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/suggest/[Note ID]/[Paragraph ID] Success code 200 Fail code 404 on note or paragraph not exists 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;available&quot;: [ { &quot;registry&quot;: &quot;local&quot;, &quot;pkg&quot;: { &quot;type&quot;: &quot;APPLICATI
ON&quot;, &quot;name&quot;: &quot;zeppelin.clock&quot;, &quot;description&quot;: &quot;Clock (example)&quot;, &quot;artifact&quot;: &quot;zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.example.app.clock.Clock&quot;, &quot;resources&quot;: [ [ &quot;:java.util.Date&quot; ] ], &quot;icon&quot;: &quot;icon&quot; }, &quot;enabled&quot;: true } ] }} Load helium Application on a paragraph Description This GET method returns a helium Application id on success. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/load/[Note ID]/[Paragraph ID] Success code 200 Fail code
404 on note or paragraph not exists 500 for any other errors Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: &quot;app2C5FYRZ1E-20170108-0404492068241472zeppelin_clock&quot;} Load bundled visualization script Description This GET method returns bundled helium visualization javascript. When refresh=true (optional) is provided, Zeppelin rebuild bundle. otherwise, provided from cache URL http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizations/load[?refresh=true] Success code 200 reponse body is executable javascript Fail code 200 reponse body is error message string starts with ERROR: Enable package Description This POST method enables a helium package. Needs artifact name in input payload
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/enable/[Package Name] Success code 200 Fail code 500 Sample input zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Disable package Description This POST method disables a helium package. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/disable/[Package Name] Success code 200 Fail code 500 Sample JSON response {&quot;status&quot;:&quot;OK&quot;} Get visualization display order Description This GET method returns display order of enabled visualization packages. URL http://[zeppelin-server]:[zeppelin-port]/api/he
lium/visualizationOrder Success code 200 Fail code 500 Sample JSON response {&quot;status&quot;:&quot;OK&quot;,&quot;body&quot;:[&quot;zeppelin_horizontalbar&quot;,&quot;zeppelin-bubblechart&quot;]} Set visualization display order Description This POST method sets visualization packages display order. URL http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder Success code 200 Fail code 500 Sample JSON input [&quot;zeppelin-bubblechart&quot;, &quot;zeppelin_horizontalbar&quot;] Sample JSON response {&quot;status&quot;:&quot;OK&quot;} ",
"url": " /rest-api/rest-helium.html",
"group": "rest-api",
"excerpt": "This page contains Apache Zeppelin Helium REST API information."
@@ -664,6 +664,17 @@
,
+
+ "/rest-api/rest-notebookRepo.html": {
+ "title": "Apache Zeppelin notebook repository REST API",
+ "content" : "<!--Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.-->Apache Zeppelin Notebook Repository APIOverviewApache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.If you work with Apache Zeppel
in and find a need for an additional REST API, please file an issue or send us an email.Notebook Repository REST API ListList all available notebook repositories Description This GET method returns all the available notebook repositories. URL http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: [ { &quot;name&quot;: &quot;GitNotebookRepo&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.notebook.repo.GitNotebookRepo&quot;, &quot;settings&quot;: [ { &quot;type&quot;: &quot;INPUT&quot;, &quot;value&quot;: [], &quot;selected&quot;: &quot;ZEPPELIN_HOME/zeppelin/n
otebook/&quot;, &quot;name&quot;: &quot;Notebook Path&quot; } ] } ]} Reload a notebook repository Description This GET method triggers reloading and broadcasting of the note list. URL http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload Success code 200 Fail code 500 Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;} Update a specific notebook repository Description This PUT method updates a specific notebook repository. URL http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories Success code 200 Fail code 404 when the specified notebook repository doesn&#39;t exist 406 for invalid payload 500 for a
ny other errors Sample JSON input { &quot;name&quot;:&quot;org.apache.zeppelin.notebook.repo.GitNotebookRepo&quot;, &quot;settings&quot;:{ &quot;Notebook Path&quot;:&quot;/tmp/notebook/&quot; }} Sample JSON response { &quot;status&quot;: &quot;OK&quot;, &quot;message&quot;: &quot;&quot;, &quot;body&quot;: { &quot;name&quot;: &quot;GitNotebookRepo&quot;, &quot;className&quot;: &quot;org.apache.zeppelin.notebook.repo.GitNotebookRepo&quot;, &quot;settings&quot;: [ { &quot;type&quot;: &quot;INPUT&quot;, &quot;value&quot;: [], &quot;selected&quot;: &quot;/tmp/notebook/&quot;, &quot;name&quot;: &quot;Notebook Path&quot; } ] }} ",
+ "url": " /rest-api/rest-notebookRepo.html",
+ "group": "rest-api",
+ "excerpt": "This page contains Apache Zeppelin notebook repository REST API information."
+ }
+ ,
+
+
@@ -716,7 +727,7 @@
"/storage/storage.html": {
"title": "Notebook Storage for Apache Zeppelin",
- "content" : "<!--Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.-->{% include JB/setup %}# Notebook storage options for Apache Zeppelin## OverviewApache Zeppelin has a pluggable notebook storage mechanism controlled by `zeppelin.notebook.storage` configuration option with multiple implementations.There are few notebook storage systems available for a use out of the box: * (default) use local file system and version it using local Git repository - `GitNotebookRepo` * all notes are saved in the no
tebook folder in your local File System - `VFSNotebookRepo` * storage using Amazon S3 service - `S3NotebookRepo` * storage using Azure service - `AzureNotebookRepo`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.## Notebook Storage in local Git repository To enable versioning for all your local notebooks though a standard Git repository - uncomment the next property in `zeppelin-site.xml` in order to use GitNotebookRepo class:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo notebook persistence layer implementation```## Notebook Storage in S3 Notebooks may be stored in S3, and optionally encrypted. The [``DefaultAWSCredentialsProviderChain``](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html) credentials provider is used fo
r credentials and checks the following:- The ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY`` environment variables- The ``aws.accessKeyId`` and ``aws.secretKey`` Java System properties- Credential profiles file at the default location (````~/.aws/credentials````) used by the AWS CLI- Instance profile credentials delivered through the Amazon EC2 metadata serviceThe following folder structure will be created in S3:```s3://bucket_name/username/notebook-id/```Configure by setting environment variables in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_BUCKET = bucket_nameexport ZEPPELIN_NOTEBOOK_S3_USER = username```Or using the file **zeppelin-site.xml** uncomment and complete the S3 settings:``` zeppelin.notebook.s3.bucket bucket_name bucket name for notebook storage zeppelin.notebook.s3.user username user name for s3 folder structure```Uncomment the next property for use S3NotebookRepo class:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.S3Not
ebookRepo notebook persistence layer implementation```Comment out the next property to disable local git notebook storage (the default):``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo versioned notebook persistence layer implementation```### Data Encryption in S3#### AWS KMS encryption keysTo use an [AWS KMS](https://aws.amazon.com/kms/) encryption key to encrypt notebooks, set the following environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID = kms-key-id```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.kmsKeyID AWS-KMS-Key-UUID AWS KMS key ID used to encrypt notebook data in S3```In order to set custom KMS key region, set the following environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_REGION = kms-key-region```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.kmsKeyRegion target-region AWS KMS
key region in your AWS account```Format of `target-region` is described in more details [here](http://docs.aws.amazon.com/general/latest/gr/rande.html#kms_region) in second `Region` column (e.g. `us-east-1`).#### Custom Encryption Materials Provider classYou may use a custom [``EncryptionMaterialsProvider``](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/model/EncryptionMaterialsProvider.html) 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 **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_EMP = class-name```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.encryptionMaterialsProvider provider implementation class name Custom encryption materials provider used to encrypt notebook data in S3``` #### Enable server-side encryptionTo request server-side encryption of notebooks,
set the following environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_SSE = true```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.sse true Server-side encryption enabled for notebooks```## Notebook Storage in Azure Using `AzureNotebookRepo` you can connect your Zeppelin with your Azure account for notebook storage.First of all, input your `AccountName`, `AccountKey`, and `Share Name` in the file **zeppelin-site.xml** by commenting out and completing the next properties:``` zeppelin.notebook.azure.connectionString DefaultEndpointsProtocol=https;AccountName=;AccountKey= Azure account credentials zeppelin.notebook.azure.share zeppelin share name for notebook storage```Secondly, you can initialize `AzureNotebookRepo` class in the file **zeppelin-site.xml** by commenting the next property:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo versioned notebook persistence layer imple
mentation```and commenting out:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.AzureNotebookRepo notebook persistence layer implementation```In case you want to use simultaneously your local git storage with Azure storage use the following property instead: ``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo, apache.zeppelin.notebook.repo.AzureNotebookRepo notebook persistence layer implementation```Optionally, you can specify Azure folder structure name in the file **zeppelin-site.xml** by commenting out the next property: ``` zeppelin.notebook.azure.user user optional user name for Azure folder structure```## Storage in ZeppelinHub 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 **zeppelin-site.xml**:```<!-- zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo, org.a
pache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo two notebook persistence layers (local + ZeppelinHub)-->```or set the environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_STORAGE="org.apache.zeppelin.notebook.repo.GitNotebookRepo, org.apache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo"```Secondly, you need to set the environment variables in the file **zeppelin-env.sh**:```export ZEPPELINHUB_API_TOKEN = ZeppelinHub tokenexport ZEPPELINHUB_API_ADDRESS = address of ZeppelinHub service (e.g. https://www.zeppelinhub.com)```You can get more information on generating `token` and using authentication on the corresponding [help page](http://help.zeppelinhub.com/zeppelin_integration/#add-a-new-zeppelin-instance-and-generate-a-token).",
+ "content" : "<!--Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.-->{% include JB/setup %}# Notebook storage options for Apache Zeppelin## OverviewApache Zeppelin has a pluggable notebook storage mechanism controlled by `zeppelin.notebook.storage` configuration option with multiple implementations.There are few notebook storage systems available for a use out of the box: * (default) use local file system and version it using local Git repository - `GitNotebookRepo` * all notes are saved in the no
tebook folder in your local File System - `VFSNotebookRepo` * storage using Amazon S3 service - `S3NotebookRepo` * storage using Azure service - `AzureNotebookRepo` * storage using MongoDB - `MongoNotebookRepo`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.## Notebook Storage in local Git repository To enable versioning for all your local notebooks though a standard Git repository - uncomment the next property in `zeppelin-site.xml` in order to use GitNotebookRepo class:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo notebook persistence layer implementation```## Notebook Storage in S3 Notebooks may be stored in S3, and optionally encrypted. The [``DefaultAWSCredentialsProviderChain``](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProv
iderChain.html) credentials provider is used for credentials and checks the following:- The ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY`` environment variables- The ``aws.accessKeyId`` and ``aws.secretKey`` Java System properties- Credential profiles file at the default location (````~/.aws/credentials````) used by the AWS CLI- Instance profile credentials delivered through the Amazon EC2 metadata serviceThe following folder structure will be created in S3:```s3://bucket_name/username/notebook-id/```Configure by setting environment variables in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_BUCKET = bucket_nameexport ZEPPELIN_NOTEBOOK_S3_USER = username```Or using the file **zeppelin-site.xml** uncomment and complete the S3 settings:``` zeppelin.notebook.s3.bucket bucket_name bucket name for notebook storage zeppelin.notebook.s3.user username user name for s3 folder structure```Uncomment the next property for use S3NotebookRepo class:``` zeppelin.notebook.s
torage org.apache.zeppelin.notebook.repo.S3NotebookRepo notebook persistence layer implementation```Comment out the next property to disable local git notebook storage (the default):``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo versioned notebook persistence layer implementation```### Data Encryption in S3#### AWS KMS encryption keysTo use an [AWS KMS](https://aws.amazon.com/kms/) encryption key to encrypt notebooks, set the following environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID = kms-key-id```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.kmsKeyID AWS-KMS-Key-UUID AWS KMS key ID used to encrypt notebook data in S3```In order to set custom KMS key region, set the following environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_REGION = kms-key-region```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.n
otebook.s3.kmsKeyRegion target-region AWS KMS key region in your AWS account```Format of `target-region` is described in more details [here](http://docs.aws.amazon.com/general/latest/gr/rande.html#kms_region) in second `Region` column (e.g. `us-east-1`).#### Custom Encryption Materials Provider classYou may use a custom [``EncryptionMaterialsProvider``](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/model/EncryptionMaterialsProvider.html) 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 **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_EMP = class-name```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.encryptionMaterialsProvider provider implementation class name Custom encryption materials provider used to encrypt notebook data in S3``` #### Enable server-side encryption
To request server-side encryption of notebooks, set the following environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_S3_SSE = true```Or using the following setting in **zeppelin-site.xml**:``` zeppelin.notebook.s3.sse true Server-side encryption enabled for notebooks```## Notebook Storage in Azure Using `AzureNotebookRepo` you can connect your Zeppelin with your Azure account for notebook storage.First of all, input your `AccountName`, `AccountKey`, and `Share Name` in the file **zeppelin-site.xml** by commenting out and completing the next properties:``` zeppelin.notebook.azure.connectionString DefaultEndpointsProtocol=https;AccountName=;AccountKey= Azure account credentials zeppelin.notebook.azure.share zeppelin share name for notebook storage```Secondly, you can initialize `AzureNotebookRepo` class in the file **zeppelin-site.xml** by commenting the next property:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRe
po versioned notebook persistence layer implementation```and commenting out:``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.AzureNotebookRepo notebook persistence layer implementation```In case you want to use simultaneously your local git storage with Azure storage use the following property instead: ``` zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo, apache.zeppelin.notebook.repo.AzureNotebookRepo notebook persistence layer implementation```Optionally, you can specify Azure folder structure name in the file **zeppelin-site.xml** by commenting out the next property: ``` zeppelin.notebook.azure.user user optional user name for Azure folder structure```## Storage in ZeppelinHub 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 **zeppelin-site.xml**:```<!-- zeppelin.notebook.storage org.apache
.zeppelin.notebook.repo.GitNotebookRepo, org.apache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo two notebook persistence layers (local + ZeppelinHub)-->```or set the environment variable in the file **zeppelin-env.sh**:```export ZEPPELIN_NOTEBOOK_STORAGE="org.apache.zeppelin.notebook.repo.GitNotebookRepo, org.apache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo"```Secondly, you need to set the environment variables in the file **zeppelin-env.sh**:```export ZEPPELINHUB_API_TOKEN = ZeppelinHub tokenexport ZEPPELINHUB_API_ADDRESS = address of ZeppelinHub service (e.g. https://www.zeppelinhub.com)```You can get more information on generating `token` and using authentication on the corresponding [help page](http://help.zeppelinhub.com/zeppelin_integration/#add-a-new-zeppelin-instance-and-generate-a-token).## Notebook Storage in MongoDB Using `MongoNotebookRepo`, you can store your notebook in [MongoDB](https://www.mongodb.com/).### Why MongoDB?* **[High Availabi
lity (HA)](https://en.wikipedia.org/wiki/High_availability)** by a [replica set](https://docs.mongodb.com/manual/reference/glossary/#term-replica-set)* Seperation of storage from server### How to useYou can use MongoDB as notebook storage by editting `zeppelin-env.sh` or `zeppelin-site.xml`.#### (Method 1) by editting `zeppelin-env.sh`Add a line below to `$ZEPPELIN_HOME/conf/zeppelin-env.sh`:```shexport ZEPPELIN_NOTEBOOK_STORAGE=org.apache.zeppelin.notebook.repo.MongoNotebookRepo```> *NOTE:* The default MongoDB connection URI is `mongodb://localhost`#### (Method 2) by editting `zeppelin-site.xml`Or, **uncomment** lines below at `$ZEPPELIN_HOME/conf/zeppelin-site.xml`:```xml zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.MongoNotebookRepo notebook persistence layer implementation```And **comment** lines below:```xml zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.GitNotebookRepo versioned notebook persistence layer implementation```### Configurable O
ptionsYou can configure options below in `zeppelin-env.sh`.* `ZEPPELIN_NOTEBOOK_MONGO_URI` [MongoDB connection URI](https://docs.mongodb.com/manual/reference/connection-string/) used to connect to a MongoDB database server* `ZEPPELIN_NOTEBOOK_MONGO_DATABASE` Database name* `ZEPPELIN_NOTEBOOK_MONGO_COLLECTION` Collection name* `ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT` If `true`, import local notes (refer to description below for details)Or, you can configure them in `zeppelin-site.xml`. Corresponding option names as follows:* `zeppelin.notebook.mongo.uri`* `zeppelin.notebook.mongo.database`* `zeppelin.notebook.mongo.collection`* `zeppelin.notebook.mongo.autoimport`#### Example configurations in `zeppelin-env.sh````shexport ZEPPELIN_NOTEBOOK_MONGO_URI=mongodb://db1.example.com:27017export ZEPPELIN_NOTEBOOK_MONGO_DATABASE=myfancyexport ZEPPELIN_NOTEBOOK_MONGO_COLLECTION=notebookexport ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT=true```#### Import your local notes automaticallyBy setting `ZEPPELIN_NO
TEBOOK_MONGO_AUTOIMPORT` as `true` (default `false`), you can import your local notes automatically when Zeppelin daemon starts up. This feature is for easy migration from local file system storage to MongoDB storage. A note with ID already existing in the collection will not be imported.",
"url": " /storage/storage.html",
"group": "storage",
"excerpt": "Apache Zeppelin has a pluggable notebook storage mechanism controlled by zeppelin.notebook.storage configuration option with multiple implementations.\""
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/security/authentication.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit Authentication for NGINX">
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit Data Source Authorization in Apache Zeppelin">
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit Notebook Authorization in Apache Zeppelin">
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit Apache Shiro Authentication for Apache Zeppelin">
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/sitemap.txt
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/sitemap.txt?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/sitemap.txt (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/sitemap.txt Tue Feb 28 04:09:15 2017
@@ -63,6 +63,7 @@ http://zeppelin.apache.org/rest-api/rest
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
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/storage/storage.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/storage/storage.html?rev=1784685&r1=1784684&r2=1784685&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/storage/storage.html (original)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/storage/storage.html Tue Feb 28 04:09:15 2017
@@ -148,16 +148,18 @@
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span><b>REST API</b><span></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/rest-api/rest-credential.html">Credential API</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/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.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.8.0-SNAPSHOT/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.8.0-SNAPSHOT/security/datasource_authorization.html">Data Source Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -188,7 +190,6 @@
</div>
-
<div class="content">
<!--<div class="hero-unit Notebook Storage for Apache Zeppelin">
@@ -226,6 +227,7 @@ There are few notebook storage systems a
<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>
+<li>storage using MongoDB - <code>MongoNotebookRepo</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.
@@ -340,7 +342,7 @@ export ZEPPELIN_NOTEBOOK_S3_USER = usern
</code></pre></div>
<p></br></p>
-<h2>Notebook Storage in Azure <a name="Azure"></a></h2>
+<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>
@@ -408,6 +410,76 @@ export ZEPPELINHUB_API_ADDRESS = address
</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>
+<h2>Notebook Storage in MongoDB <a name="MongoDB"></a></h2>
+
+<p>Using <code>MongoNotebookRepo</code>, you can store your notebook in <a href="https://www.mongodb.com/">MongoDB</a>.</p>
+
+<h3>Why MongoDB?</h3>
+
+<ul>
+<li><strong><a href="https://en.wikipedia.org/wiki/High_availability">High Availability (HA)</a></strong> by a <a href="https://docs.mongodb.com/manual/reference/glossary/#term-replica-set">replica set</a></li>
+<li>Seperation of storage from server</li>
+</ul>
+
+<h3>How to use</h3>
+
+<p>You can use MongoDB as notebook storage by editting <code>zeppelin-env.sh</code> or <code>zeppelin-site.xml</code>.</p>
+
+<h4>(Method 1) by editting <code>zeppelin-env.sh</code></h4>
+
+<p>Add a line below to <code>$ZEPPELIN_HOME/conf/zeppelin-env.sh</code>:</p>
+<div class="highlight"><pre><code class="sh language-sh" data-lang="sh"><span class="nb">export </span><span class="nv">ZEPPELIN_NOTEBOOK_STORAGE</span><span class="o">=</span>org.apache.zeppelin.notebook.repo.MongoNotebookRepo
+</code></pre></div>
+<blockquote>
+<p><em>NOTE:</em> The default MongoDB connection URI is <code>mongodb://localhost</code></p>
+</blockquote>
+
+<h4>(Method 2) by editting <code>zeppelin-site.xml</code></h4>
+
+<p>Or, <strong>uncomment</strong> lines below at <code>$ZEPPELIN_HOME/conf/zeppelin-site.xml</code>:</p>
+<div class="highlight"><pre><code class="xml language-xml" data-lang="xml"><span class="nt"><property></span>
+ <span class="nt"><name></span>zeppelin.notebook.storage<span class="nt"></name></span>
+ <span class="nt"><value></span>org.apache.zeppelin.notebook.repo.MongoNotebookRepo<span class="nt"></value></span>
+ <span class="nt"><description></span>notebook persistence layer implementation<span class="nt"></description></span>
+<span class="nt"></property></span>
+</code></pre></div>
+<p>And <strong>comment</strong> lines below:</p>
+<div class="highlight"><pre><code class="xml language-xml" data-lang="xml"><span class="nt"><property></span>
+ <span class="nt"><name></span>zeppelin.notebook.storage<span class="nt"></name></span>
+ <span class="nt"><value></span>org.apache.zeppelin.notebook.repo.GitNotebookRepo<span class="nt"></value></span>
+ <span class="nt"><description></span>versioned notebook persistence layer implementation<span class="nt"></description></span>
+<span class="nt"></property></span>
+</code></pre></div>
+<h3>Configurable Options</h3>
+
+<p>You can configure options below in <code>zeppelin-env.sh</code>.</p>
+
+<ul>
+<li><code>ZEPPELIN_NOTEBOOK_MONGO_URI</code> <a href="https://docs.mongodb.com/manual/reference/connection-string/">MongoDB connection URI</a> used to connect to a MongoDB database server</li>
+<li><code>ZEPPELIN_NOTEBOOK_MONGO_DATABASE</code> Database name</li>
+<li><code>ZEPPELIN_NOTEBOOK_MONGO_COLLECTION</code> Collection name</li>
+<li><code>ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT</code> If <code>true</code>, import local notes (refer to description below for details)</li>
+</ul>
+
+<p>Or, you can configure them in <code>zeppelin-site.xml</code>. Corresponding option names as follows:</p>
+
+<ul>
+<li><code>zeppelin.notebook.mongo.uri</code></li>
+<li><code>zeppelin.notebook.mongo.database</code></li>
+<li><code>zeppelin.notebook.mongo.collection</code></li>
+<li><code>zeppelin.notebook.mongo.autoimport</code></li>
+</ul>
+
+<h4>Example configurations in <code>zeppelin-env.sh</code></h4>
+<div class="highlight"><pre><code class="sh language-sh" data-lang="sh"><span class="nb">export </span><span class="nv">ZEPPELIN_NOTEBOOK_MONGO_URI</span><span class="o">=</span>mongodb://db1.example.com:27017
+<span class="nb">export </span><span class="nv">ZEPPELIN_NOTEBOOK_MONGO_DATABASE</span><span class="o">=</span>myfancy
+<span class="nb">export </span><span class="nv">ZEPPELIN_NOTEBOOK_MONGO_COLLECTION</span><span class="o">=</span>notebook
+<span class="nb">export </span><span class="nv">ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT</span><span class="o">=</span><span class="nb">true</span>
+</code></pre></div>
+<h4>Import your local notes automatically</h4>
+
+<p>By setting <code>ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT</code> as <code>true</code> (default <code>false</code>), you can import your local notes automatically when Zeppelin daemon starts up. This feature is for easy migration from local file system storage to MongoDB storage. A note with ID already existing in the collection will not be imported.</p>
+
</div>
</div>