Skip to content

Sync CONFIG-PROPERTIES.md with pkg/pillar/types/global.go #5298

@OhmSpectator

Description

@OhmSpectator

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workinggood first issueGood for newcomershacktoberfestIssues for those who wants to participate in Hacktoberfest

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions