summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Vollmar <nvollmar@gmail.com>2024-05-27 20:11:32 +0200
committerMergify <37929162+mergify[bot]@users.noreply.github.com>2024-05-28 21:01:41 +0000
commit809dd15c521a4bc2d7f51f4d67cb043d63c40d96 (patch)
treef9c6149360d916b74cb38529612d01445c4dc259
parent319ade6951bdde168eb15617fbdfeb3479d2451f (diff)
downloadvyos-documentation-809dd15c521a4bc2d7f51f4d67cb043d63c40d96.tar.gz
vyos-documentation-809dd15c521a4bc2d7f51f4d67cb043d63c40d96.zip
T6406: document cpu limit config option
(cherry picked from commit 6742fa6314fdf448f814d18dac70a638587b75e6)
-rw-r--r--docs/configuration/container/index.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst
index 4dacc6f4..39d7872c 100644
--- a/docs/configuration/container/index.rst
+++ b/docs/configuration/container/index.rst
@@ -133,6 +133,17 @@ Configuration
- **always**: Restart containers when they exit, regardless of status,
retrying indefinitely
+.. cfgcmd:: set container name <name> cpus <num>
+
+ This specifies the number of CPU resources the container can use.
+
+ Default is 0 for unlimited.
+ For example, 1.25 limits the container to use up to 1.25 cores
+ worth of CPU time.
+ This can be a decimal number with up to three decimal places.
+
+ The command translates to "--cpus=<num>" when the container is created.
+
.. cfgcmd:: set container name <name> memory <MB>
Constrain the memory available to the container.