From f26c795c99d6ff7961c05c46628964e4c0ad747e Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Sat, 23 Jan 2021 19:15:57 +0100 Subject: [PATCH] Add warning --- README.md | 2 +- doc/Internals.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 04c08518..3df14464 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Non-goals include: - Extremely high performance - Complete implementation of the S3 API -- Erasure coding (our replication model is simply to copy the data as is on several nodes) +- Erasure coding (our replication model is simply to copy the data as is on several nodes, in different datacenters if possible) Our main use case is to provide a distributed storage layer for small-scale self hosted services such as [Deuxfleurs](https://deuxfleurs.fr). diff --git a/doc/Internals.md b/doc/Internals.md index dd982460..e712ae07 100644 --- a/doc/Internals.md +++ b/doc/Internals.md @@ -1,3 +1,5 @@ +**WARNING: this documentation is more a "design draft", which was written before Garage's actual implementation. The general principle is similar but details have not yet been updated.** + #### Modules - `membership/`: configuration, membership management (gossip of node's presence and status), ring generation --> what about Serf (used by Consul/Nomad) : https://www.serf.io/? Seems a huge library with many features so maybe overkill/hard to integrate