mirrors/talos-extensions
1
0
Fork 0
mirror of https://github.com/siderolabs/extensions.git synced 2026-05-05 12:16:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: add usb modem drivers

Browse Source 
new extension that adds the required drivers to operate usb modems under Talos.

Based on #167

Signed-off-by: Noel Georgi <git@frezbo.dev>
This commit is contained in:
Roee Klinger 2023-06-08 02:53:42 +03:00 committed by Noel Georgi
parent f05c9975c9
commit 4cee34c585
No known key found for this signature in database
GPG Key ID: 21A9F444075C9E36
7 changed files with 160 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Makefile
View File

@ -18,7 +18,7 @@ endif
# keep in sync with Pkgfile
BLDR_RELEASE ?= v0.2.0
PKGS ?= v1.5.0-alpha.0-17-g702d7a7
PKGS ?= v1.5.0-alpha.0-25-ga56d15a
BUILD := docker buildx build
PLATFORM ?= linux/amd64,linux/arm64
@ -51,7 +51,8 @@ TARGETS = \
nut-client \
nvidia-container-toolkit \
nvidia-fabricmanager \
nvidia-open-gpu-kernel-modules
nvidia-open-gpu-kernel-modules \
usb-modem-drivers
# Temporarily disabled, as mellanox-ofed fails to build with Linux 6.1
# mellanox-ofed \

11
README.md
View File

