aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/memory-reservation.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/markdown/options/memory-reservation.md')
-rw-r--r--docs/source/markdown/options/memory-reservation.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/markdown/options/memory-reservation.md b/docs/source/markdown/options/memory-reservation.md
new file mode 100644
index 000000000..410f1dd7c
--- /dev/null
+++ b/docs/source/markdown/options/memory-reservation.md
@@ -0,0 +1,11 @@
+#### **--memory-reservation**=*number[unit]*
+
+Memory soft limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebibytes), or **g** (gibibytes).
+
+After setting memory reservation, when the system detects memory contention
+or low memory, containers are forced to restrict their consumption to their
+reservation. So you should always set the value below **--memory**, otherwise the
+hard limit will take precedence. By default, memory reservation will be the same
+as memory limit.
+
+This option is not supported on cgroups V1 rootless systems.