jupyterhub-k8s-singleuser-sample

packaged by Chainguard

Chainguard Container for jupyterhub-k8s-singleuser-sample

Sample JupyterLab single-user notebook server for zero-to-jupyterhub-k8s

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/jupyterhub-k8s-singleuser-sample:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image is a drop-in replacement for the upstream quay.io/jupyterhub/k8s-singleuser-sample image. It matches upstream's runtime identity: it runs as the non-root jovyan user (UID 1000, primary GID 1000, group jovyan), which is also a member of the users group (GID 100, the JupyterHub Helm chart's fsGid), from the working directory /home/jovyan. The default entrypoint is /sbin/tini -- and the default command is jupyter lab; the notebook server listens on port 8888.

Two differences from upstream are worth noting:

The environment matches what upstream sets — HOME, NB_USER, NB_UID, and LANG=C.UTF-8 — with SHELL=/bin/bash the only Chainguard addition. JUPYTER_PORT, LANGUAGE, LC_ALL, and NB_GID are not set: they were leftovers copied from the jupyter-base-notebook image template, not upstream env (JUPYTER_PORT in particular is inert — jupyter lab defaults to port 8888).

The server writes its configuration and runtime state under HOME (/home/jovyan), so it needs a writable root filesystem or a volume mounted there. The JupyterHub Helm chart handles this automatically; when running the container directly, keep the default writable rootfs.

Usage

jupyterhub-k8s-singleuser-sample is the sample single-user notebook server image from the zero-to-jupyterhub-k8s project. It runs JupyterLab and is normally spawned per user by JupyterHub rather than run directly — JupyterHub injects the server configuration and API token at spawn time.

Using the jupyterhub Helm Chart

Deploy it as the singleuser image of the JupyterHub Helm chart:

helm repo add jupyterhub https://hub.jupyter.org/helm-chart/
helm repo update
helm upgrade --install jupyterhub jupyterhub/jupyterhub --values values.yaml

Where values.yaml points the chart's single-user image at this container (optionally pairing it with the Chainguard jupyterhub-k8s-hub image for the hub):

hub:
  image:
    name: cgr.dev/ORGANIZATION/jupyterhub-k8s-hub
    tag: latest
singleuser:
  image:
    name: cgr.dev/ORGANIZATION/jupyterhub-k8s-singleuser-sample
    tag: latest

Running the notebook server directly

For a quick local smoke test you can run the server outside of JupyterHub. Bind it to all interfaces and read the login token from the logs:

docker run --rm -d --name singleuser-sample -p 8888:8888 \
  cgr.dev/ORGANIZATION/jupyterhub-k8s-singleuser-sample:latest \
  jupyter lab --ServerApp.ip=0.0.0.0

The container runs in the background (-d), so read the login token from its logs:

docker logs singleuser-sample

[I ServerApp] Jupyter Server ... is running at:
[I ServerApp] http://<container>:8888/lab?token=<token>

You can then open the notebook at the printed URL, for example http://127.0.0.1:8888/lab?token=<token>.

Documentation and Resources

• zero-to-jupyterhub-k8s (single-user server sample)
• JupyterLab documentation
• Deploying JupyterHub on Kubernetes (Zero to JupyterHub)

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.