This repository provides tooling and workflow recommendations for storing, scheduling, and publishing notebooks.
Automatic Notebook Versioning
Every save of a notebook creates an immutable copy of the notebook on object storage.
To ease implementation, we'll rely on S3 as the object store, using versioned buckets.
All notebooks are archived to a single versioned S3 bucket with specific prefixes denoting the lifecycle of the notebook:
/workspace- where users edit
/published- public notebooks (to an organization)
Each notebook path is a namespace that an external service ties into the schedule. We archive off versions, keeping the path intact (until a user changes them).
||Notebook in “draft”|
||Current published copy|
Scheduled notebooks will also be referred to by the notebook key, though we'll need to be able to surface version Ids as well.
Transitioning to this Storage Plan
Since most people are on a regular filesystem, we'll start with writing to the
/workspace prefix as Archival Storage (writing on save using a
post_save_hook for a Jupyter contents manager).
# jupyter config # At ~/.jupyter/jupyter_notebook_config.py for user installs on macOS # See https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html for other places to plop this from bookstore import BookstoreContentsArchiver c.NotebookApp.contents_manager_class = BookstoreContentsArchiver c.BookstoreSettings.workspace_prefix = "/workspace/kylek/notebooks" c.BookstoreSettings.published_prefix = "/published/kylek/notebooks" # Optional, in case you're using a different contents manager # This defaults to notebook.services.contents.manager.ContentsManager c.BookstoreSettings.s3_bucket = "<bucket-name>" # Note: if bookstore is used from an EC2 instance with the right IAM role, you don't # have to specify these c.BookstoreSettings.s3_access_key_id = <AWS Access Key ID / IAM Access Key ID> c.BookstoreSettings.s3_secret_access_key = <AWS Secret Access Key / IAM Secret Access Key>