Chainguard Container for jupyter-base-notebook

Minimal Jupyter base notebook image using pip

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/jupyter-base-notebook: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 not fully compatible with the base-notebook image from Jupyter.

The following are the key differences between Chainguard's base-notbook image and the image from Jupyter:

• The Chainguard Jupyter notebook image ships uses dependencies from PyPI, and does not include conda or mamba.
• The CMD of the Chainguard image is set to start-notebook.py and passing --ip=0.0.0.0 is required. If you want to use the image with default CMD or use a different CMD, overriding the current CMD is required.

docker run -d -p 8888:8888 cgr.dev/ORGANIZATION/jupyter-base-notebook:latest start-notebook.py --ip=x.y.z.a

Getting Started

Using the Docker Image Directly

To use Chainguard's Jupyter notebook image, run the following command in your project's directory:

docker run --rm --name=base-notebook -p 8888:8888 -v $(pwd):/home/jovyan cgr.dev/ORGANIZATION/jupyter-base-notebook:latest start-notebook.py --ip=0.0.0.0

You will need to retrieve the token from the logs of the container to access the Jupyter notebook. The logs will look like this:

docker logs base-notebook

. . .

[I 2025-01-02 07:12:43.241 ServerApp] Jupyter Server 2.15.0 is running at:
[I 2025-01-02 07:12:43.241 ServerApp] http://182b5e058be1:8888/lab?token=6901fcbf319446804d212326074998fcf240b34f9429012b
[I 2025-01-02 07:12:43.241 ServerApp]     http://127.0.0.1:8888/lab?token=6901fcbf319446804d212326074998fcf240b34f9429012b

You can then access the Jupyter notebook by visiting the given URL. For example: http://127.0.0.1:8888/lab?token=6901fcbf319446804d212326074998fcf240b34f9429012b.

Using the jupyterhub Helm Chart

Chainguard's jupyter-base-notebook image is also meant to be used as part of jupyterhub chart from JupyterHub's Helm chart repository.

To run it, override the singleuser image used in the chart, like so:

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

Where config.yaml contains:

singleuser:
  image:
    name: cgr.dev/ORGANIZATION/jupyter-base-notebook
    tag: latest

It is also possible to use the Chainguard jupyterhub-k8s-hub for the hub image:

hub:
  config:
    JupyterHub:
      db_url: /usr/local/etc/jupyterhub/jupyterhub.sqlite
  image:
    name: cgr.dev/ORGANIZATION/jupyterhub-k8s-hub
    tag: latest
singleuser:
  image:
    name: cgr.dev/ORGANIZATION/jupyter-base-notebook
    tag: latest

Documentation and Resources

For more information, please refer to the official documentation for using jupyter notebooks. You can also find more information in the Jupyter Docker Stacks documentation.

Lastly, for instructions on deploying jupyterhub chart from JupyterHub's Helm chart repository, please refer to the JupyterHub documentation.

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.