niicloudoperation/notebook

Jupyter Notebook：可重现基础设施的文字计算

镜像概述和主要用途

本镜像提供一个Jupyter Notebook服务器，捆绑了一套用于“可重现基础设施的文字计算”的工具集。它展示了如何在Jupyter图形界面中实现稳健可靠的操作流程，而非仅用于探索性流程。

文字计算工具的目标包括：

• 防止误操作：单元格执行后“冻结”以避免意外重复执行，还可“锁定”单元格防止意外修改
• 提供文档视角：Markdown层级可折叠，下方嵌入的单元格以点表示，点击即可作为常规流程运行
• 支持协作注释：在Jupyter Notebook上添加协作注释，使想法和交流保持上下文并逐步完善

核心功能和特性

• 基础环境：Jupyter Notebook 6.0.x
• 内核支持：Python3和bash内核，集成LC_wrapper（https://github.com/NII-cloud-operation/Jupyter-LC_wrapper%EF%BC%89
• 扩展插件：
  • multi_outputs（https://github.com/NII-cloud-operation/Jupyter-multi_outputs%EF%BC%89
  • run_through（https://github.com/NII-cloud-operation/Jupyter-LC_run_through%EF%BC%89
  • nblineage（https://github.com/NII-cloud-operation/Jupyter-LC_nblineage%EF%BC%89
  • index（https://github.com/NII-cloud-operation/Jupyter-LC_index%EF%BC%89
  • sidestickies（https://github.com/NII-cloud-operation/sidestickies%EF%BC%89
  • nbsearch（https://github.com/NII-cloud-operation/nbsearch%EF%BC%89

使用场景和适用范围

适用于需要构建可重现基础设施操作流程的场景，包括但不限于：

• 运维操作文档化与自动化
• 基础设施配置流程的标准化
• 团队协作的操作指南编写
• 需要防止误操作的关键流程管理
• 操作过程的可追溯与注释记录

详细使用方法和配置说明

基本使用

使用以下命令在8888端口启动Notebook服务器：

bash
docker run -it --rm -p 8888:8888 niicloudoperation/notebook

通过启动消息中的认证令牌登录Notebook服务器。

使用NBSearch

若要使用https://github.com/NII-cloud-operation/nbsearch%EF%BC%8C%E9%9C%80%E9%85%8D%E5%90%88Solr%E5%AE%B9%E5%99%A8%EF%BC%9A

bash
# 启动Solr
git clone https://github.com/NII-cloud-operation/nbsearch /tmp/nbsearch
docker run -d --name nbsearch-solr -v /tmp/nbsearch:/tmp/nbsearch --rm solr:8 \
    bash -c "precreate-core jupyter-notebook /tmp/nbsearch/solr/jupyter-notebook/ && \
        precreate-core jupyter-cell /tmp/nbsearch/solr/jupyter-cell/ && \
        solr-foreground"

# 启动MinIO
docker run -d --rm -e MINIO_ACCESS_KEY=nbsearchak -e MINIO_SECRET_KEY=nbsearchsk \
    --name nbsearch-minio minio/minio:latest server /data --compat

# 启动Notebook
docker run -it --rm --link nbsearch-solr:solr --link nbsearch-minio:minio \
    -e NBSEARCHDB_SOLR_BASE_URL=http://solr:8983 -e NBSEARCHDB_S3_ENDPOINT_URL=http://minio:9000 \
    -e NBSEARCHDB_S3_ACCESS_KEY=nbsearchak -e NBSEARCHDB_S3_SECRET_KEY=nbsearchsk \
    -p 8888:8888 niicloudoperation/notebook

启用NBSearch扩展，请参考容器内的03_Notebookの検索.ipynb文档。

Docker选项

可通过以下可选参数自定义容器和Notebook服务器的执行：

• -e lc_wrapper_force=on - 强制启用lc_wrapper的摘要模式（通过环境变量）
• -e TZ=JST-9 - 指定容器时区
• -e PASSWORD=MY_UNBREAKABLE_PASS - 设置初始密码
• -v /some/host/folder/for/work:/home/jovyan - 将主机目录挂载到容器内的工作目录

使用sidestickies

通过以下任一方式使用https://github.com/NII-cloud-operation/sidestickies%EF%BC%9A

使用Scrapbox（[*]

