Skip to content

Generic Device Plugin

Version: 0.1.3 Type: application AppVersion: latest

The generic-device-plugin enables allocating generic Linux devices, such as serial devices, the FUSE device, or video cameras, to Kubernetes Pods

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code


Kubernetes: >=1.22.0-0


Repository Name Version common 1.5.1

Installing the Chart

To install the chart with the release name generic-device-plugin

helm install generic-device-plugin oci://


helm repo add gabe565
helm repo update
helm install generic-device-plugin gabe565/generic-device-plugin

Uninstalling the Chart

To uninstall the generic-device-plugin deployment

helm uninstall generic-device-plugin

The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.


Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the bjw-s common library.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

helm install generic-device-plugin \
  --set env.TZ="America/New York" \

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

helm install generic-device-plugin gabe565/generic-device-plugin -f values.yaml

Custom configuration

Configuring Devices

Generic Device Plugin will only expose whitelisted devices. To add a device with this Helm chart, add it to in the following format:

  data: |
      - <device specs>

Device Spec

  • Multiple paths can be given for each type. Paths can be globs.
  • Should be provided in the form:
    name: <name>
      - <device definitions>
    count: <count>

Device Definition

  • The device definition can be either a path to a device file or a USB device. You cannot define both in the same group.
  • For device files, use something like:
      - path: <path-1>
        mountPath: <mount-path-1>
      - path: <path-2>
        mountPath: <mount-path-2>
  • For example, to expose serial devices with different names:
    name: serial
      - paths:
          - path: /dev/ttyUSB*
      - paths:
          - path: /dev/ttyACM*
  • For USB devices, use something like:
      - vendor: "1209"
        product: "000F"
  • For example, to expose a CH340 serial converter:
    name: ch340
      - usb:
          - vendor: "1a86"
            product: "7523"
  • The device flag can specify lists of devices that should be grouped and mounted into a container together as one single meta-device.
  • For example, to allocate and mount an audio capture device:
    name: capture
      - paths:
          - path: /dev/snd/pcmC0D0c
          - path: /dev/snd/controlC0
  • A "count" can be specified to allow a discovered device group to be scheduled multiple times.
  • For example, to permit allocation of the FUSE device 10 times:
    name: fuse
      - count: 10
          - path: /dev/fuse
  • Note: if omitted, "count" is assumed to be 1

See values.yaml for an example configuration file.


Important: When deploying an application Helm chart you can add more values from the bjw-s common library chart here

Key Type Default Description string See values.yaml generic-device-plugin config file [ref]
config.enabled bool true Enables the config file ConfigMap
controller.type string "daemonset" Sets the controller type
env object See values.yaml Environment variables [ref]
env.DOMAIN string "" The domain to use when declaring devices
image.pullPolicy string "Always" Image pull policy
image.repository string "" Image repository
image.tag string "latest" Image tag object See values.yaml Host path volume bind to the dev dir
persistence.device-plugins object See values.yaml Host path volume bind to the Kubelet plugin directory
probes.liveness object {"path":"/health","type":"HTTP"} Configures liveness probe
probes.readiness object {"path":"/health","type":"HTTP"} Configures readiness probe
probes.startup object {"path":"/health","type":"HTTP"} Configures startup probe
securityContext.privileged bool true Privileged mode is required to access devices
service.main object See values.yaml Configures health/metrics service settings for the chart.
serviceMonitor.main.enabled bool false Enables or disables the serviceMonitor.
serviceMonitor.main.endpoints list See values.yaml Configures the endpoints for the serviceMonitor.

Autogenerated from chart metadata using helm-docs