Notebook Storage

Zeppelin has a pluggable notebook storage mechanism controlled by zeppelin.notebook.storage configuration option with multiple implementations. There are few Notebook storages avaialble 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 S3 service - S3NotebookRepo

Multiple storages can be used at the same time by providing a comma-separated list of the calss-names in the confiruration. 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:

<property>
  <name>zeppelin.notebook.storage</name>
  <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value>
  <description>notebook persistence layer implementation</description>
</property>

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:

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>