From 9a89af0fe3e2a95fed740717e1a51e85c24d1839 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Fri, 25 Nov 2022 11:49:35 +0100 Subject: [PATCH] Add basic Garage doc --- doc/garage.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 doc/garage.md diff --git a/doc/garage.md b/doc/garage.md new file mode 100644 index 0000000..f9eb3ae --- /dev/null +++ b/doc/garage.md @@ -0,0 +1,20 @@ +# Garage + +Our S3-compatible object storage service is based on [Garage][1]. + +Garage is running as a cluster, with one VM each on 3 different physical hosts +in 2 different zones (data centers). + +Replication mode is set to "2", meaning PUTs are always immediately synced to +nodes in 2 different zones (write/read consistency guaranteed by default). + +When all nodes in one zone become unavailable, the cluster is switching to +read-only mode automatically, since the write quorum cannot be reached in that +case. If it is necessary (in an emergency) to write to nodes in only one zone, +you can change the replication mode to "2-dangerous", which lowers the write +quorum to 1. + +Please refer to the [replication documentation][2] for more detailed information. + +[1]: https://garagehq.deuxfleurs.fr +[2]: https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#replication-mode