Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonnicolas/nkml
Kubernetes node labeler for kernel modules
https://github.com/leonnicolas/nkml
kernel-module kubernetes labels
Last synced: 3 months ago
JSON representation
Kubernetes node labeler for kernel modules
- Host: GitHub
- URL: https://github.com/leonnicolas/nkml
- Owner: leonnicolas
- License: mit
- Created: 2020-12-22T15:49:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-21T22:24:18.000Z (10 months ago)
- Last Synced: 2024-06-21T18:15:04.306Z (7 months ago)
- Topics: kernel-module, kubernetes, labels
- Language: Go
- Homepage:
- Size: 6.84 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nkml
Node Kernel Module Labeler - label Kubernetes nodes according to their kernel modules.
[](https://github.com/leonnicolas/nkml/actions/workflows/push.yaml)
[](https://hub.docker.com/r/leonnicolas/nkml)
## Usage
Apply the example configuration
```bash
kubectl apply -f https://raw.githubusercontent.com/leonnicolas/nkml/main/example.yaml
```
to label nodes with regard to the [WireGuard](https://www.wireguard.com/) kernel module.
### Configure the Labeler
```
Usage of ./nkml:
--hostname string Hostname of the node on which this process is running
--kubeconfig string path to kubeconfig
-m, --label-mod strings list of strings, kernel modules matching a string will be used as labels with values true, if found
--label-prefix string prefix for labels (default "nkml.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-clean-up Will not attempt to clean labels before shutting down
--update-time duration renewal time for labels in seconds (default 10s)
```
__Note:__ to check kernel modules, __nkml__ needs access to the file _/proc/modules_.
### Label Kernel Modules
You can label your nodes according to their kernel modules.
Use the `--label-mod` flag to pass a list of strings.
If a kernel module found in __/proc/modules__ matches one of the input strings, then the node will be given a label of the format:
```
/=true
```
for example:
```
nkml.squat.ai/wireguard=true
```
If the module is not found, the flag's value will be set to _false_.
### Outside the cluster
```bash
docker run --rm -v ~/.kube:/mnt leonnicolas/nkml --kubeconfig /mnt/k3s.yaml --label-mod="wireguard,fantasy" --hostname example_host
```
## Images
Images can be found on [Docker Hub](https://hub.docker.com/r/leonnicolas/nkml) `leonnicolas/nkml` and [GitHub Container Registry](https://ghcr.io) `ghcr.io/leonnicolas/nkml`.