mirror of https://github.com/containers/podman.git
Merge pull request #15650 from edsantiago/docs_dedup_device
[CI:DOCS] Man pages: refactor common options: --device
This commit is contained in:
commit
6da1eaf287
|
|
@ -0,0 +1,14 @@
|
|||
#### **--device**=*host-device[:container-device][:permissions]*
|
||||
|
||||
Add a host device to the <<container|pod>>. Optional *permissions* parameter
|
||||
can be used to specify device permissions by combining
|
||||
**r** for read, **w** for write, and **m** for **mknod**(2).
|
||||
|
||||
Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
|
||||
|
||||
Note: if *host-device* is a symbolic link then it will be resolved first.
|
||||
The <<container|pod>> will only store the major and minor numbers of the host device.
|
||||
|
||||
Podman may load kernel modules required for using the specified
|
||||
device. The devices that Podman will load modules for when necessary are:
|
||||
/dev/fuse.
|
||||
|
|
@ -205,16 +205,7 @@ keys and/or certificates. Decryption will be tried with all keys. If the key is
|
|||
protected by a passphrase, it is required to be passed in the argument and
|
||||
omitted otherwise.
|
||||
|
||||
#### **--device**=*host-device[:container-device][:permissions]*
|
||||
|
||||
Add a host device to the container. Optional *permissions* parameter
|
||||
can be used to specify device permissions, it is combination of
|
||||
**r** for read, **w** for write, and **m** for **mknod**(2).
|
||||
|
||||
Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
|
||||
|
||||
Note: if *host-device* is a symbolic link then it will be resolved first.
|
||||
The container will only store the major and minor numbers of the host device.
|
||||
@@option device
|
||||
|
||||
Note: if the user only has access rights via a group, accessing the device
|
||||
from inside a rootless container will fail. The **[crun(1)](https://github.com/containers/crun/tree/main/crun.1.md)** runtime offers a
|
||||
|
|
|
|||
|
|
@ -123,25 +123,12 @@ each of stdin, stdout, and stderr.
|
|||
|
||||
@@option cpuset-mems
|
||||
|
||||
#### **--device**=*host-device[:container-device][:permissions]*
|
||||
|
||||
Add a host device to the container. Optional *permissions* parameter
|
||||
can be used to specify device permissions, it is combination of
|
||||
**r** for read, **w** for write, and **m** for **mknod**(2).
|
||||
|
||||
Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
|
||||
|
||||
Note: if *host-device* is a symbolic link then it will be resolved first.
|
||||
The container will only store the major and minor numbers of the host device.
|
||||
@@option device
|
||||
|
||||
Note: if the user only has access rights via a group, accessing the device
|
||||
from inside a rootless container will fail. Use the `--group-add keep-groups`
|
||||
flag to pass the user's supplementary group access into the container.
|
||||
|
||||
Podman may load kernel modules required for using the specified
|
||||
device. The devices that podman will load modules when necessary are:
|
||||
/dev/fuse.
|
||||
|
||||
@@option device-cgroup-rule
|
||||
|
||||
@@option device-read-bps
|
||||
|
|
|
|||
|
|
@ -31,23 +31,10 @@ If none are specified, the original pod's CPUset is used.
|
|||
|
||||
@@option destroy
|
||||
|
||||
#### **--device**=*host-device[:container-device][:permissions]*
|
||||
|
||||
Add a host device to the pod. Optional *permissions* parameter
|
||||
can be used to specify device permissions. It is a combination of
|
||||
**r** for read, **w** for write, and **m** for **mknod**(2).
|
||||
|
||||
Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
|
||||
|
||||
Note: if _host_device_ is a symbolic link then it will be resolved first.
|
||||
The pod will only store the major and minor numbers of the host device.
|
||||
@@option device
|
||||
|
||||
Note: the pod implements devices by storing the initial configuration passed by the user and recreating the device on each container added to the pod.
|
||||
|
||||
Podman may load kernel modules required for using the specified
|
||||
device. The devices that Podman will load modules for when necessary are:
|
||||
/dev/fuse.
|
||||
|
||||
@@option device-read-bps
|
||||
|
||||
@@option device-write-bps
|
||||
|
|
|
|||
|
|
@ -48,23 +48,10 @@ Set the total number of CPUs delegated to the pod. Default is 0.000 which indica
|
|||
|
||||
@@option cpuset-mems
|
||||
|
||||
#### **--device**=_host-device_[**:**_container-device_][**:**_permissions_]
|
||||
|
||||
Add a host device to the pod. Optional *permissions* parameter
|
||||
can be used to specify device permissions. It is a combination of
|
||||
**r** for read, **w** for write, and **m** for **mknod**(2).
|
||||
|
||||
Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
|
||||
|
||||
Note: if *host-device* is a symbolic link then it will be resolved first.
|
||||
The pod will only store the major and minor numbers of the host device.
|
||||
@@option device
|
||||
|
||||
Note: the pod implements devices by storing the initial configuration passed by the user and recreating the device on each container added to the pod.
|
||||
|
||||
Podman may load kernel modules required for using the specified
|
||||
device. The devices that Podman will load modules for when necessary are:
|
||||
/dev/fuse.
|
||||
|
||||
@@option device-read-bps
|
||||
|
||||
@@option device-write-bps
|
||||
|
|
|
|||
|
|
@ -159,25 +159,12 @@ Specify the key sequence for detaching a container. Format is a single character
|
|||
|
||||
This option can also be set in **containers.conf**(5) file.
|
||||
|
||||
#### **--device**=*host-device[:container-device][:permissions]*
|
||||
|
||||
Add a host device to the container. Optional *permissions* parameter
|
||||
can be used to specify device permissions by combining
|
||||
**r** for read, **w** for write, and **m** for **mknod**(2).
|
||||
|
||||
Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
|
||||
|
||||
Note: if _host_device_ is a symbolic link then it will be resolved first.
|
||||
The container will only store the major and minor numbers of the host device.
|
||||
@@option device
|
||||
|
||||
Note: if the user only has access rights via a group, accessing the device
|
||||
from inside a rootless container will fail. Use the `--group-add keep-groups`
|
||||
flag to pass the user's supplementary group access into the container.
|
||||
|
||||
Podman may load kernel modules required for using the specified
|
||||
device. The devices that Podman will load modules when necessary are:
|
||||
/dev/fuse.
|
||||
|
||||
@@option device-cgroup-rule
|
||||
|
||||
@@option device-read-bps
|
||||
|
|
|
|||
Loading…
Reference in New Issue