diff options
author | Jordan Christiansen <xordspar0@gmail.com> | 2020-10-24 21:34:37 -0500 |
---|---|---|
committer | Jordan Christiansen <xordspar0@gmail.com> | 2020-10-27 09:32:41 -0500 |
commit | fa73b929e06521b176ab6a569e5b3d408440956f (patch) | |
tree | 31f931498bcffbfd6873d2e04b17ae3476f4e592 /docs/source/markdown/podman-run.1.md | |
parent | 6fa6470d24231dccafbf4396e7cb798a906af522 (diff) | |
download | podman-fa73b929e06521b176ab6a569e5b3d408440956f.tar.gz podman-fa73b929e06521b176ab6a569e5b3d408440956f.tar.bz2 podman-fa73b929e06521b176ab6a569e5b3d408440956f.zip |
Add more details about how CPU limits work
Signed-off-by: Jordan Christiansen <xordspar0@gmail.com>
Diffstat (limited to 'docs/source/markdown/podman-run.1.md')
-rw-r--r-- | docs/source/markdown/podman-run.1.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index b86c9b363..6df9b0351 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -118,15 +118,19 @@ Write the pid of the **conmon** process to a file. As **conmon** runs in a separ **--cpu-period**=*limit* -Limit the container's CPU usage by setting CPU CFS (Completely Fair Scheduler) period. +Set the CPU period for the Completely Fair Scheduler (CFS), which is a +duration in microseconds. Once the container's CPU quota is used up, it will +not be scheduled to run until the current period ends. Defaults to 100000 +microseconds. **--cpu-quota**=*limit* -Limit the CPU CFS (Completely Fair Scheduler) quota. +Limit the CPU Completely Fair Scheduler (CFS) quota. Limit the container's CPU usage. By default, containers run with the full -CPU resource. This flag tell the kernel to restrict the container's CPU usage -to the quota you specify. +CPU resource. The limit is a number in microseconds. If you provide a number, +the container will be allowed to use that much CPU time until the CPU period +ends (controllable via **--cpu-period**). **--cpu-rt-period**=*microseconds* @@ -180,7 +184,9 @@ division of CPU shares: **--cpus**=*number* -Number of CPUs. The default is *0.0* which means no limit. +Number of CPUs. The default is *0.0* which means no limit. This is shorthand +for **--cpu-period** and **--cpu-quota**, so you may only set either +**--cpus** or **--cpu-period** and **--cpu-quota**. **--cpuset-cpus**=*number* |