summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2024-05-28 23:01:08 +0200
committerGitHub <noreply@github.com>2024-05-28 23:01:08 +0200
commit0354594496810bc2da47771f9ba5442767571e4b (patch)
treebbbfddba23cffa9871a4357b6b3a3f76c24b21ed /docs/configuration
parent2be191247b2f10f1bc3ae38f8bcb565ce0af0635 (diff)
parenta983832d14c28888d035e774ee63c2f459b84aa4 (diff)
downloadvyos-documentation-0354594496810bc2da47771f9ba5442767571e4b.tar.gz
vyos-documentation-0354594496810bc2da47771f9ba5442767571e4b.zip
Merge pull request #1462 from nvollmar/T6406
T6406: document cpu limit config option
Diffstat (limited to 'docs/configuration')
-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.