Repository: incubator-zeppelin
Updated Branches:
refs/heads/master e07738b08 -> 7d00af4da
Documentation for setting Azure notebook storage
### What is this PR for?
This PR adds general info and documentation on setting Azure storage in the `docs/storage.md` folder where we have info about all the supported pluggable storage layers.
### What type of PR is it?
Documentation
### Todos
* [x] - add docs
* [x] - change description and order in `zeppelin-site.xml.template`
### What is the Jira issue?
### How should this be tested?
Documentation follows the steps in `zeppelin-site.xml.template`. may need to have account to test.
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: Khalid Huseynov <kh...@nflabs.com>
Closes #902 from khalidhuseynov/docs/azure-storage and squashes the following commits:
70b9f06 [Khalid Huseynov] address comments
f619fbe [Khalid Huseynov] add docs for azure in storage folder
Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/7d00af4d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/7d00af4d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/7d00af4d
Branch: refs/heads/master
Commit: 7d00af4daf14c2de9c617d0916b1671047dba764
Parents: e07738b
Author: Khalid Huseynov <kh...@nflabs.com>
Authored: Tue May 24 17:25:09 2016 +0900
Committer: Alexander Bezzubov <bz...@apache.org>
Committed: Fri May 27 16:58:55 2016 +0900
----------------------------------------------------------------------
conf/zeppelin-site.xml.template | 12 ++--
docs/_includes/themes/zeppelin/_navigation.html | 1 +
docs/storage/storage.md | 67 +++++++++++++++++++-
3 files changed, 72 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/7d00af4d/conf/zeppelin-site.xml.template
----------------------------------------------------------------------
diff --git a/conf/zeppelin-site.xml.template b/conf/zeppelin-site.xml.template
index 6e65fca..f7a5405 100755
--- a/conf/zeppelin-site.xml.template
+++ b/conf/zeppelin-site.xml.template
@@ -117,9 +117,9 @@
<!-- If using Azure for storage use the following settings -->
<!--
<property>
- <name>zeppelin.notebook.azure.user</name>
- <value>user</value>
- <description>optional user name for Azure folder structure</description>
+ <name>zeppelin.notebook.azure.connectionString</name>
+ <value>DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey></value>
+ <description>Azure account credentials</description>
</property>
<property>
@@ -129,9 +129,9 @@
</property>
<property>
- <name>zeppelin.notebook.azure.connectionString</name>
- <value>DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey></value>
- <description>share name for notebook storage</description>
+ <name>zeppelin.notebook.azure.user</name>
+ <value>user</value>
+ <description>optional user name for Azure folder structure</description>
</property>
<property>
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/7d00af4d/docs/_includes/themes/zeppelin/_navigation.html
----------------------------------------------------------------------
diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html
index 9969cda..10d7be0 100644
--- a/docs/_includes/themes/zeppelin/_navigation.html
+++ b/docs/_includes/themes/zeppelin/_navigation.html
@@ -86,6 +86,7 @@
<!-- li><span><b>Notebook Storage</b><span></li -->
<li><a href="{{BASE_PATH}}/storage/storage.html#Git">Git Storage</a></li>
<li><a href="{{BASE_PATH}}/storage/storage.html#S3">S3 Storage</a></li>
+ <li><a href="{{BASE_PATH}}/storage/storage.html#Azure">Azure Storage</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>REST API</b><span></li -->
<li><a href="{{BASE_PATH}}/rest-api/rest-interpreter.html">Interpreter API</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/7d00af4d/docs/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/storage/storage.md b/docs/storage/storage.md
index 92eb42f..ea534bf 100644
--- a/docs/storage/storage.md
+++ b/docs/storage/storage.md
@@ -22,8 +22,9 @@ limitations under the License.
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) all notes are saved in the notebook folder in your local File System - `VFSNotebookRepo`
- - there is also an option to version it using local Git repository - `GitNotebookRepo`
- - another option is Amazon's S3 service - `S3NotebookRepo`
+ - use local file system and version it using local Git repository - `GitNotebookRepo`
+ - 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.
@@ -136,5 +137,67 @@ Or using the following setting in **zeppelin-site.xml**:
<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>
+```
+
+</br>
+#### Notebook Storage in Azure <a name="Azure"></a>
+
+Using `AzureNotebookRepo` you can connect your Zeppelin with your Azure account for notebook storage.
+
+</br>
+
+First of all, input your `AccountName`, `AccountKey`, and `Share Name` in the file **zeppelin-site.xml** by commenting out and completing the next properties:
+
+```
+<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>
+```
+
+Secondly, you can initialize `AzureNotebookRepo` class in the file **zeppelin-site.xml** by commenting the next property:
+
+```
+<property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.VFSNotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+```
+
+and commenting out:
+
+```
+<property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.AzureNotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+```
+
+In case you want to use simultaneously your local storage with Azure storage use the following property instead:
+
+ ```
+<property>
+ <name>zeppelin.notebook.storage</name>
+ <value>org.apache.zeppelin.notebook.repo.VFSNotebookRepo, apache.zeppelin.notebook.repo.AzureNotebookRepo</value>
+ <description>notebook persistence layer implementation</description>
+</property>
+```
+
+Optionally, you can specify Azure folder structure name in the file **zeppelin-site.xml** by commenting out the next property:
+
+ ```
+ <property>
+ <name>zeppelin.notebook.azure.user</name>
+ <value>user</value>
+ <description>optional user name for Azure folder structure</description>
</property>
```