/nebari-docker-images

๐Ÿ“ฆ Ready to use Docker images maintained by the Nebari team

Primary LanguageShellBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Nebari logo mark - text will be black in light color mode and white in dark color mode.


Nebari base Docker images

Information Links
Project License - BSD3 License badge Nebari documentation badge - nebari.dev
Community GH discussions badge Open a GH issue badge
CI Build Docker Images - GitHub action status badge

This repository contains the source code for Docker (container) images used by the Nebari platform. It also contains an automated means of building and pushing these images to public container registries through GitHub actions. Currently, these images are built and pushed to the following registries:

GitHub Container Registry (ghcr.io)

Quay Container Registry (quay.io)

Getting started โšก๏ธ

Whether you want to contribute to this project or whether you wish use these images, to get started, fork this repo and then clone the forked repo onto your local machine.

Prerequisites ๐Ÿ’ป

Building the Docker images ๐Ÿ› 

From the repository's root folder, you can build these images locally by running the listed commands on your terminal.

  • For JupyterLab:

    docker build -f Dockerfile.jupyterlab \
        -t nebari-jupyterlab:latest .
  • For JupyterHub:

    docker build -f Dockerfile.jupyterhub \
        -t nebari-jupyterhub:latest .
  • For Dask-Worker:

    docker build -f Dockerfile.dask-gateway \
        -t nebari-dask-gateway:latest .

NOTE It is extremely important to pin specific packages dask-gateway and distributed as they need to run the same version for the dask-workers to work as expected.

Pre-commit hooks ๐Ÿงน

This repository uses the prettier pre-commit hook to standardize our YAML and markdown structure. To install and run it, use these commands from the repository root:

# install the pre-commit hooks
pre-commit install

# run the pre-commit hooks
pre-commit run --all-files

Reporting an issue ๐Ÿ“

If you encounter an issue or want to make suggestions on how we can make this project better, feel free to open an issue on this repository's issue tracker.

Contributions ๐Ÿค

Thinking about contributing to this repository or any other in the Nebari org? Check out our Contribution Guidelines.

License ๐Ÿ“„

Nebari is BSD3 licensed.