aboutsummaryrefslogtreecommitdiff
path: root/doc/book/reference-manual
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2023-09-11 20:00:02 +0200
committerAlex Auvolat <alex@adnab.me>2023-09-11 20:00:02 +0200
commit51abbb02d8b77529c2e3db079d527d0f28c737bc (patch)
tree5dbc1611f968214ba103c73cd0cf2cc966696eef /doc/book/reference-manual
parentad6b1cc0bed8a01ebeb2aacf995a69ced785b5a6 (diff)
parent2548a247f22a6404a2f447e9f9c47fe18e10f67a (diff)
downloadgarage-51abbb02d8b77529c2e3db079d527d0f28c737bc.tar.gz
garage-51abbb02d8b77529c2e3db079d527d0f28c737bc.zip
Merge branch 'main' into next
Diffstat (limited to 'doc/book/reference-manual')
-rw-r--r--doc/book/reference-manual/configuration.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index df1251c2..f07fb1e0 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -17,8 +17,9 @@ db_engine = "lmdb"
block_size = 1048576
-sled_cache_capacity = 134217728
+sled_cache_capacity = "128MiB"
sled_flush_every_ms = 2000
+lmdb_map_size = "1T"
replication_mode = "3"
@@ -191,8 +192,8 @@ if geographical replication is used.
### `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
-should work in most cases. We recommend increasing it to e.g. 10MB if
+(except the last one which might be smaller). The default size is 1MiB and
+should work in most cases. We recommend increasing it to e.g. 10MiB if
you are using Garage to store large files and have fast network connections
between all nodes (e.g. 1gbps).
@@ -218,6 +219,14 @@ Increase this if sled is thrashing your SSD, at the risk of losing more data in
of a power outage (though this should not matter much as data is replicated on other
nodes). The default value, 2000ms, should be appropriate for most use cases.
+### `lmdb_map_size`
+
+This parameters can be used to set the map size used by LMDB,
+which is the size of the virtual memory region used for mapping the database file.
+The value of this parameter is the maximum size the metadata database can take.
+This value is not bound by the physical RAM size of the machine running Garage.
+If not specified, it defaults to 1GiB on 32-bit machines and 1TiB on 64-bit machines.
+
### `replication_mode`
Garage supports the following replication modes: