aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2021-01-23 19:15:57 +0100
committerAlex Auvolat <alex@adnab.me>2021-01-23 19:15:57 +0100
commitf26c795c99d6ff7961c05c46628964e4c0ad747e (patch)
treeb31c5f7a61426f75deba5394048e266947cd95ec
parent6f6bf23bec5690df683622cd90c50d5303f124db (diff)
downloadgarage-f26c795c99d6ff7961c05c46628964e4c0ad747e.tar.gz
garage-f26c795c99d6ff7961c05c46628964e4c0ad747e.zip
Add warning
-rw-r--r--README.md2
-rw-r--r--doc/Internals.md2
2 files changed, 3 insertions, 1 deletions
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