docs
docs copied to clipboard
Document valid values for the `RESIN_HOST_ODMDATA_configuration` configuration variable (and maybe other vars too)
The following page nicely and helpfully lists the configuration variables available for each device type, including the RESIN_HOST_ODMDATA_configuration configuration variable of Nvidia devices:
https://www.balena.io/docs/reference/supervisor/configuration-list/jetson-tx2/
For device types: 'astro-tx2', 'blackboard-tx2', 'jetson-tx2', 'n310-tx2', 'n510-tx2', 'orbitty-tx2', 'spacely-tx2' and 'srd3-tx2'.
However, it does not document that the only valid values are 1 to 6. When users set it to an invalid value such as 0, the result is:
- balena-os/balena-supervisor/issues/1915
- JF Pattern: RESIN_HOST_ODMDATA_configuration var on TX2 devices
The source of truth of valid values for this and other variables appears to be: https://github.com/balena-io/open-balena-api/blob/v0.203.0/src/features/vars-schema/env-vars.ts#L230-L239
It would be nice if the extraction of valid values could be somehow automated.
[pdcastro] This issue has attached support thread https://jel.ly.fish/62d1dd5d-cad0-49a5-918e-851a795045fc
Thanks for opening this detailled issue @pdcastro I worked on the configuration lists and am aware of this issue. There are several configurations options that we support but maintaining a list manually of valid values seemed like a huge task that I couldn't cover in MVP. There are just to many vendor configuration available out there (or not available publically) for us to automate. I could add this to the description of the configuration variable or as an example? Would that be an appropriate workaround?