Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jose Luis Lucas committed Dec 11, 2018
1 parent da00993 commit 4625d18
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/advanced_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

## Overview

Besides the standalone example given in the [README](../README.md), QED are created to be a
production-ready cluster. Here you can find some detailed examples.
Besides the standalone example given in the [README](../README.md), QED is also designed
to be a production-ready cluster. Here you can find some detailed examples.

## QED cluster

In order to garantee reliability and High Availabity QED storage servers are
created around hashicorp's [raft](https://github.com/hashicorp/raft) implementation.
In order to guarantee reliability and high availabity, QED servers include
hashicorp's [raft](https://github.com/hashicorp/raft) consensus protocol implementation.
An architectural perspective can be found at [raft](architecture/raft.md) doc. file.

To have identified the leader beforehand, it is recommended to launch a server and then some
disposable followers.
To have identified the leader beforehand (demo purpose), launch first a single
cluster-ready server, and then some disposable followers.

### Starting cluster mode

Expand All @@ -30,8 +30,8 @@ go run main.go start \

### Starting two followers
```bash
CLUSTER_SIZE=2
for i in $(seq 1 $CLUSTER_SIZE); do
FOLLOWERS=2
for i in $(seq 1 $FOLLOWERS); do
go run main.go start \
-k my-key \
-p $(mktemp -d /var/tmp/demo.XXX) \
Expand Down

0 comments on commit 4625d18

Please sign in to comment.