aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/intro.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book/src/intro.md')
-rw-r--r--doc/book/src/intro.md59
1 files changed, 16 insertions, 43 deletions
diff --git a/doc/book/src/intro.md b/doc/book/src/intro.md
index 746f4d6a..10f9c0a2 100644
--- a/doc/book/src/intro.md
+++ b/doc/book/src/intro.md
@@ -15,60 +15,37 @@
# Data resiliency for everyone
-OLD
-
-Garage is a lightweight geo-distributed data store that implements the
-[Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)
-object storage protocole. It enables applications to store large blobs such
-as pictures, video, images, documents, etc., in a redundant multi-node
-setting. S3 is versatile enough to also be used to publish a static
-website.
-
-Garage comes from the observation that despite the numerous existing
-implementation of object stores, many people have broken data management
-policies (backup/replication on a single site or none at all). To promote
-better data management policies, we focused on the following **desirable
-properties**:
-
-Non-goals:
-
- - **Extreme performances**: high performances constrain a lot the design and the infrastructure; we seek performances through minimalism only.
- - **Feature extensiveness**: complete implementation of the S3 API or any other API to make Garage a drop-in replacement is not targeted as it could lead to decisions impacting our desirable properties.
- - **Storage optimizations**: erasure coding or any other coding technique both increase the difficulty of placing data and synchronizing; we limit ourselves to duplication.
- - **POSIX/Filesystem compatibility**: we do not aim at being POSIX compatible or to emulate any kind of filesystem. Indeed, in a distributed environment, such synchronizations are translated in network messages that impose severe constraints on the deployment.
-
-Use-cases:
-
-- **[Deuxfleurs](https://deuxfleurs.fr):** Garage is used by Deuxfleurs which
- is a non-profit hosting organization. Especially, it is used to host their
- main website, this documentation and some of its members' blogs.
- Deuxfleurs also uses Garage as their [Matrix's media
- backend](https://github.com/matrix-org/synapse-s3-storage-provider).
- Deuxfleurs also uses it in its continuous integration platform to store
- Drone's job logs and a Nix binary cache.
-
-ENDOLD
-
-
-Garage is an **open-source** distributed **storage service** you can **self-host** to fullfill many needs.
+Garage is an **open-source** distributed **storage service** you can **self-host** to fullfill many needs:
<p align="center" style="text-align:center; margin-bottom: 5rem;">
<img alt="Summary of the possible usages with a related icon: host a website, store media and backup target" src="img/usage.svg" />
</p>
-Garage implements the **[Amazon S3 API](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)** and thus is already **compatible** with many applications.
+<p align="center" style="text-align:center; margin-bottom: 5rem;">
+<a href="/design/use_cases.html">⮞ learn more about use cases ⮜</a>
+</p>
+
+Garage implements the **[Amazon S3 API](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)** and thus is already **compatible** with many applications:
<p align="center" style="text-align:center; margin-bottom: 8rem;">
<img alt="Garage is already compatible with Nextcloud, Mastodon, Matrix Synapse, Cyberduck, RClone and Peertube" src="img/software.svg" />
</p>
+<p align="center" style="text-align:center; margin-bottom: 5rem;">
+<a href="/connect/index.html">⮞ learn more about integrations ⮜</a>
+</p>
+
-Garage provides **data resiliency** by **replicating** data 3x over **distant** servers.
+Garage provides **data resiliency** by **replicating** data 3x over **distant** servers:
<p align="center" style="text-align:center; margin-bottom: 5rem;">
<img alt="An example deployment on a map with servers in 5 zones: UK, France, Belgium, Germany and Switzerland. Each chunk of data is replicated in 3 of these 5 zones." src="img/map.svg" />
</p>
+<p align="center" style="text-align:center; margin-bottom: 5rem;">
+<a href="/design/index.html">⮞ learn more about our design ⮜</a>
+</p>
+
Did you notice that *this website* is hosted and served by Garage?
## Keeping requirements low
@@ -79,6 +56,7 @@ We worked hard to keep requirements as low as possible as we target the largest
* **RAM:** 1GB
* **Disk Space:** at least 16GB
* **Network:** 200ms or less, 50 Mbps or more
+ * **Heterogeneous hardware:** build a cluster with whatever second-hand machines are available
*For the network, as we do not use consensus algorithms like Paxos or Raft, Garage is not as latency sensitive.*
*Thanks to Rust and its zero-cost abstractions, we keep CPU and memory low.*
@@ -88,20 +66,15 @@ We worked hard to keep requirements as low as possible as we target the largest
- [Dynamo: Amazon’s Highly Available Key-value Store ](https://dl.acm.org/doi/abs/10.1145/1323293.1294281) by DeCandia et al.
- [Conflict-Free Replicated Data Types](https://link.springer.com/chapter/10.1007/978-3-642-24550-3_29) by Shapiro et al.
- [Maglev: A Fast and Reliable Software Network Load Balancer](https://www.usenix.org/conference/nsdi16/technical-sessions/presentation/eisenbud) by Eisenbud et al.
- - [Merkle Search Trees: Efficient State-Based CRDTs in Open Networks](https://ieeexplore.ieee.org/document/9049566) by Auvolat and Taïani
## Talks
-We love to talk and hear about Garage, that's why we keep a log here:
-
- [(fr, 2021-11-13, video) Garage : Mille et une façons de stocker vos données](https://video.tedomum.net/w/moYKcv198dyMrT8hCS5jz9) and [slides (html)](https://rfid.deuxfleurs.fr/presentations/2021-11-13/garage/) - during [RFID#1](https://rfid.deuxfleurs.fr/programme/2021-11-13/) event
- [(en, 2021-04-28, pdf) Distributed object storage is centralised](https://git.deuxfleurs.fr/Deuxfleurs/garage/raw/commit/b1f60579a13d3c5eba7f74b1775c84639ea9b51a/doc/talks/2021-04-28_spirals-team/talk.pdf)
- [(fr, 2020-12-02, pdf) Garage : jouer dans la cour des grands quand on est un hébergeur associatif](https://git.deuxfleurs.fr/Deuxfleurs/garage/raw/commit/b1f60579a13d3c5eba7f74b1775c84639ea9b51a/doc/talks/2020-12-02_wide-team/talk.pdf)
-*Did you write or talk about Garage? [Open a pull request](https://git.deuxfleurs.fr/Deuxfleurs/garage/) to add a link here!*
-
## Community
If you want to discuss with us, you can join our Matrix channel at [#garage:deuxfleurs.fr](https://matrix.to/#/#garage:deuxfleurs.fr).