summaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/cpus.container.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-22 19:10:42 -0600
committerEd Santiago <santiago@redhat.com>2022-08-23 08:04:36 -0600
commit5c9bac141ecdf7a87d40e0c0aba1d49893f24474 (patch)
tree869e22267f7aa7b4f6f77283333f587bf1d142b0 /docs/source/markdown/options/cpus.container.md
parent5948320951e17a60da848ba16e3c7aed1676129a (diff)
downloadpodman-5c9bac141ecdf7a87d40e0c0aba1d49893f24474.tar.gz
podman-5c9bac141ecdf7a87d40e0c0aba1d49893f24474.tar.bz2
podman-5c9bac141ecdf7a87d40e0c0aba1d49893f24474.zip
Man pages: refactor common options: --cpus
Only on podman create and run: the --cpus option on container-clone and pod-clone can probably be combined, but maybe later. pod-create has unique wording that can't be combined. This is a freebie to review: the text in both files was already identical, and I made no changes to it. hack/markdown-preprocess-review will agree, and show you no diffs, because there are none worth seeing. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options/cpus.container.md')
-rw-r--r--docs/source/markdown/options/cpus.container.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/markdown/options/cpus.container.md b/docs/source/markdown/options/cpus.container.md
new file mode 100644
index 000000000..63f243e11
--- /dev/null
+++ b/docs/source/markdown/options/cpus.container.md
@@ -0,0 +1,11 @@
+#### **--cpus**=*number*
+
+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
+https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error
+
+This option is not supported on cgroups V1 rootless systems.