Summary
The list of configuration properties in CONFIG-PROPERTIES.md no longer matches what is actually defined in pkg/pillar/types/global.go. The document has become outdated, with wrong defaults, missing keys, and inconsistent naming or wording. It needs a full sync with the code to stay reliable.
What’s Wrong
Over time, many differences have crept in between the markdown file and the code. Some defaults in the doc are incorrect. For example, debug flags like debug.enable.usb and debug.enable.console are listed as false, while the code sets them to true.
Key names have drifted, such as kubernetes.drain.timeout in the doc versus kubevirt.drain.timeout in code.
Several keys are completely missing: things like extra memory and disk settings, log level and drain timeouts, goroutine leak detection, modem recovery flags, NetDump, and Prometheus metrics.
What to Do
Compare every entry in CONFIG-PROPERTIES.md with NewConfigItemSpecMap() in pkg/pillar/types/global.go.
Fix wrong defaults, rename or remove outdated keys, add missing ones, and mark deprecated items clearly.
Clarify TriState fields (enabled, disabled, none) and clean up wording.
Make it clear in the doc that the code is the single source of truth.
Summary
The list of configuration properties in
CONFIG-PROPERTIES.mdno longer matches what is actually defined inpkg/pillar/types/global.go. The document has become outdated, with wrong defaults, missing keys, and inconsistent naming or wording. It needs a full sync with the code to stay reliable.What’s Wrong
Over time, many differences have crept in between the markdown file and the code. Some defaults in the doc are incorrect. For example, debug flags like
debug.enable.usbanddebug.enable.consoleare listed asfalse, while the code sets them totrue.Key names have drifted, such as
kubernetes.drain.timeoutin the doc versuskubevirt.drain.timeoutin code.Several keys are completely missing: things like extra memory and disk settings, log level and drain timeouts, goroutine leak detection, modem recovery flags, NetDump, and Prometheus metrics.
What to Do
Compare every entry in
CONFIG-PROPERTIES.mdwithNewConfigItemSpecMap()inpkg/pillar/types/global.go.Fix wrong defaults, rename or remove outdated keys, add missing ones, and mark deprecated items clearly.
Clarify TriState fields (
enabled,disabled,none) and clean up wording.Make it clear in the doc that the code is the single source of truth.