axl0/riko repository overview

⁠riko Docker Image

Docker image for the riko⁠ stream processing engine.

⁠Credits

Please read riko's license terms⁠ before using this Dockerfile.

⁠Documentation

riko is well documented:

• FAQ⁠
• COOKBOOK⁠
• Tutorial⁠
• examples⁠

⁠Usage

⁠Building

In order to build the image, you have to clone the repository.

git clone https://github.com/sfischer13/docker-riko
cd docker-riko

Then, build the Docker image. If you need additional Python packages for running your pipes, you should add them to requirements.txt before building the image.

make build

⁠Running

Before you can use riko, you have to build the image as described above.

Pipeline files must be made accessible by using Docker bind mounts⁠.

⁠Testing an example pipeline

Run demo.py from examples⁠:

docker run --rm -i \
sfischer13/riko:latest \
demo

⁠Using current directory

This will start the container and mount the current directory into the container. The pipeline definition, mypipe.py, has to be in this directory.

docker run --rm -i \
--mount type=bind,source="$PWD",target=/home/docker/ \
sfischer13/riko:latest \
mypipe.py

You could also use the full path to mypipe.py:

docker run --rm -i \
--mount type=bind,source="$PWD",target=/home/docker/ \
sfischer13/riko:latest \
/home/docker/mypipe.py

⁠Miscellaneous commands

For an overview of the container files, run the following command:

docker run --rm -i sfischer13/riko:latest --help

Open a shell within the container:

docker run --rm -i -t sfischer13/riko:latest -- bash