aboutsummaryrefslogtreecommitdiff
path: root/content/documentation/design/goals.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-02-02 10:07:26 +0100
committerAlex Auvolat <alex@adnab.me>2022-02-02 10:07:26 +0100
commitf5afa3d974e631de75c438cf2941a88440e2cf69 (patch)
tree9f9a89d10940757025b82ff8fdfbe3104c5f89a4 /content/documentation/design/goals.md
parent921dd28f7499e46d78bd39d9ac7630efc50b64e8 (diff)
downloadgaragehq.deuxfleurs.fr-f5afa3d974e631de75c438cf2941a88440e2cf69.tar.gz
garagehq.deuxfleurs.fr-f5afa3d974e631de75c438cf2941a88440e2cf69.zip
Documentation from garage submodule
Diffstat (limited to 'content/documentation/design/goals.md')
-rw-r--r--content/documentation/design/goals.md57
1 files changed, 0 insertions, 57 deletions
diff --git a/content/documentation/design/goals.md b/content/documentation/design/goals.md
deleted file mode 100644
index 28511d9..0000000
--- a/content/documentation/design/goals.md
+++ /dev/null
@@ -1,57 +0,0 @@
-+++
-title = "Goals and use cases"
-weight = 5
-+++
-
-
-## Goals and non-goals
-
-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 is an opinionated object storage solutoin, we focus on the following **desirable properties**:
-
- - **Self-contained & lightweight**: works everywhere and integrates well in existing environments to target [hyperconverged infrastructures](https://en.wikipedia.org/wiki/Hyper-converged_infrastructure).
- - **Highly resilient**: highly resilient to network failures, network latency, disk failures, sysadmin failures.
- - **Simple**: simple to understand, simple to operate, simple to debug.
- - **Internet enabled**: made for multi-sites (eg. datacenters, offices, households, etc.) interconnected through regular Internet connections.
-
-We also noted that the pursuit of some other goals are detrimental to our initial goals.
-The following has been identified as **non-goals** (if these points matter to you, you should not use Garage):
-
- - **Extreme performances**: high performances constrain a lot the design and the infrastructure; we seek performances through minimalism only.
- - **Feature extensiveness**: we do not plan to add additional features compared to the ones provided by the S3 API.
- - **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
-
-*Are you also using Garage in your organization? [Open a PR](https://git.deuxfleurs.fr/Deuxfleurs/garage) to add your use case here!*
-
-### Deuxfleurs
-
-[Deuxfleurs](https://deuxfleurs.fr) is an experimental non-profit hosting
-organization that develops Garage. Deuxfleurs is focused on building highly
-available infrastructure through redundancy in multiple geographical
-locations. They use Garage themselves for the following tasks:
-
-- Hosting of [main website](https://deuxfleurs.fr), [this website](https://garagehq.deuxfleurs.fr), as well as the personal website of many of the members of the organization
-
-- As a [Matrix media backend](https://github.com/matrix-org/synapse-s3-storage-provider)
-
-- To store personal data and shared documents through [Bagage](https://git.deuxfleurs.fr/Deuxfleurs/bagage), a homegrown WebDav-to-S3 proxy
-
-- In the Drone continuous integration platform to store task logs
-
-- As a Nix binary cache
-
-- As a backup target using `rclone`
-
-The Deuxfleurs Garage cluster is a multi-site cluster currently composed of
-4 nodes in 2 physical locations. In the future it will be expanded to at
-least 3 physical locations to fully exploit Garage's potential for high
-availability.