• 添加环境变量：-e SIDESTICKIES_SCRAPBOX_PROJECT_ID=value -e SIDESTICKIES_SCRAPBOX_COOKIE_CONNECT_SID=value，指定Scrapbox账户
• 通过Nbextensions标签启用sidestickies扩展

  注意：需同时启用"文件树的Sidestickies"和"Notebook的Sidestickies"扩展

**使用ep_weave(Etherpad)（https://github.com/NII-cloud-operation/ep_weave%EF%BC%89**%EF%BC%9A

• 添加环境变量：-e SIDESTICKIES_EP_WEAVE_URL=http://ep_weave:9001 -e SIDESTICKIES_EP_WEAVE_API_KEY=YOUR_ETHERPAD_APIKEY
• 通过Nbextensions标签启用sidestickies扩展

  注意：需同时启用"文件树的Sidestickies"和"Notebook的Sidestickies"扩展

使用NBSearch

通过Nbextensions标签启用NBSearch扩展，页面重载后Jupyter页面将出现NBSearch标签。

NBSearch使用Solr和S3兼容存储来存储和搜索Notebook，需设置以下环境变量配置：

• -e NBSEARCHDB_SOLR_BASE_URL=your_solr_url - Solr基础URL（默认：http://localhost:8983）
• -e NBSEARCHDB_SOLR_BASIC_AUTH_USERNAME=your_solr_username、-e NBSEARCHDB_SOLR_BASIC_AUTH_PASSWORD=your_solr_password - Solr用户名和密码（如需）
• -e NBSEARCHDB_S3_ENDPOINT_URL=your_database_name - S3 URL（默认：http://localhost:9000）
• -e NBSEARCHDB_S3_ACCESS_KEY=your_s3_access_key、-e NBSEARCHDB_S3_SECRET_KEY=your_s3_secret_key - S3访问密钥和密钥（必填）
• -e NBSEARCHDB_S3_REGION_NAME=your_s3_region_name - S3区域名称（如需）
• -e NBSEARCHDB_S3_BUCKET_NAME=your_s3_bucket_name - S3存储桶名称（必填）
• -e NBSEARCHDB_SOLR_NOTEBOOK=your_solr_notebook_core - Solr的Notebook核心（默认：jupyter-notebook）
• -e NBSEARCHDB_SOLR_CELL=your_solr_cell_core - Solr的单元格核心（默认：jupyter-cell）
• -e NBSEARCHDB_BASE_DIR=your_notebook_home_dir - 可搜索的Notebook目录（默认：/home/$NB_USER）
• -e NBSEARCHDB_MY_SERVER_URL=your_notebook_server_url - 服务器URL，用于标识本服务器上的Notebook（默认：http://localhost:8888/）
• -e NBSEARCHDB_AUTO_UPDATE=1 - 启动lsyncd进程，当本地文件更新时自动更新Solr索引
• -e NBSEARCHDB_UPDATE_INDEX_OPT - lsyncd进程调用update-index NBSearch命令时的选项

使用NBWhisper

通过Nbextensions标签启用NBWhisper扩展（https://github.com/NII-cloud-operation/nbwhisper%EF%BC%89%E3%80%82

使用NBWhisper需Shiguredo's Sora Cloud服务的API密钥，设置以下环境变量：

• -e NBWHISPER_SIGNALING_URL=your_signaling_url - 信令服务器URL
• -e NBWHISPER_SORA_API_KEY=your_api_key - 信令服务器API密钥
• -e NBWHISPER_CHANNEL_ID_PREFIX=your_channel_id_prefix - WebRTC SFU使用的频道ID前缀
• -e NBWHISPER_CHANNEL_ID_SUFFIX=your_channel_id_suffix - WebRTC SFU使用的频道ID后缀
• -e NBWHISPER_SHARE_CURRENT_TAB_ONLY=1 - 若为true，仅共享当前标签页

（已弃用）使用SkyWay服务

使用NBWhisper需SkyWay（WebRTC）服务的API令牌，通过以下环境变量指定：

注意：此扩展与新SkyWay服务不兼容，仅支持旧版。可从旧版SkyWay管理页面获取API令牌（[***]

• -e NBWHISPER_SKYWAY_API_TOKEN - SkyWay的API令牌
• -e NBWHISPER_ROOM_MODE_FOR_WAITING_ROOM - 等候室的房间模式（输入"sfu"或"mesh"）
• -e NBWHISPER_ROOM_MODE_FOR_TALKING_ROOM - 谈话室的房间模式（输入"sfu"或"mesh"）