summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-run.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-10-27 13:26:53 -0400
committerGitHub <noreply@github.com>2020-10-27 13:26:53 -0400
commit95f3ec7b08c9115d50358086f6fa7e683c63a522 (patch)
treee98caccb13d05fdef73709d76b9624be743aec0e /docs/source/markdown/podman-run.1.md
parent434de069fe83b6a928cd6c741c9337219cf09fe5 (diff)
parentfa73b929e06521b176ab6a569e5b3d408440956f (diff)
downloadpodman-95f3ec7b08c9115d50358086f6fa7e683c63a522.tar.gz
podman-95f3ec7b08c9115d50358086f6fa7e683c63a522.tar.bz2
podman-95f3ec7b08c9115d50358086f6fa7e683c63a522.zip
Merge pull request #8133 from xordspar0/cpu-limit-details
[CI:DOCS] Add more details about how CPU limits work
Diffstat (limited to 'docs/source/markdown/podman-run.1.md')
-rw-r--r--docs/source/markdown/podman-run.1.md16
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 f46c0009e..aad179957 100644
--- a/docs/source/markdown/podman-run.1.md
+++ b/docs/source/markdown/podman-run.1.md
@@ -118,7 +118,10 @@ 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.
On some systems, changing the CPU limits may not be allowed for non-root
users. For more details, see
@@ -126,11 +129,12 @@ https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-c
**--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**).
On some systems, changing the CPU limits may not be allowed for non-root
users. For more details, see
@@ -188,7 +192,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**.
On some systems, changing the CPU limits may not be allowed for non-root
users. For more details, see