nudl

Node Usb Device Labeler - label Kubernetes nodes according to their USB devices.

Usage

Apply the example configuration

kubectl apply -f https://raw.githubusercontent.com/leonnicolas/nudl/main/example.yaml

Configure the Labeler

Usage of ./nudl:
      --hostname string         Hostname of the node on which this process is running
      --human-readable          use human readable label names instead of hex codes, possibly not all codes can be translated (default true)
      --kubeconfig string       path to kubeconfig
      --label-prefix string     prefix for labels (default "nudl.squat.ai")
      --listen-address string   listen address for prometheus metrics server (default ":8080")
      --log-level string        Log level to use. Possible values: all, debug, info, warn, error, none (default "info")
      --no-contain strings      list of strings, usb devices containing these case-insensitive strings will not be considered for labeling
      --update-time duration    renewal time for labels in seconds (default 10s)
      --usb-debug int           libusb debug level (0..3)

Label USB devices

If --human-readable=false, vendor and device codes will be four hex characters each. The generated label will be of the form:

<label_prefix>/<vendor>_<device>=true

for example:

nudl.squat.ai/04f2_b420=true

Otherwise nudl will try to translate the vendor and device codes into human readable strings using the usbid package, which uses http://www.linux-usb.org/usb.ids. If the codes are not found, the name defaults to Unknown. Since some characters are not allowed in Kubernetes labels, forbidden characters are converted into "-".

The above example would look like:

nudl.squat.ai/Chicony-Electronics-Co.--Ltd_Unknown:true

Check out http://www.linux-usb.org/usb-ids.html for more information about what devices are known.

Exclude USB devices

Use the --no-contain flag to exclude USB devices that can be ignored, e.g. USB hubs.

Outside the cluster

docker run --rm -v ~/.kube:/mnt leonnicolas/nudl --kubeconfig /mnt/k3s.yaml --hostname example_host

Images

Images can be found on Docker Hub leonnicolas/nudl and GitHub Container Registry ghcr.io/leonnicolas/nudl.