add description of values

This commit is contained in:
2024-12-30 17:03:45 -06:00
parent 11d3dd927b
commit d5bb83bf84
3 changed files with 15 additions and 14 deletions

View File

@@ -1,6 +1,6 @@
apiVersion: v2 apiVersion: v2
name: generic-device-plugin name: generic-device-plugin
version: 0.1.3 version: 0.1.4
description: Generic Device Plugin description: Generic Device Plugin
keywords: keywords:
- generic-device-plugin - generic-device-plugin
@@ -15,4 +15,4 @@ dependencies:
- name: common - name: common
repository: https://bjw-s.github.io/helm-charts/ repository: https://bjw-s.github.io/helm-charts/
version: 3.5.1 version: 3.5.1
appVersion: 0.1.3 appVersion: 0.1.4

View File

@@ -1,6 +1,6 @@
# generic-device-plugin # generic-device-plugin
![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![AppVersion: 0.1.3](https://img.shields.io/badge/AppVersion-0.1.3-informational?style=flat-square) ![Version: 0.1.4](https://img.shields.io/badge/Version-0.1.4-informational?style=flat-square) ![AppVersion: 0.1.4](https://img.shields.io/badge/AppVersion-0.1.4-informational?style=flat-square)
Generic Device Plugin Generic Device Plugin
@@ -25,18 +25,13 @@ Generic Device Plugin
| Key | Type | Default | Description | | Key | Type | Default | Description |
|-----|------|---------|-------------| |-----|------|---------|-------------|
| config | object | `{"data":"devices:\n - name: serial\n groups:\n - paths:\n - path: /dev/ttyUSB*\n - paths:\n - path: /dev/ttyACM*\n - paths:\n - path: /dev/tty.usb*\n - paths:\n - path: /dev/cu.*\n - paths:\n - path: /dev/cuaU*\n - paths:\n - path: /dev/rfcomm*\n - name: video\n groups:\n - paths:\n - path: /dev/video0\n - name: fuse\n groups:\n - count: 10\n paths:\n - path: /dev/fuse\n - name: audio\n groups:\n - count: 10\n paths:\n - path: /dev/snd\n - name: capture\n groups:\n - paths:\n - path: /dev/snd/controlC0\n - path: /dev/snd/pcmC0D0c\n - paths:\n - path: /dev/snd/controlC1\n mountPath: /dev/snd/controlC0\n - path: /dev/snd/pcmC1D0c\n mountPath: /dev/snd/pcmC0D0c\n - paths:\n - path: /dev/snd/controlC2\n mountPath: /dev/snd/controlC0\n - path: /dev/snd/pcmC2D0c\n mountPath: /dev/snd/pcmC0D0c\n - paths:\n - path: /dev/snd/controlC3\n mountPath: /dev/snd/controlC0\n - path: /dev/snd/pcmC3D0c\n mountPath: /dev/snd/pcmC0D0c\n","enabled":true}` | Config map |
| config.data | string | See [values.yaml](./values.yaml) | generic-device-plugin config file [[ref]](https://github.com/squat/generic-device-plugin#usage) | | config.data | string | See [values.yaml](./values.yaml) | generic-device-plugin config file [[ref]](https://github.com/squat/generic-device-plugin#usage) |
| config.enabled | bool | `true` | | | deviceDomain | string | `"squat.ai"` | Domain used by devices for identifcation |
| deviceDomain | string | `"squat.ai"` | | | image | object | `{"pullPolicy":"Always","repository":"ghcr.io/squat/generic-device-plugin","tag":"latest"}` | Default image |
| image.pullPolicy | string | `"Always"` | | | name | string | `"generic-device-plugin"` | Name override of release |
| image.repository | string | `"ghcr.io/squat/generic-device-plugin"` | | | resources | object | `{"limit":{"cpu":"100m","memory":"20Mi"},"requests":{"cpu":"50m","memory":"10Mi"}}` | Default resources |
| image.tag | string | `"latest"` | | | service | object | `{"listenPort":8080}` | Service port |
| name | string | `"generic-device-plugin"` | |
| resources.limit.cpu | string | `"100m"` | |
| resources.limit.memory | string | `"20Mi"` | |
| resources.requests.cpu | string | `"50m"` | |
| resources.requests.memory | string | `"10Mi"` | |
| service.listenPort | int | `8080` | |
---------------------------------------------- ----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

View File

@@ -1,15 +1,20 @@
# -- Name override of release
name: generic-device-plugin name: generic-device-plugin
# -- Default image
image: image:
repository: ghcr.io/squat/generic-device-plugin repository: ghcr.io/squat/generic-device-plugin
pullPolicy: Always pullPolicy: Always
tag: latest tag: latest
# -- Domain used by devices for identifcation
deviceDomain: squat.ai deviceDomain: squat.ai
# -- Service port
service: service:
listenPort: 8080 listenPort: 8080
# -- Default resources
resources: resources:
limit: limit:
cpu: 100m cpu: 100m
@@ -18,6 +23,7 @@ resources:
cpu: 50m cpu: 50m
memory: 10Mi memory: 10Mi
# -- Config map
config: config:
enabled: true enabled: true
# -- generic-device-plugin config file [[ref]](https://github.com/squat/generic-device-plugin#usage) # -- generic-device-plugin config file [[ref]](https://github.com/squat/generic-device-plugin#usage)