Skip to content

Type Alias: ContainerdDevice ​

ContainerdDevice = object

A host device given to a container (ContainerCreateOptions.devices): its device node created in the container, and its access allowed by the container's device cgroup. Unlike the Docker component's device, containerPath is optional and hostPath may be a directory.

Properties ​

cgroupPermissions? ​

optional cgroupPermissions?: string

The access the cgroup allows: one to three of r (read), w (write) and m (mknod), each at most once, in any order: "rwm", "rw", "r".

Default ​

ts
'rwm'

containerPath? ​

optional containerPath?: string

The path of the device node in the container (for a directory, the directory its nodes are created in).

Default ​

ts
hostPath

hostPath ​

hostPath: string

The device node on the host (/dev/ttyUSB0), or a directory whose device nodes are all given (/dev/snd), the subdirectories included and the other files skipped. A path which is neither fails the creation of the container. The devices are read when the container is created: a device plugged later needs ContainerCreateOptions.deviceCgroupRules and a bind mount of its directory.

Released under the MIT License.