summaryrefslogtreecommitdiff
path: root/docs/configuration/container/index.rst
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2024-05-28 23:18:02 +0200
committerGitHub <noreply@github.com>2024-05-28 23:18:02 +0200
commit6bcb10fa232d7700254195eeb1fcbbcd1da12987 (patch)
treeb39433ee6d457e6e71a2133cbb293802f4a5b1c8 /docs/configuration/container/index.rst
parent319ade6951bdde168eb15617fbdfeb3479d2451f (diff)
parentc024153b1453a8d42c70a7414629d86ebf1a6d34 (diff)
downloadvyos-documentation-6bcb10fa232d7700254195eeb1fcbbcd1da12987.tar.gz
vyos-documentation-6bcb10fa232d7700254195eeb1fcbbcd1da12987.zip
Merge pull request #1468 from vyos/mergify/bp/sagitta/pr-1462
T6406: document cpu limit config option (backport #1462)
Diffstat (limited to 'docs/configuration/container/index.rst')
-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..399f2ef5 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> cpu-quota <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.