From 3d09d47a25e935076a011820fd8b8cd008a08ce0 Mon Sep 17 00:00:00 2001 From: Ed Santiago <santiago@redhat.com> Date: Wed, 31 Aug 2022 06:40:04 -0600 Subject: Man pages: refactor common options: --device-X-Y Followup from #15276: add the FAQ-26 link, and fix one broken replacement. Signed-off-by: Ed Santiago <santiago@redhat.com> --- docs/source/markdown/options/device-read-bps.md | 4 ++++ docs/source/markdown/options/device-read-iops.md | 4 ++++ docs/source/markdown/options/device-write-bps.md | 4 ++++ docs/source/markdown/options/device-write-iops.md | 4 ++++ docs/source/markdown/podman-create.1.md.in | 2 +- 5 files changed, 17 insertions(+), 1 deletion(-) (limited to 'docs') 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 10f0f7f56..03353988d 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 -- cgit v1.2.3-54-g00ecf