JupyterHub Runbook#

This document provides information on how to administer our JupyterHub deployment.

Key Locations#



GitHub Repo

MOC Smaug




Our JupyterHub instance is managed by the Open Data Hub operator. Any changes should be made in the necessary files in git and redeployed (rather than manually editing OpenShift objects directly).

Upkeep and Administration#

JupyterHub includes an Admin tool that lets us manage users. In production, this tool can be reached here. Note that the members of the operate-first group have been added as jupyterhub_admins here. If you require admin access, make a pr adding yourself to this OCP group, it can be found here.

The admin tool will let you stop/start, delete, and access a user’s notebook server and can be very helpful for addressing issues that JupyterHub users may encounter.

Common Problems#

The following is a list of common issues we’ve encountered with JupyterHub and how to fix them.

Smoke Test#

Verify that the service is up and available by checking if you can access/login to the service endpoint. Verify that the page loads, that you can log in, and that you can spin up a notebook.

Insufficient disk space for notebook pod#

When a user runs out of disk space on their notebook pod, the pod will fail to start and give little indication to the user about why that’s happening. Follow steps here to determine if the user has, in fact, used up their storage quota.

If the user has run out of storage space, follow the steps here to increase their PVC size.

Custom Image not listed in Spawner UI#

Custom JupyterHub notebook images add libraries, and kernels to JupyterHub which users can spawn and use. The steps followed to create these custom images are documented here.

After adding the custom image to odh/base/jupyterhub/notebook-images if the images do not show up in the JH Spawner UI then ensure the following:

User unable to start server#

JupyterHub occasionally gets into a corrupted state where it thinks that the notebook pod for a user is running when it actually isn’t running. When the user tells JupyterHub to take the server down, they will either get stuck in an infinite loop or get an error saying that the pod isn’t running. The fix is as follows:

  1. Login as an Operate First admin user to the jupyterhub namespace

  2. Check to see if the user’s pod shows up in the list of running pods. If it does, delete it.

  3. Delete the jupyterhub pod. Do NOT delete the jupyterhub-db pod.

  4. Ask the user to login again. They should be able to spin up their notebook server.

JupyterHub unreachable despite pods being up#

JupyterHub can occasionally end up in a state where the main jupyterhub pod is unable to connect to the database. The logs will usually look like the following.

---> Running application from script (/opt/app-root/builder/run) ...
+ trap 'kill -TERM $PID' TERM INT
+ PID=37
+ wait 37
+ start-jupyterhub.sh
[I 2020-12-01 19:15:55.235 JupyterHub app:1673] Using Authenticator: oauthenticator.openshift.OpenShiftOAuthenticator-0.9.0dev
[I 2020-12-01 19:15:55.235 JupyterHub app:1673] Using Spawner: builtins.OpenShiftSpawner
[D 2020-12-01 19:15:55.236 JupyterHub app:1625] Could not load pycurl: No module named 'pycurl'
    pycurl is recommended if you have a large number of users.
[D 2020-12-01 19:15:55.237 JupyterHub app:1071] Connecting to db: postgresql://jupyterhub:<password>@jupyterhub-db:5432/jupyterhub
/opt/app-root/lib/python3.6/site-packages/psycopg2/__init__.py:144: UserWarning: The psycopg2 wheel package will be renamed from release 2.8; in order to keep installing from binary please use "pip install psycopg2-binary" instead. For details see: <http://initd.org/psycopg/docs/install.html#binary-install-from-pypi> .
[D 2020-12-01 19:15:55.283 JupyterHub orm:685] database schema version found: 896818069c98
[I 2020-12-01 19:15:55.340 JupyterHub app:1201] Not using whitelist. Any authenticated user will be allowed.

------ nothing else after the above lines

The issue can be resolved by restarting both pods.

“No Kernel” or “Error Starting Kernel” errors#

If the user is encountering issues starting their server and encounter errors pertaining to their Kernel, they can try restarting their Kernel by following steps here.

Unable to spawn server with “username exceeded quota” error#

Jupyterhub can fail to spawn with an error message such as the following when the resource limits on the Jupyterhub namespace gets capped.

pods \"jupyterhub-nb-username\" is forbidden: exceeded quota: opf-jupyterhub-custom, requested: limits.cpu=3, used: limits.cpu=120, limited: limits.cpu=120"

To solve that, the cpu and memory limits on the jupyterhub namespace can be increased. You can do that by adding a PR here and increasing the limits.