druid/examples/quickstart/jupyter-notebooks/docker-jupyter
Sergio Ferragut 353f7bed7f
Adding data generation pod to jupyter notebooks deployment (#14742)
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
2023-08-10 15:43:05 -07:00
..
README.md Docs: Tutorial for streaming ingestion using Kafka + Docker file to use with Jupyter tutorials (#13984) 2023-05-15 15:20:52 -07:00
docker-compose-local.yaml Adding data generation pod to jupyter notebooks deployment (#14742) 2023-08-10 15:43:05 -07:00
docker-compose.yaml Adding data generation pod to jupyter notebooks deployment (#14742) 2023-08-10 15:43:05 -07:00
environment Adding data generation pod to jupyter notebooks deployment (#14742) 2023-08-10 15:43:05 -07:00
tutorial-jupyter-docker.zip Docs: Updates docker compose to turn off kraft which causes errors (#14335) 2023-05-24 09:33:32 -07:00

README.md

Jupyter in Docker

For details on getting started with Jupyter in Docker, see Docker for Jupyter Notebook tutorials.

Contributing

Rebuild Jupyter image

You may want to update the Jupyter image to access new or updated tutorial notebooks, include new Python packages, or update configuration files.

To build the custom Jupyter image locally:

  1. Clone the Druid repo if you haven't already.

  2. Navigate to examples/quickstart/jupyter-notebooks in your Druid source repo.

  3. Edit the image definition in Dockerfile.

  4. Navigate to the docker-jupyter directory.

  5. Generate the new build using the following command:

    DRUID_VERSION=25.0.0 docker compose --profile all-services -f docker-compose-local.yaml up -d --build
    

    You can change the value of DRUID_VERSION or the profile used from the Docker Compose file.

Update Docker Compose

The Docker Compose file defines a multi-container application that allows you to run the custom Jupyter Notebook container, Apache Druid, and Apache Kafka.

Any changes to docker-compose.yaml should also be made to docker-compose-local.yaml and vice versa. These files should be identical except that docker-compose.yaml contains an image attribute while docker-compose-local.yaml contains a build subsection.

If you update docker-compose.yaml, recreate the ZIP file using the following command:

zip tutorial-jupyter-docker.zip docker-compose.yaml environment