README.rst 2.03 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:

Daniele Venzano's avatar
Daniele Venzano committed
8 9 10 11
- Main website: http://zoe-analytics.eu
- Documentation: http://docs.zoe-analytics.eu
- How to install: http://docs.zoe-analytics.eu/en/latest/install.html
- Project roadmap: https://github.com/DistributedSystemsGroup/zoe/wiki
12

Daniele Venzano's avatar
Daniele Venzano committed
13
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.
14

15 16 17
Other Zoe resources:

- Zoe applications: https://github.com/DistributedSystemsGroup/zoe-applications
Daniele Venzano's avatar
Daniele Venzano committed
18
- Development and API documentation: http://docs.zoe-analytics.eu/en/latest/developer/index.html
19 20


Daniele Venzano's avatar
Daniele Venzano committed
21 22 23
A note on releases and the master branch
----------------------------------------
The Zoe master branch is tested before being published and only commits that pass the tests are published on this repository. A description of the CI pipeline is here: http://docs.zoe-analytics.eu/en/latest/quality.html
24

Daniele Venzano's avatar
Daniele Venzano committed
25
Official releases are tagged with their version number in the repository and changes for each released version are summarised in the `ChangeLog https://github.com/DistributedSystemsGroup/zoe/blob/master/CHANGELOG.md`_ file.
26

27 28 29 30 31 32 33
Repository contents
-------------------

- `contrib`: supervisord config files
- `docs`: Sphinx documentation
- `scripts`: Scripts used to test Zoe images outside of Zoe
- `zoe_cmd`: Command-line client
34
- `zoe_lib`: Client-side library, contains also some modules needed by the observer and the master processes
Daniele Venzano's avatar
Daniele Venzano committed
35
- `zoe_master`: The core of Zoe, the server process that listens for client requests and creates the containers on Swarm
36
- `zoe_api`: The web client interface
37

Daniele Venzano's avatar
Daniele Venzano committed
38
|Documentation Status|
39 40 41 42 43

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