Merge pull request #131 from aalda/rtdocs

Rtdocs

.gitignore

@@ -34,6 +34,7 @@ TODO.md
 
 # User Documentation builds
 rtd_docs/build/
+rtd_docs/source/_build/
 
 # Custom editor or IDE project settings
 .idea
@@ -57,3 +58,4 @@ deploy/aws/modules/*/data
 
 # Ansible
 !deploy/provision/tasks/common/config.yml
+rtd_docs/venv

README.rst

@@ -1,5 +1,5 @@
 ********************************************************************
-Q.E.D. - Scalable, auditable and high-performance tamper-evident log
+QED - Scalable, auditable and high-performance tamper-evident log
 ********************************************************************
 
 .. image:: https://readthedocs.org/projects/qed/badge/?version=latest
@@ -23,22 +23,22 @@ Q.E.D. - Scalable, auditable and high-performance tamper-evident log
 .. figure:: https://raw.githubusercontent.com/BBVA/qed/master/rtd_docs/source/_static/images/qed_logo_small.png
    :align: center
 
-What's Q.E.D.
--------------
-
-``Q.E.D.`` is an open-source software that allows you to establish **trust relations with others**. It can be used in multiple scenarios:
+**QED** is an open-source software that allows you to establish
+**trust relations** by leveraging verifiable cryptographic proofs.
 
-- **Secure tamper-evident data transfers**,
-- **Tamper-evident** (system/application/business)
-- **Logging**
-- ...
+It can be used in multiple scenarios:
 
-``Q.E.D.`` **guarantees** that the system itself, even when deployed **into a non-trusted server**, cannot be modified without being detected. It also **provides verifiable cryptographic proofs** in logarithmic relation (time and size) to the number of entries.
+- Data transfers.
+- System (or application or business) logging.
+- Distributed business transactions.
+- Etc.
 
-Why Q.E.D.
-----------
+QED **guarantees** that the system itself, even when deployed
+into a **non-trusted server**, cannot be modified without being
+detected. It also provides **verifiable cryptographic proofs**
+in logarithmic relation (time and size) to the number of entries.
 
-``Q.E.D.`` is **scalable**, **resilient** and **ops friendly**:
+QED is **scalable**, **resilient** and **ops friendly**:
 
 - Designed to manage **billions of events** per shard
 - Over **2000 operations per second** per shard under sustained load
@@ -59,12 +59,12 @@ You can find the project code at `Github <https://github.com/BBVA/qed>`_
 Authors
 -------
 
-``Q.E.D.`` was made by Hyperscale BBVA-Labs Team.
+QED was made by Hyperscale BBVA-Labs Team.
 
 License
 -------
 
-``Q.E.D.`` is Open Source and available under the `Apache 2 license <https://github.com/BBVA/qed/blob/master/LICENSE>`_.
+QED is Open Source and available under the `Apache 2 license <https://github.com/BBVA/qed/blob/master/LICENSE>`_.
 
 Contributions
 -------------

deploy/docker/docker-compose.yml

@@ -0,0 +1,53 @@
+version: '3'
+services:
+  qed_server_0:
+    image: "bbvalabs/qed:v0.2.4-docs"
+    container_name: qed_server_0
+    ports:
+      - "8800:8800"   # API HTTP
+      - "8700:8700"   # Management
+      - "8600:8600"   # Metrics
+      - "8500:8500"   # Raft
+      - "8400:8400"   # Gossip
+#      - "6060:6060"   # Profiling
+    entrypoint: [
+      "qed", "server", "start",
+      "--api-key", "my-key",
+      "--http-addr", "qed_server_0:8800",
+      "--mgmt-addr", "qed_server_0:8700",
+      "--metrics-addr", "qed_server_0:8600",
+      "--raft-addr", "qed_server_0:8500",
+      "--gossip-addr", "qed_server_0:8400",
+      "--node-id", "server0",
+      "--private-key-path", "/var/tmp/qed_ed25519",
+      "--raft-path", "/var/tmp/qed0/wal",
+      "--db-path", "/var/tmp/qed0/db",
+      "--log", "info",
+    ]
+
+  publisher:
+    image: "bbvalabs/qed:v0.2.4-docs"
+    container_name: publisher
+    ports:
+      - "8100:8100"   # API HTTP
+      - "18100:18100" # Metrics
+    entrypoint: [
+      "qed", "agent", "publisher",
+      "--bind-addr", "publisher:8100",
+      "--metrics-addr", "publisher:18100",
+      "--start-join", "qed_server_0:8400",
+      "--notifier-endpoint", "http://snapshotstore:8888/alert",
+      "--store-endpoint", "http://snapshotstore:8888",
+      "--role", "publisher",
+      "--node-name", "publisher0",
+      "--log", "info",
+    ]
+    restart: on-failure
+
+  snapshotstore:
+    image: "bbvalabs/qed:v0.2.4-docs"
+    container_name: snapshot_store
+    ports:
+      - "8888:8888"   # API HTTP
+    entrypoint:
+      - /usr/local/bin/storage