Repository: incubator-zeppelin Updated Branches: refs/heads/master d9ddceb3a -> 81f02485b
add docs for notebook storage in S3 Author: Victor <[email protected]> Closes #392 from vgmartinez/docs_storage and squashes the following commits: 985c4e2 [Victor] add docs for notebook storage in S3 Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/81f02485 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/81f02485 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/81f02485 Branch: refs/heads/master Commit: 81f02485b31c25876a93a52a00b698ca60c9f8b9 Parents: d9ddceb Author: Victor <[email protected]> Authored: Thu Nov 5 11:19:39 2015 +0100 Committer: Lee moon soo <[email protected]> Committed: Mon Nov 9 21:36:11 2015 +0900 ---------------------------------------------------------------------- docs/docs/index.md | 3 ++ docs/docs/storage/storage.md | 68 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/81f02485/docs/docs/index.md ---------------------------------------------------------------------- diff --git a/docs/docs/index.md b/docs/docs/index.md index 11c35da..4eb9d95 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -31,6 +31,9 @@ group: nav-right * [spark](./interpreter/spark.html) * [tajo](../docs/pleasecontribute.html) +### Storage +* [S3 Storage](./storage/storage.html) + ### Display System * [text](./displaysystem/display.html) http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/81f02485/docs/docs/storage/storage.md ---------------------------------------------------------------------- diff --git a/docs/docs/storage/storage.md b/docs/docs/storage/storage.md new file mode 100644 index 0000000..c4855d2 --- /dev/null +++ b/docs/docs/storage/storage.md @@ -0,0 +1,68 @@ +--- +layout: page +title: "Storage" +description: "Notebook Storage option for Zeppelin" +group: storage +--- + +### Notebook Storage + +In Zeppelin there are two option for storage Notebook, by default the notebook is storage in the notebook folder in your local File System and the second option is S3. + +</br> +#### Notebook Storage in S3 + +For notebook storage in S3 you need the AWS credentials, for this there are three options, the enviroment variable ```AWS_ACCESS_KEY_ID``` and ```AWS_ACCESS_SECRET_KEY```, credentials file in the folder .aws in you home and IAM role for your instance. For complete the need steps is necessary: + +</br> +you need the following folder structure on S3 + +``` +bucket_name/ + username/ + notebook/ + +``` + +set the enviroment variable in the file **zeppelin-env.sh**: + +``` +export ZEPPELIN_NOTEBOOK_S3_BUCKET = bucket_name +export ZEPPELIN_NOTEBOOK_S3_USER = username +``` + +in the file **zeppelin-site.xml** uncommet and complete the next property: + +``` +<!--If used S3 to storage, it is necessary the following folder structure bucket_name/username/notebook/--> +<property> + <name>zeppelin.notebook.s3.user</name> + <value>username</value> + <description>user name for s3 folder structure</description> +</property> +<property> + <name>zeppelin.notebook.s3.bucket</name> + <value>bucket_name</value> + <description>bucket name for notebook storage</description> +</property> +``` + +uncomment the next property for use S3NotebookRepo class: + +``` +<property> + <name>zeppelin.notebook.storage</name> + <value>org.apache.zeppelin.notebook.repo.S3NotebookRepo</value> + <description>notebook persistence layer implementation</description> +</property> +``` + +comment the next property: + +``` +<property> + <name>zeppelin.notebook.storage</name> + <value>org.apache.zeppelin.notebook.repo.VFSNotebookRepo</value> + <description>notebook persistence layer implementation</description> +</property> +```
