aboutsummaryrefslogtreecommitdiff
path: root/doc/book/reference-manual
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2023-09-11 18:03:20 +0200
committerAlex Auvolat <alex@adnab.me>2023-09-11 18:03:44 +0200
commit51b9731a086b4e158cbfa2127bcbfd6cb6274578 (patch)
treece5bac4a3fa0ef4a7546c91ad87a5161c3367a35 /doc/book/reference-manual
parent5f86b48f9766019c6c74d14c2fba8c1176423cfb (diff)
downloadgarage-51b9731a086b4e158cbfa2127bcbfd6cb6274578.tar.gz
garage-51b9731a086b4e158cbfa2127bcbfd6cb6274578.zip
make lmdb's map_size configurable (fix #628)
Diffstat (limited to 'doc/book/reference-manual')
-rw-r--r--doc/book/reference-manual/configuration.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index b916bb61..c3b8ca00 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -17,6 +17,7 @@ block_size = 1048576
sled_cache_capacity = 134217728
sled_flush_every_ms = 2000
+lmdb_map_size = "10T"
replication_mode = "3"
@@ -160,6 +161,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: