summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHironori Shiina <shiina.hironori@jp.fujitsu.com>2021-07-21 14:41:23 -0400
committerHironori Shiina <shiina.hironori@jp.fujitsu.com>2021-07-21 17:50:37 -0400
commit12f4b14a166da857e9497235514a3a28c686d2b9 (patch)
tree6066896689ec463d5aa4ae137fe80aad655b27be /docs
parent6678385abc34521dc85a0a549ee306b73ebc2911 (diff)
downloadpodman-12f4b14a166da857e9497235514a3a28c686d2b9.tar.gz
podman-12f4b14a166da857e9497235514a3a28c686d2b9.tar.bz2
podman-12f4b14a166da857e9497235514a3a28c686d2b9.zip
Add notes to flags not supported on cgroups V2
Clarify what flags are not supported on cgroups V2 in documentation. Signed-off-by: Hironori Shiina <shiina.hironori@jp.fujitsu.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-create.1.md8
-rw-r--r--docs/source/markdown/podman-run.1.md8
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md
index 1720e6eb6..7f9cf0e75 100644
--- a/docs/source/markdown/podman-create.1.md
+++ b/docs/source/markdown/podman-create.1.md
@@ -181,6 +181,8 @@ Limit the CPU real-time period in microseconds
Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify.
+This flag is not supported on cgroups V2 systems.
+
#### **--cpu-rt-runtime**=*microseconds*
Limit the CPU real-time runtime in microseconds
@@ -190,6 +192,8 @@ Period of 1,000,000us and Runtime of 950,000us means that this container could c
The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup.
+This flag is not supported on cgroups V2 systems.
+
#### **--cpu-shares**=*shares*
CPU shares (relative weight)
@@ -479,6 +483,8 @@ is not limited. If you specify a limit, it may be rounded up to a multiple
of the operating system's page size and the value can be very large,
millions of trillions.
+This flag is not supported on cgroups V2 systems.
+
#### **--label**, **-l**=*label*
Add metadata to a container (e.g., --label com.example.key=value)
@@ -561,6 +567,8 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
+This flag is not supported on cgroups V2 systems.
+
#### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]*
Attach a filesystem mount to the container
diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md
index ce0cf1a2f..f08561904 100644
--- a/docs/source/markdown/podman-run.1.md
+++ b/docs/source/markdown/podman-run.1.md
@@ -199,6 +199,8 @@ Limit the CPU real-time period in microseconds.
Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify.
+This flag is not supported on cgroups V2 systems.
+
#### **--cpu-rt-runtime**=*microseconds*
Limit the CPU real-time runtime in microseconds.
@@ -208,6 +210,8 @@ Period of 1,000,000us and Runtime of 950,000us means that this container could c
The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup.
+This flag is not supported on cgroups V2 systems.
+
#### **--cpu-shares**=*shares*
CPU shares (relative weight).
@@ -518,6 +522,8 @@ is not limited. If you specify a limit, it may be rounded up to a multiple
of the operating system's page size and the value can be very large,
millions of trillions.
+This flag is not supported on cgroups V2 systems.
+
#### **--label**, **-l**=*key*=*value*
Add metadata to a container.
@@ -595,6 +601,8 @@ Set _number_ to **-1** to enable unlimited swap.
Tune a container's memory swappiness behavior. Accepts an integer between *0* and *100*.
+This flag is not supported on cgroups V2 systems.
+
#### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]*
Attach a filesystem mount to the container