Feature Idea: JupyterHub/BinderHub + Jupyter Book as a publishing platform

ltetrel · November 10, 2021, 5:44pm

Some updates on that topic @choldgraf,

You can check here the latest developement:

First we have a bash file that is responsible for getting the proper metadata, if checks pass (config exists and/or book alreay built) the jupyter-book build process is launched.

github.com

neurolibre/terraform-binderhub/blob/99c253a06d21fb05be2335a5ad8a2e2101f0f056/terraform-modules/binderhub/assets/jb_build.bash

#!/bin/bash

# repo parameters
IFS='/'; BINDER_PARAMS=(${BINDER_REF_URL}); unset IFS;
PROVIDER_NAME=${BINDER_PARAMS[-5]}
USER_NAME=${BINDER_PARAMS[-4]}
REPO_NAME=${BINDER_PARAMS[-3]}
COMMIT_REF=${BINDER_PARAMS[-1]}
# paths
CONFIG_FILE="content/_config.yml"
BOOK_DST_PATH="/mnt/books/${USER_NAME}/${PROVIDER_NAME}/${REPO_NAME}/${COMMIT_REF}"
BOOK_BUILT_FLAG="${BOOK_DST_PATH}/successfully_built"
BOOK_BUILD_LOG="${BOOK_DST_PATH}/book-build.log"

# checking if book build is necessary
echo "Checking if jupyter book build will be done..."
if [ -f "${CONFIG_FILE}" ]; then
  echo -e "\t ${CONFIG_FILE} exists."
else
  echo -e "\t ${CONFIG_FILE} not found."

This file has been truncated. show original

This process lives just before a user starts his session, possible thanks to latest jupyterhub changes:

github.com

neurolibre/terraform-binderhub/blob/99c253a06d21fb05be2335a5ad8a2e2101f0f056/terraform-modules/binderhub/assets/config.yaml#L109-L116

    
      
          extraFiles:
            jb_build:
              mountPath: /usr/local/share/jb_build.bash
              mode: 0755
          lifecycleHooks:
            postStart:
              exec:
                command: ["bash", "/usr/local/share/jb_build.bash"]

The cluster can be then upgraded with:
sudo helm upgrade (...) --set-file jupyterhub.singleuser.extraFiles.jb_build.stringData=./jb_build.bash (...)

Hope that this will help!

PS: Ideally I would like to use an initContainer, but I cannot because of this binder url request accessible to hub singleuser initContainers · Issue #1429 · jupyterhub/binderhub · GitHub
Even better if this process is done just once after docker build https://github.com/jupyterhub/binderhub/pull/1081

Topic		Replies	Views
Feature idea: extension to simplify Binder publishing (lab>git>binder) JupyterLab	6	898	March 6, 2021
Feature idea: Jupyter Books as a landing page for hub log-ins JupyterHub feature-idea	17	2225	October 13, 2023
Request for early feedback on "JupyterHub Share Link" JupyterHub	23	3389	February 18, 2020
Curvenote: Scientific writing platform that connects to Jupyter Show and Tell	0	1215	February 17, 2021
Crowdsourcing for a blog: Cool Binder features Binder	3	1067	August 24, 2021

Feature Idea: JupyterHub/BinderHub + Jupyter Book as a publishing platform

Related topics