README.rst 1.83 KB
Newer Older
1 2 3
Zoe - Container-based Analytics as a Service
============================================

4 5
Zoe provides a simple way to provision data analytics applications using Docker Swarm.

6 7
Resources:

8 9
-  Main website: http://zoe-analytics.eu
-  Documentation: http://docs.zoe-analytics.eu
10
-  How to install: http://zoe-analytics.readthedocs.org/en/latest/install.html
11

Daniele Venzano's avatar
Daniele Venzano committed
12
Zoe applications can be easily created by users, we provide several examples in the `zoe-applications https://github.com/DistributedSystemsGroup/zoe-applications`_ repository to get you started.
13

14 15 16 17 18 19 20
Repository contents
-------------------

- `contrib`: supervisord config files
- `docs`: Sphinx documentation
- `scripts`: Scripts used to test Zoe images outside of Zoe
- `zoe_cmd`: Command-line client
21
- `zoe_lib`: Client-side library, contains also some modules needed by the observer and the master processes
22
- `zoe_logger`: Optional Kafka producer for Docker container logs
23
- `zoe_observer`: The Observer process that monitors Swarm and informs the master of various events
Daniele Venzano's avatar
Daniele Venzano committed
24
- `zoe_master`: The core of Zoe, the server process that listens for client requests and creates the containers on Swarm
25 26 27
- `zoe_web`: The web client interface

|Travis build| |Documentation Status| |Requirements Status|
28 29 30 31 32

Zoe is licensed under the terms of the Apache 2.0 license.

.. |Documentation Status| image:: https://readthedocs.org/projects/zoe-analytics/badge/?version=latest
   :target: https://readthedocs.org/projects/zoe-analytics/?badge=latest
33 34 35 36
.. |Requirements Status| image:: https://requires.io/github/DistributedSystemsGroup/zoe/requirements.svg?branch=master
   :target: https://requires.io/github/DistributedSystemsGroup/zoe/requirements/?branch=master
   :alt: Requirements Status
.. |Travis build| image:: https://travis-ci.org/DistributedSystemsGroup/zoe.svg
37
   :target: https://travis-ci.org/DistributedSystemsGroup/zoe