@ -25,7 +25,7 @@ All system extensions provided by Sidero Labs can be found in the [ghcr.io regis
| Name | Image | Description | Version Format |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------- | --------------------------- | ------------------------ |
| [amd-ucode](firmware/amd-ucode/) | [ghcr.io/siderolabs/amd-ucode](https://github.com/siderolabs/extensions/pkgs/container/amd-ucode) | AMD CPU microcode updates | `linux firmware version` |
| [i915-ucode](firmware/i915-ucode/) | [ghcr.io/siderolabs/i915-ucode](https://github.com/siderolabs/extensions/pkgs/container/i915-ucode) | Intel GPU firmware | `linux firmware version` |
| [i915-ucode](firmware/i915-ucode/) | [ghcr.io/siderolabs/i915-ucode](https://github.com/siderolabs/extensions/pkgs/container/i915-ucode) | Intel GPU firmware | `linux firmware version` |
| [bnx2-bnx2x](firmware/bnx2-bnx2x/) | [ghcr.io/siderolabs/bnx2-bnx2x](https://github.com/siderolabs/extensions/pkgs/container/bnx2-bnx2x) | Broadcom NetXtreme firmware | `linux firmware version` |
| [intel-ucode](firmware/intel-ucode/) | [ghcr.io/siderolabs/intel-ucode](https://github.com/siderolabs/extensions/pkgs/container/intel-ucode) | Intel CPU microcode updates | `upstream version` |
@ -35,13 +35,14 @@ All system extensions provided by Sidero Labs can be found in the [ghcr.io regis
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ----------------------------------------------------- |
| [gasket](drivers/gasket/) | [ghcr.io/siderolabs/gasket-driver](https://github.com/siderolabs/extensions/pkgs/container/gasket-driver) | Driver for Google Coral PCIe devices | `gasket driver upstream short commit`-`talos version` |
| [nvidia](nvidia-gpu/nvidia-modules/) | [ghcr.io/siderolabs/nvidia-open-gpu-kernel-modules](https://github.com/siderolabs/extensions/pkgs/container/nvidia-open-gpu-kernel-modules) | NVIDIA OSS Driver | `nvidia driver upstream version`-`talos version` |
| [usb-modem](drivers/usb-modem) | [ghcr.io/siderolabs/usb-modem-drivers](https://github.com/siderolabs/extensions/pkgs/container/usb-modem-drivers) | USB Modem drivers | `talos version` |
### Storage
| Name | Image | Description | Version Format |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------- | -------------- |
| [iscsi-tools](storage/iscsi-tools/) | [ghcr.io/siderolabs/iscsi-tools](https://github.com/siderolabs/extensions/pkgs/container/iscsi-tools) | Open iSCSI tools | `v0.1.0` |
| [drbd](storage/drbd/) *disabled* | [ghcr.io/siderolabs/drbd](https://github.com/siderolabs/extensions/pkgs/container/drbd) | DRBD driver module | `v0.1.0` |
| Name | Image | Description | Version Format |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------- |
| [iscsi-tools](storage/iscsi-tools/) | [ghcr.io/siderolabs/iscsi-tools](https://github.com/siderolabs/extensions/pkgs/container/iscsi-tools) | Open iSCSI tools | `v0.1.0` |
| [drbd](storage/drbd/) *disabled* | [ghcr.io/siderolabs/drbd](https://github.com/siderolabs/extensions/pkgs/container/drbd) | DRBD driver module | `upstream version`-`talos version` |
### Power

113
drivers/usb-modem/README.md Normal file
View File

@ -0,0 +1,113 @@
# usb-modem-drivers extension
## Installation
Add the extension to your machine config and enable the modules, your modem might not require
all of them, so feel free to remove the ones that are not needed:
```yaml
machine:
install:
extensions:
- image: ghcr.io/siderolabs/usb-modem-drivers:<VERSION>
kernel:
modules:
- name: usbserial
- name: option
- name: cdc_mbim
- name: qmi_wwan
- name: usb_wwan
- name: usbnet
- name: ax88796b
- name: asix
- name: ax88179_178a
- name: cdc_ether
- name: cdc_ncm
- name: net1080
- name: cdc_subset
- name: belkin_sa
- name: zaurus
- name: cdc_wdm
- name: rtl8153_ecm
```
## Verifiying
You can verify the modules are enabled by reading the `/proc/modules` where it _should_ show the module is live.
For example:
```
❯ talosctl -n 192.168.32.5 read /proc/modules
usbnet 20480 - - Live 0xffffffffc01c9000 (O)
cdc_wdm 94208 - - Live 0xffffffffc01aa000 (O)
...
...
```
In addition, if your USB module is installed and you have a USB modem connected to the system, you should be able to verify it's presence at `/dev/cdc-wdm1` or see a new network interface at `wwan1`.
For example:
```
❯ talosctl -n 192.168.32.5 ls -l /dev/cdc-wdm1
NODE MODE UID GID SIZE(B) LASTMOD NAME
192.168.32.5 Dcrw-rw---- 0 44 0 Sep 10 18:15:52 /dev/cdc-wdm1
```
or
```
❯ talosctl -n 192.168.32.5 dmesg
# look for lines like these:
kern: info: [2023-06-07T16:40:10.189868521Z]: usbcore: registered new interface driver usbhid
kern: info: [2023-06-07T16:40:10.190066521Z]: option 6-1.2:1.3: GSM modem (1-port) converter detected
kern: info: [2023-06-07T16:40:10.265654521Z]: usb 6-1.2: GSM modem (1-port) converter now attached to ttyUSB7
kern: info: [2023-06-07T16:40:10.280291521Z]: qmi_wwan 6-1.2:1.4: cdc-wdm1: USB WDM device
```
## Configurtion
Talos currently does not have an OS level method of dialing up cellular modems, such as `ModemManager` or `uqmi`, so you will
probably want to ignore it on the system level, pass the modems `/dev/` devices to a pod, and dial it up there using a tool such
as `ModemManager` or `uqmi`.
First, ignore the interface on the Talos level, so Talos doesn't try to bring it up:
```yaml
machine:
network:
interfaces:
- interface: wwan1 # The modem interface name, if you have several modems, you can optionally use deviceSelector instead.
ignore: true # ignore the interface.
```
Next, you can create a pod that might contain something like this:
```yaml
apiVersion: v1
kind: Pod
metadata:
name: ModemManager
namespace: modems # you might have to adjust your security settings for this namespace
spec:
hostNetwork: true
nodeName: modems-server
containers:
- name: ubuntu-container
image: ubuntu:latest
command: ["/bin/bash", "-c", "--"]
args: ["while true; do sleep 30; done;"]
securityContext:
privileged: true
volumeMounts:
- name: dev
mountPath: /dev/
volumes:
- name: dev
hostPath:
path: /dev/ttyUSB1 # you might want to mount all of the /dev/ttyUSB* and /dev/cdc-wdm* devices
type: Directory
```
Now the modem should be available to you normally on the pod.

13
drivers/usb-modem/manifest.yaml Normal file
View File

@ -0,0 +1,13 @@
version: v1alpha1
metadata:
name: usb-modem
version: "$VERSION"
author: Sidero Labs
description: |
This system extension provides USB modem drivers kernel modules built against a specific Talos version.
This driver is required for USB modems to function. This extension includes all the drivers needed to
operate any USB modem under Linux, but your device might not require all of them. Read your device's
docs to learn which drivers you need, or just enable them all as a starting point.
compatibility:
talos:
version: ">= v1.4.5"

22
drivers/usb-modem/pkg.yaml Normal file
View File

@ -0,0 +1,22 @@
name: usb-modem-drivers
variant: scratch
shell: /toolchain/bin/bash
dependencies:
- stage: base
# The pkgs version for a particular release of Talos as defined in
# https://github.com/siderolabs/talos/blob/<talos version>/pkg/machinery/gendata/data/pkgs
- image: "{{ .PKGS_PREFIX }}/usb-modem-drivers-pkg:{{ .BUILD_ARG_PKGS }}"
steps:
- prepare:
- |
sed -i 's#$VERSION#{{ .VERSION }}#' /pkg/manifest.yaml
- install:
- |
mkdir -p /rootfs/lib/modules
cp -R /lib/modules/* /rootfs/lib/modules
finalize:
- from: /rootfs
to: /rootfs
- from: /pkg/manifest.yaml
to: /

1
drivers/usb-modem/vars.yaml Normal file
View File

@ -0,0 +1 @@
VERSION: "{{ .BUILD_ARG_TAG }}"

4
power/nut-client/pkg.yaml
View File

@ -7,7 +7,7 @@ dependencies:
- image: "{{ .PKGS_PREFIX }}/util-linux:{{ .BUILD_ARG_PKGS }}"
steps:
- sources:
- url: https://github.com/networkupstools/nut/releases/download/v{{ .NUT_VERSION }}/nut-{{ .NUT_VERSION }}.tar.gz
- url: https://github.com/networkupstools/nut/releases/download/v{{ .NUT_VERSION }}-signed/nut-{{ .NUT_VERSION }}.tar.gz
destination: nut.tar.gz
sha256: c3e5a708da797b7c70b653d37b1206a000fcb503b85519fe4cdf6353f792bfe5
sha512: 3c413ae54088045a713eb80cf1bdda474f41bb3b67c7c0248aa7a0c4d441dce1ff42627a2735273d7e36892d1f2eeb895220cf28af63fec2fa0c7a267f82d577
@ -15,7 +15,7 @@ steps:
- |
sed -i 's#$VERSION#{{ .VERSION }}#' /pkg/manifest.yaml
- |
tar -xzf nut.tar.gz --strip-components=1
tar -xf nut.tar.gz --strip-components=1
- |
# no shell for you
patch -p1 < /pkg/patches/replace_system.patch