asonix/garage
1
0
Fork 0
forked from Deuxfleurs/garage
Code Pull requests Activity

Small documentation updates (#237)

Browse source 
Fixes #234, among other things

Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: Deuxfleurs/garage#237
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
This commit is contained in:
Alex 2022-02-10 15:58:09 +01:00
parent 3e1373fafc
commit 4ae03aa774
3 changed files with 23 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/book/development/release-process.md
View file

@ -32,9 +32,10 @@ We generate the following binary artifacts for now:
- **os**: linux - **os**: linux
- **format**: static binary, docker container - **format**: static binary, docker container
Additionnaly we also build two web pages: Additionnaly we also build two web pages and one JSON document:
- the documentation (this website) - the documentation (this website)
- [the release page](https://garagehq.deuxfleurs.fr/_releases.html) - [the release page](https://garagehq.deuxfleurs.fr/_releases.html)
- [the release list in JSON format](https://garagehq.deuxfleurs.fr/_releases.json)
We publish the static binaries on our own garage cluster (you can access them through the releases page) We publish the static binaries on our own garage cluster (you can access them through the releases page)
and the docker containers on Docker Hub. and the docker containers on Docker Hub.

2
doc/book/quick-start/_index.md
View file

@ -20,7 +20,7 @@ as it provides no redundancy for your data!
Download the latest Garage binary from the release pages on our repository: Download the latest Garage binary from the release pages on our repository:
<https://garagehq.deuxfleurs.fr/_releases.html> <https://garagehq.deuxfleurs.fr/download/>
Place this binary somewhere in your `$PATH` so that you can invoke the `garage` Place this binary somewhere in your `$PATH` so that you can invoke the `garage`
command directly (for instance you can copy the binary in `/usr/local/bin` command directly (for instance you can copy the binary in `/usr/local/bin`

36
doc/book/reference-manual/configuration.md
View file

@ -40,7 +40,6 @@ root_domain = ".s3.garage"
[s3_web] [s3_web]
bind_addr = "[::]:3902" bind_addr = "[::]:3902"
root_domain = ".web.garage" root_domain = ".web.garage"
index = "index.html"
``` ```
The following gives details about each available configuration option. The following gives details about each available configuration option.
@ -60,19 +59,22 @@ Store this folder on a fast SSD drive if possible to maximize Garage's performan
The directory in which Garage will store the data blocks of objects. The directory in which Garage will store the data blocks of objects.
This folder can be placed on an HDD. The space available for `data_dir` This folder can be placed on an HDD. The space available for `data_dir`
should be counted to determine a node's capacity should be counted to determine a node's capacity
when [configuring it](@/documentation/cookbook/real-world.md). when [adding it to the cluster layout](@/documentation/cookbook/real-world.md).
### `block_size` ### `block_size`
Garage splits stored objects in consecutive chunks of size `block_size` Garage splits stored objects in consecutive chunks of size `block_size`
(except the last one which might be smaller). The default size is 1MB and (except the last one which might be smaller). The default size is 1MB and
should work in most cases. If you are interested in tuning this, feel free should work in most cases. We recommend increasing it to e.g. 10MB if
to do so (and remember to report your findings to us!). If this value is you are using Garage to store large files and have fast network connections
changed for a running Garage installation, only files newly uploaded will be between all nodes (e.g. 1gbps).
affected. Previously uploaded files will remain available. This however
means that chunks from existing files will not be deduplicated with chunks If you are interested in tuning this, feel free to do so (and remember to
from newly uploaded files, meaning you might use more storage space that is report your findings to us!). When this value is changed for a running Garage
optimally possible. installation, only files newly uploaded will be affected. Previously uploaded
files will remain available. This however means that chunks from existing files
will not be deduplicated with chunks from newly uploaded files, meaning you
might use more storage space that is optimally possible.
### `replication_mode` ### `replication_mode`
@ -114,12 +116,12 @@ default value (currently `3`). Finally, zstd has also compression designed to be
than default compression levels, they range from `-1` (smaller file) to `-99` (faster than default compression levels, they range from `-1` (smaller file) to `-99` (faster
compression). compression).
If you do not specify a `compression_level` entry, garage will set it to `1` for you. With If you do not specify a `compression_level` entry, Garage will set it to `1` for you. With
this parameters, zstd consumes low amount of cpu and should work faster than line speed in this parameters, zstd consumes low amount of cpu and should work faster than line speed in
most situations, while saving some space and intra-cluster most situations, while saving some space and intra-cluster
bandwidth. bandwidth.
If you want to totally deactivate zstd in garage, you can pass the special value `'none'`. No If you want to totally deactivate zstd in Garage, you can pass the special value `'none'`. No
zstd related code will be called, your chunks will be stored on disk without any processing. zstd related code will be called, your chunks will be stored on disk without any processing.
Compression is done synchronously, setting a value too high will add latency to write queries. Compression is done synchronously, setting a value too high will add latency to write queries.
@ -169,21 +171,23 @@ yourself.
### `consul_host` and `consul_service_name` ### `consul_host` and `consul_service_name`
Garage supports discovering other nodes of the cluster using Consul. Garage supports discovering other nodes of the cluster using Consul. For this
This works only when nodes are announced in Consul by an orchestrator such as Nomad, to work correctly, nodes need to know their IP address by which they can be
as Garage is not able to announce itself. reached by other nodes of the cluster, which should be set in `rpc_public_addr`.
The `consul_host` parameter should be set to the hostname of the Consul server, The `consul_host` parameter should be set to the hostname of the Consul server,
and `consul_service_name` should be set to the service name under which Garage's and `consul_service_name` should be set to the service name under which Garage's
RPC ports are announced. RPC ports are announced.
Garage does not yet support talking to Consul over TLS.
### `sled_cache_capacity` ### `sled_cache_capacity`
This parameter can be used to tune the capacity of the cache used by This parameter can be used to tune the capacity of the cache used by
[sled](https://sled.rs), the database Garage uses internally to store metadata. [sled](https://sled.rs), the database Garage uses internally to store metadata.
Tune this to fit the RAM you wish to make available to your Garage instance. Tune this to fit the RAM you wish to make available to your Garage instance.
More cache means faster Garage, but the default value (128MB) should be plenty This value has a conservative default (128MB) so that Garage doesn't use too much
for most use cases. RAM by default, but feel free to increase this for higher performance.
### `sled_flush_every_ms` ### `sled_flush_every_ms`