Deuxfleurs/garage
48
55
Fork 72
Code Issues 99 Pull requests 14 Releases 30 Wiki Activity

Typos and dead links #169

Merged
quentin merged 2 commits from doc/fix into main 2021-12-09 18:08:58 +00:00
Conversation 0 Commits 2 Files changed 5 +4 -4
5 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/book/src/connect/apps.md
View file

@ -109,7 +109,7 @@ Do not change the `use_path_style` and `legacy_auth` entries, other configuratio
Peertube proposes a clever integration of S3 by directly exposing its endpoint instead of proxifying requests through the application. Peertube proposes a clever integration of S3 by directly exposing its endpoint instead of proxifying requests through the application.
In other words, Peertube is only responsible of the "control plane" and offload the "data plane" to Garage. In other words, Peertube is only responsible of the "control plane" and offload the "data plane" to Garage.
In return, this system is a bit harder to configure, especially with Garage that supports less feature than other older S3 backends. In return, this system is a bit harder to configure, especially with Garage that supports less feature than other older S3 backends.
We show that it is still possible to configure Garage with Peertube, allowing you to spread the load and the bandiwdth usage on the Garage cluster. We show that it is still possible to configure Garage with Peertube, allowing you to spread the load and the bandwidth usage on the Garage cluster.
### Enable path-style access by patching Peertube ### Enable path-style access by patching Peertube

2
doc/book/src/connect/index.md
View file

@ -1,4 +1,4 @@
# Connect it to... # Integrations
Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs. Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs.

2
doc/book/src/design/benchmarks.md
View file

@ -19,7 +19,7 @@ This serie of benchmarks quantifies the impact of this design choice.
We start with a controlled environment, all the instances are running on the same (powerful enough) machine. We start with a controlled environment, all the instances are running on the same (powerful enough) machine.
To control the network latency, we simulate the network with [mknet](https://git.deuxfleurs.fr/trinity-1686a/mknet) (a tool we developped, based on `tc` and the linux network stack). To control the network latency, we simulate the network with [mknet](https://git.deuxfleurs.fr/trinity-1686a/mknet) (a tool we developped, based on `tc` and the linux network stack).
To mesure S3 endpoints latency, we use our own tool [s3lat](git.deuxfleurs.fr/quentin/s3lat/) to observe only the intra-cluster latency and not some contention on the nodes (CPU, RAM, disk I/O, network bandwidth, etc.). To mesure S3 endpoints latency, we use our own tool [s3lat](https://git.deuxfleurs.fr/quentin/s3lat/) to observe only the intra-cluster latency and not some contention on the nodes (CPU, RAM, disk I/O, network bandwidth, etc.).
Compared to other benchmark tools, S3Lat sends only one (small) request at the same time and measures its latency. Compared to other benchmark tools, S3Lat sends only one (small) request at the same time and measures its latency.
We selected 5 standard endpoints that are often in the critical path: ListBuckets, ListObjects, GetObject, PutObject and RemoveObject. We selected 5 standard endpoints that are often in the critical path: ListBuckets, ListObjects, GetObject, PutObject and RemoveObject.

BIN
doc/book/src/design/img/endpoint-latency.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 124 KiB

2
doc/book/src/intro.md
View file

@ -22,7 +22,7 @@ Garage is an **open-source** distributed **storage service** you can **self-host
</p> </p>
<p align="center" style="text-align:center; margin-bottom: 5rem;"> <p align="center" style="text-align:center; margin-bottom: 5rem;">
<a href="/design/use_cases.html">⮞ learn more about use cases ⮜</a> <a href="/design/goals.html#use-cases">⮞ learn more about use cases ⮜</a>
</p> </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: Garage implements the **[Amazon S3 API](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)** and thus is already **compatible** with many applications: