summaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/cpu-period.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-09 15:02:08 -0600
committerEd Santiago <santiago@redhat.com>2022-08-09 16:18:53 -0600
commit2bcee9f627b2cd1e3fe588b581aff05821f5841d (patch)
tree4a17d840d90e19057a517358986d6587610d2f6f /docs/source/markdown/options/cpu-period.md
parent72679400b0cd7d059f20b2b84ee8b42306ce607a (diff)
downloadpodman-2bcee9f627b2cd1e3fe588b581aff05821f5841d.tar.gz
podman-2bcee9f627b2cd1e3fe588b581aff05821f5841d.tar.bz2
podman-2bcee9f627b2cd1e3fe588b581aff05821f5841d.zip
Man pages: refactor common options
Continued. Harder-to-review ones this time. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options/cpu-period.md')
-rw-r--r--docs/source/markdown/options/cpu-period.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/source/markdown/options/cpu-period.md b/docs/source/markdown/options/cpu-period.md
new file mode 100644
index 000000000..8df6445e9
--- /dev/null
+++ b/docs/source/markdown/options/cpu-period.md
@@ -0,0 +1,10 @@
+#### **--cpu-period**=*limit*
+
+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
+https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error