General Concepts:
Components:
Features:
Configuration:
HowTo's:
—-
API's:
Client Applications:
Testing:
Functionality:
Table of ContentsAboutThis readme file explains how you can build and publish the artifacts on our nebulastream docker hub repository. Currently, we have three images in our repository: a build image used by GitHub-CI, a dev-image for using with IDE, and an executable-image used for running a standalone-cluster within the docker image. (Note: Please make sure you have the right to publish images in the DockerHub nebulastream organization.) Images and DockerfilesWe have three docker files in our source repository, one for each docker image, listing build instructions for preparing docker images. In case you want to add or modify any dependencies in the docker image please edit the corresponding docker file. Dockerfile-NES-Build
This is the docker image for our CI builds. There is no way to connect to a running container of this image,
aside from
The Dockerfile-NES-Dev
This image is based on NES-Build-image. Additionally, we have added a set of connectivity and interactivity tools to this image.
It has everything installed that we need for development, including
Currently, there is no need for an Dockerfile-NES-Executable
The Executable image is based on the Build image. There is no way to connect to a running container of this image, aside from
The Changing running behavior of imagesIf you want to change the startup behavior of the docker images, please change the corresponding entrypoint script. How to run docker imageFirst, you need to install docker. You further find an introduction to the docker concepts and useful tutorials on the linked webpage.
In general, it does not matter from which directory you are entering the following commands. Depending on how your docker is set up, you might need to run docker commands with (1) This command pulls the latest nes-executable-image from the registry.
Note: You need to delete this image before the next pull, else it is not updated: (2) This command runs the nebulastream image downloaded from the registry
or this additionally mounts the Nebulastream codebase into the container, accessible via /nebulastream, in the Development image:
Where (3) This command shows the running containers with their images and names.
(4) This command shows and updates the logs of the running container <container_name>.
(5) This command will get you into the terminal of the container, the rest is set for work.
(6) This command stops the container <container_name>.
(7) This command removes the container <container_name>.
Build imagesPlease execute the following command for building the build image locally:
and
The image types have been explained.
For Publish imagesThis section describes, how to publish the image to docker repository. First, please login into your docker account locally by executing :
(Note: it is important for you to have access to nebulastream docker hub organization for further steps) Afterwards, one can execute
Where
and
The image types have been explained.
For |