Commit 39656cd5 authored by Daniele Venzano's avatar Daniele Venzano

Documentation update before release

parent b41c6b07
...@@ -6,6 +6,12 @@ ...@@ -6,6 +6,12 @@
* use JSON schemas to validate ZApps * use JSON schemas to validate ZApps
* Expand the execution list API, adding filtering capabilities to limit the number of results returned * Expand the execution list API, adding filtering capabilities to limit the number of results returned
* Several minor bug fixes * Several minor bug fixes
* Deployment scripts and zoe frontend moved to external repository for easier maintenance and testing
* Removed proxy code
* ZApps have been split into multiple repositories for easier maintenance, testing and automated building
* Tyk or Kong can be used to provide SSL termination and authentication to the API
* Documentation update
* A new script `create_db_tables.py` can be used to create the schema in an empty database, useful for CI scenarios
## Version 2017.03 ## Version 2017.03
......
...@@ -84,7 +84,7 @@ External resources ...@@ -84,7 +84,7 @@ External resources
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
- `Zoe Homepage <http://zoe-analytics.eu>`_ - `Zoe Homepage <http://zoe-analytics.eu>`_
- `ZApp catalog <http://zoe-analytics.eu/zapps>`_
- `Issue tracker <https://github.com/DistributedSystemsGroup/zoe/issues>`_ - `Issue tracker <https://github.com/DistributedSystemsGroup/zoe/issues>`_
- `ZApp repository <https://github.com/DistributedSystemsGroup/zoe-applications>`_
Zoe is licensed under the terms of the Apache 2.0 license. Zoe is licensed under the terms of the Apache 2.0 license.
...@@ -73,7 +73,7 @@ This means that you will also need a key-value store supported by Docker. We use ...@@ -73,7 +73,7 @@ This means that you will also need a key-value store supported by Docker. We use
Images: Docker Hub Vs local Docker registry Images: Docker Hub Vs local Docker registry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A few sample ZApps have their images available on the Docker Hub. We strongly suggest setting up a private registry, containing your customized Zoe Service images. Have a look at the `zoe-applications <https://github.com/DistributedSystemsGroup/zoe-applications>`_ repository for examples of Zoe Applications and Services that can be customized, built and loaded on the Hub or on a local registry. A few sample ZApps have their images available on the Docker Hub. We strongly suggest setting up a private registry, containing your customized Zoe Service images.
Zoe Zoe
--- ---
......
This diff is collapsed.
...@@ -3,9 +3,9 @@ ...@@ -3,9 +3,9 @@
ZApp format description ZApp format description
======================= =======================
This document refers to version 2 of the Zoe application description format. This document refers to version 3 of the Zoe application description format.
A Zoe application description is a JSON document. Currently we generate them via a set of python scripts available in the `zoe-applications <https://github.com/DistributedSystemsGroup/zoe-applications>`_ repository, but nothing prevents you generating JSON in some other way, obeying the format described here. A Zoe application description is a JSON document.
At the top level map there are some settings, mostly metadata, and a list of services. Each service has its own metadata and some docker-related parameters. At the top level map there are some settings, mostly metadata, and a list of services. Each service has its own metadata and some docker-related parameters.
......
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
"""Versions.""" """Versions."""
ZOE_VERSION = '2017.06-beta' ZOE_VERSION = '2017.06'
ZOE_API_VERSION = '0.7' ZOE_API_VERSION = '0.7'
ZOE_APPLICATION_FORMAT_VERSION = 3 ZOE_APPLICATION_FORMAT_VERSION = 3
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment