openstack: warn that overlays match by exact name - #1042
Draft
ideaship wants to merge 1 commit into
Draft
Conversation
The overlay section explains which locations are searched, but not what happens when a file does not match one of them. Nothing does: the file is not read, no warning is emitted, and the deployment succeeds while the settings have no effect. Operators therefore have no signal distinguishing "my override was applied" from "my override was ignored", and the failure is easy to hit because near-miss names look plausible. Both examples given are ones seen in the wild: an ml2_conf.ini placed at the overlays top level instead of under neutron/, and a neutron/ml2.conf that is simply a misspelling of ml2_conf.ini. In both cases the DNS and MTU settings they contained silently did nothing. Add a warning admonition next to the existing description of the supported locations, and suggest verifying the rendered configuration under /etc/kolla/SERVICENAME/ rather than assuming the overlay took effect. Assisted-by: Claude:claude-opus-5 Signed-off-by: Roger Luethi <luethi@osism.tech>
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 5 | 0 | 0 | 0.05s | |
| ✅ JSON | jsonlint | 4 | 0 | 0 | 0.11s | |
| ✅ JSON | prettier | 4 | 0 | 0 | 0.32s | |
| ✅ JSON | v8r | 4 | 0 | 0 | 8.56s | |
| ✅ MARKDOWN | markdownlint | 157 | 0 | 0 | 2.74s | |
| ✅ MARKDOWN | markdown-table-formatter | 157 | 0 | 0 | 0.39s | |
| ✅ REPOSITORY | betterleaks | yes | no | no | 0.65s | |
| ✅ REPOSITORY | checkov | yes | no | no | 18.14s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.05s | |
| ✅ REPOSITORY | secretlint | yes | no | no | 1.73s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 3.84s | |
| ✅ SPELL | codespell | 167 | 0 | 0 | 0.55s | |
| lychee | 167 | 1 | 0 | 28.63s | ||
| ✅ YAML | prettier | 6 | 0 | 0 | 0.36s | |
| ✅ YAML | v8r | 6 | 0 | 0 | 5.65s | |
| ✅ YAML | yamllint | 6 | 0 | 0 | 0.52s |
Detailed Issues
⚠️ SPELL / lychee - 1 error
📝 Summary
---------------------
🔍 Total..........880
🔗 Unique.........713
✅ Successful.....820
⏳ Timeouts........13
🔀 Redirected.......3
👻 Excluded........46
❓ Unknown..........0
🚫 Errors...........1
⛔ Unsupported......1
Errors in docs/appendix/security/ossa-2026-001.md
[TIMEOUT] https://bugs.launchpad.net/keystonemiddleware/+bug/2129018 (at 124:3) | Request timed out
Errors in docs/appendix/security/ossa-2026-002.md
[TIMEOUT] https://bugs.launchpad.net/nova/+bug/2137507 (at 111:3) | Request timed out
Errors in docs/appendix/security/ossa-2026-005.md
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2142138 (at 109:3) | Request timed out
Errors in docs/appendix/security/ossa-2026-015.md
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2148398 (at 174:3) | Request timed out
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2148477 (at 175:3) | Request timed out
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2149775 (at 176:3) | Request timed out
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2149789 (at 177:3) | Request timed out
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2150089 (at 178:3) | Request timed out
[TIMEOUT] https://bugs.launchpad.net/keystone/+bug/2150379 (at 179:3) | Request timed out
Errors in docs/appendix/security/ossa-2026-022.md
[TIMEOUT] https://bugs.launchpad.net/nova/+bug/2151252 (at 145:3) | Request timed out
Errors in docs/concepts/index.md
[ERROR] file://docs/concepts/metalbox#sonic-ztp (at 70:1) | File not found. Check if file exists and path is correct
Errors in docs/release-notes/osism-7.md
[TIMEOUT] https://www.openstack.org/software/openstack-bobcat (at 977:38) | Request timed out
Errors in docs/release-notes/osism-8.md
[TIMEOUT] https://www.openstack.org/software/openstack-caracal (at 222:38) | Request timed out
Errors in docs/release-notes/osism-9.md
[TIMEOUT] https://bugs.launchpad.net/kolla/+bug/2111620 (at 96:47) | Request timed out
Hint: Followed 3 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.
Notices
📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.6.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,JSON_JSONLINT,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_BETTERLEAKS,REPOSITORY_SECRETLINT,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,SPELL_CODESPELL,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

Show us your support by starring ⭐ the repository
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a warning admonition to the overlay section of the OpenStack configuration
guide: overlay files are matched by exact name and exact path, and a file
that matches none of the supported locations is silently ignored.
Why
The section explains which locations are searched, but not what happens when a
file does not match one of them. Nothing does — the file is not read, no warning
is emitted, and the deployment succeeds while the settings have no effect.
Operators therefore have no signal distinguishing "my override was applied" from
"my override was ignored", and the failure is easy to hit because near-miss
names look plausible.
How
Documents the two cases seen in the wild, both of which silently dropped the DNS
and MTU settings they carried:
environments/kolla/files/overlays/ml2_conf.ini—ml2_conf.iniis only readfrom the
neutron/subdirectory, so a copy at the top level does nothing.environments/kolla/files/overlays/neutron/ml2.conf— a misspelling ofml2_conf.ini; nothing matchesml2.conf.The admonition sits next to the existing description of the supported locations,
and suggests confirming the setting actually arrived by checking the generated
configuration under
/etc/kolla/SERVICENAME/rather than assuming the overlaytook effect.
Markdown-only addition to an existing page;
yarn buildhas not been runlocally.
Related
Independent of, but found in the same investigation as:
🤖 Generated with Claude Code