notebook-kernels-mixer

README

Notebook Kernels Mixer

This is an application specific reverse proxy for Jupyter notebooks.

It runs as a proxy in front of your locally running Jupyter notebook server, and enables easily switching between running kernels locally or remotely in Google Cloud Platform.

Disclaimer

This is not an officially supported Google product.

Overview

This tool runs as a proxy in front of your locally running Jupyter notebook server.

It intercepts requests to the kernelspecs, kernels, and sessions APIs and multiplexes them between the locally running Jupyter and remotely running Jupyter notebook servers in GCP.

Usage

Run the following commands on the same machine where you would normally run Jupyter.

These commands do three things:

1. Launch a locally-running Jupyter server that will be used just for running local kernels.
2. Launch the mixer binary provided by this repo that enables switching between local and remote kernels.
3. Run the main Jupyter server that you connect to, and which uses the mixer as its backend for running kernels either locally or remotely.

export MIXER_PORT=9991
export JUPYTER_BACKEND_PORT=9992
export JUPYTER_TOKEN="$(uuidgen)"

# Launch the locally running Jupyter notebook server for running local kernels.
jupyter lab --no-browser --port-retries=0 \
  --port="${JUPYTER_BACKEND_PORT}" \
  --NotebookApp.token="${JUPYTER_TOKEN}" &

# Launch the mixer reverse proxy.
mixer \
  --port="${MIXER_PORT}" \
  --mixer-project="${PROJECT}" \
  --mixer-region="${REGION}" \
  --jupyter-port="${JUPYTER_BACKEND_PORT}" \
  --jupyter-token="${JUPYTER_TOKEN}" &

# Launch the locally running Jupyter notebook server you will connect to...
jupyter lab \
  --GatewayClient.url="http://[::1]:${MIXER_PORT}/" \
  --GatewayClient.headers="{\"token\": \"${JUPYTER_TOKEN}\", \"Cookie\": \"_xsrf=XSRF\", \"X-XSRFToken\": \"XSRF\"}"

After that you can connect to the port the second Jupyter process is listening on (by default the value of the ServerApp.port configuration option) in order to use Jupyter while being able to easily switch any notebooks to running remotely in GCP.

How to run a local container for Kernel Mixer

# Change the following values.
PROJECT=""
REGION="us-central1"
MIXER_CONTAINER_NAME=notebook-kernels-mixer
MIXER_PORT=9991
JUPYTER_BACKEND_PORT=9992
JUPYTER_TOKEN=""
CONTAINER_URL=gcr.io/${PROJECT?}/${MIXER_CONTAINER_NAME?}:local

# Build your container locally.

docker build -t ${CONTAINER_URL} .

function start_mixer_client() {
  docker stop ${MIXER_CONTAINER_NAME}
  docker rm ${MIXER_CONTAINER_NAME}

  echo "Starting Mixer client"

  docker run -d \
    --env "MIXER_PORT=${MIXER_PORT}" \
    --env "PROJECT=${PROJECT}" \
    --env "REGION=${REGION}" \
    --env "JUPYTER_BACKEND_PORT=${JUPYTER_BACKEND_PORT}" \
    --env "JUPYTER_TOKEN=${JUPYTER_TOKEN}" \
    --net=host \
    --restart always \
    -v $HOME/.config/gcloud:/root/.config/gcloud \
    --name "${MIXER_CONTAINER_NAME}" \
    "${CONTAINER_URL}"
  RETVAL=$?
  if [[ "$RETVAL" -gt 0 ]]; then
    echo "Could not start Docker Mixer Agent"
  fi
  echo "Docker Mixer client started"
}

Limitations

• This proxy does not enforce any authentication or access controls beyond the optional --jupyter-token parameter.

  Due to that, it explicitly only listens on localhost because it should not be directly exposed to others.

  • If you wish to make this accessible remotely, or inside of a shared environment, then run another proxy in front of it that implements those protections, such as by running two layers of the Jupyter notebook server as shown in the usage section above.

• This requires you to have the gcloud command line tool installed, and to have logged into gcloud (e.g. by running gcloud auth login).

Documentation

Overview

Command mixer is a reverse proxy that enables switching between kernels running locally or remotely.

Prerequisites:

You must have Jupyter Lab installed on your workstation (i.e. the command `jupyter lab` should work).

Example usage:

export JUPYTER_PORT=8082
export JUPYTER_TOKEN="$(uuidgen)"
jupyter lab --no-browser --port-retries=0 --port="${JUPYTER_PORT}" --notebook-dir="${HOME}" --NotebookApp.token="${JUPYTER_TOKEN}" --debug &
mixer \
  --mixer-project="${PROJECT}" \
  --mixer-region="${REGION}" \
  --jupyter-port="${JUPYTER_PORT}" \
  --jupyter-token="${JUPYTER_TOKEN}"