Skip to content

Commit 8b7c262

Browse files
committed
documentation for kmm supporting also intree kmod
Following the latest feature addition that allows KMM to support intree kmods, this commit adds documentation for it.
1 parent c6522af commit 8b7c262

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/mkdocs/documentation/deploy_kmod.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,24 @@ spec:
103103
The worker Pod will first try to unload the in-tree `mod_b` before loading `mod_a` from the kmod image.
104104
When the worker Pod is terminated and `mod_a` is unloaded, `mod_b` will not be loaded again.
105105

106+
### Supporting Modules without OOT kmods
107+
In some cases, there is a need to configure the KMM Module to avoid loading an out-of-tree kernel module and
108+
instead use the in-tree one, running only the device plugin.
109+
In such cases, the moduleLoader can be omitted from the Module custom resource, leaving only the devicePlugin section.
110+
111+
```yaml
112+
apiVersion: kmm.sigs.x-k8s.io/v1beta1
113+
kind: Module
114+
metadata:
115+
name: my-kmod
116+
spec:
117+
selector:
118+
node-role.kubernetes.io/worker: ""
119+
devicePlugin:
120+
container:
121+
image: some.registry/org/my-device-plugin:latest
122+
```
123+
106124
### Example resource
107125

108126
Below is an annotated `Module` example with most options set.

0 commit comments

Comments
 (0)