Add documentation for filesToSign wildcard and glob pattern support#1748
Conversation
Doc update for the new glob support feature when signing kmods - explicit paths and Bash globs paths.
✅ Deploy Preview for openshift-kmm ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: TomerNewman The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/assign @ybettan @yevgeny-shnaidman |
WalkthroughDocumentation updates clarifying the signing configuration requirements and specifications for the filesToSign field, including supported input formats (full paths and Bash glob patterns), path constraints relative to dirName, and expanded narrative on kmod loading behavior based on MOK and secure-boot status. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
/uncc @bthurber @enriquebelarte |
openshift-ci
bot
requested review from
ybettan and
yevgeny-shnaidman
and removed request for
bthurber and
enriquebelarte
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/mkdocs/documentation/secure_boot.md`:
- Line 117: The sentence contains a grammatical error "nodes with that match the
selector"; update the text to read "nodes that match the selector" (or
alternately "nodes with that selector") so the sentence becomes: "KMM should
then load the signed kmods onto all the nodes that match the selector." Locate
and replace the phrase in the secure_boot.md content where "nodes with that
match the selector" appears.
🧹 Nitpick comments (1)
docs/mkdocs/documentation/deploy_kmod.md (1)
241-241: Align terminology with secure_boot.md for consistency.The phrase "Bash shell absolute globs" is confusing because globs are patterns, not paths. In
secure_boot.md(line 152), this is phrased more clearly as "Bash shell glob(s)". Additionally, using "absolute paths" here whilesecure_boot.mduses "full path(s)" creates unnecessary inconsistency.📝 Suggested terminology alignment
- # Required when sign is set. Use absolute paths or Bash shell absolute globs (e.g. /opt/lib/modules/<kernel-version>/*.ko), see Secure Boot docs. + # Required when sign is set. Use full path(s) or Bash shell glob(s) (e.g. /opt/lib/modules/<kernel-version>/*.ko), see Secure Boot docs.
|
|
||
| All paths in `filesToSign` must be under the directory defined by **`dirName`** in the same `moduleLoader.container.modprobe` (default `/opt`). | ||
|
|
||
| KMM should then load the signed kmods onto all the nodes with that match the selector. |
There was a problem hiding this comment.
Fix grammatical error.
The phrase "nodes with that match" is grammatically incorrect.
✏️ Proposed fix
-KMM should then load the signed kmods onto all the nodes with that match the selector.
+KMM should then load the signed kmods onto all the nodes that match the selector.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| KMM should then load the signed kmods onto all the nodes with that match the selector. | |
| KMM should then load the signed kmods onto all the nodes that match the selector. |
🤖 Prompt for AI Agents
In `@docs/mkdocs/documentation/secure_boot.md` at line 117, The sentence contains
a grammatical error "nodes with that match the selector"; update the text to
read "nodes that match the selector" (or alternately "nodes with that selector")
so the sentence becomes: "KMM should then load the signed kmods onto all the
nodes that match the selector." Locate and replace the phrase in the
secure_boot.md content where "nodes with that match the selector" appears.
|
/retest |
|
Fixes #1746 |
|
/lgtm |
openshift-merge-bot
bot
merged commit 1ec2ff1
into
rh-ecosystem-edge:main
3 participants
Doc update for the new glob support feature when signing kmods - explicit paths and Bash globs paths.
Summary by CodeRabbit