aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-02 12:57:45 +0200
committerGitHub <noreply@github.com>2022-09-02 12:57:45 +0200
commit0e66f75f2a6d3792ae7fd2d77fe8a55b6fbdb0ce (patch)
treef8de0c328c0d3086d6859d1bfa5f55e36773eb2e /docs
parent4cbc4774f149fa554f3cee3c47eb8794fce8d850 (diff)
parent3d09d47a25e935076a011820fd8b8cd008a08ce0 (diff)
downloadpodman-0e66f75f2a6d3792ae7fd2d77fe8a55b6fbdb0ce.tar.gz
podman-0e66f75f2a6d3792ae7fd2d77fe8a55b6fbdb0ce.tar.bz2
podman-0e66f75f2a6d3792ae7fd2d77fe8a55b6fbdb0ce.zip
Merge pull request #15604 from edsantiago/docs_dedup_deviceXY
[CI:DOCS] Man pages: refactor common options: --device-X-Y
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/options/device-read-bps.md4
-rw-r--r--docs/source/markdown/options/device-read-iops.md4
-rw-r--r--docs/source/markdown/options/device-write-bps.md4
-rw-r--r--docs/source/markdown/options/device-write-iops.md4
-rw-r--r--docs/source/markdown/podman-create.1.md.in2
5 files changed, 17 insertions, 1 deletions
diff --git a/docs/source/markdown/options/device-read-bps.md b/docs/source/markdown/options/device-read-bps.md
index e0c610061..f6617ab77 100644
--- a/docs/source/markdown/options/device-read-bps.md
+++ b/docs/source/markdown/options/device-read-bps.md
@@ -2,4 +2,8 @@
Limit read rate (in bytes per second) from a device (e.g. **--device-read-bps=/dev/sda:1mb**).
+On some systems, changing the resource 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.
diff --git a/docs/source/markdown/options/device-read-iops.md b/docs/source/markdown/options/device-read-iops.md
index 9cd0f9030..944c66441 100644
--- a/docs/source/markdown/options/device-read-iops.md
+++ b/docs/source/markdown/options/device-read-iops.md
@@ -2,4 +2,8 @@
Limit read rate (in IO operations per second) from a device (e.g. **--device-read-iops=/dev/sda:1000**).
+On some systems, changing the resource 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.
diff --git a/docs/source/markdown/options/device-write-bps.md b/docs/source/markdown/options/device-write-bps.md
index 3dacc4515..ebcda0181 100644
--- a/docs/source/markdown/options/device-write-bps.md
+++ b/docs/source/markdown/options/device-write-bps.md
@@ -2,4 +2,8 @@
Limit write rate (in bytes per second) to a device (e.g. **--device-write-bps=/dev/sda:1mb**).
+On some systems, changing the resource 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.
diff --git a/docs/source/markdown/options/device-write-iops.md b/docs/source/markdown/options/device-write-iops.md
index cf5ce3859..6de273d18 100644
--- a/docs/source/markdown/options/device-write-iops.md
+++ b/docs/source/markdown/options/device-write-iops.md
@@ -2,4 +2,8 @@
Limit write rate (in IO operations per second) to a device (e.g. **--device-write-iops=/dev/sda:1000**).
+On some systems, changing the resource 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.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 987f10181..4fe50caed 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -144,7 +144,7 @@ device. The devices that podman will load modules when necessary are:
@@option device-cgroup-rule
-#### **--device-read-bps**=*path*
+@@option device-read-bps
@@option device-read-iops