T6406: document cpu limit config option

vyos · May 28, 2024 · 6742fa6 · 6742fa6
1 parent d9fef26
commit 6742fa6
Showing 1 changed file with 11 additions and 0 deletions.
diff --git 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.