OSDOCS-18372: DITA abstracts — KMM - #117165
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
@JoeAldinger: This pull request references OSDOCS-18372 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
🤖 Mon Aug 03 14:46:14 - Prow CI generated the docs preview: |
|
|
||
| KMM is compatible with hub and spoke environments through decoupling KMM features. A `ManagedClusterModule` custom resource definition (CRD) is provided to wrap the existing `Module` CRD and extend it to select Spoke clusters. Also provided is KMM-Hub, a new standalone controller that builds images and signs modules on the hub cluster. | ||
| [role="_abstract"] | ||
| Kernel Module Management in {product-title} hub-and-spoke deployments uses Red{nbsp}Hat Advanced Cluster Management (RHACM) to build and sign modules on the hub while loading them on spoke clusters. A `ManagedClusterModule` custom resource extends the `Module` CRD to target spoke clusters with resource-constrained KMM installations. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.
There was a problem hiding this comment.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.
There was a problem hiding this comment.
|
|
||
| KMM-Hub runs all compute-intensive tasks such as image builds and kmod signing, and prepares the trimmed-down `Module` to be transferred to the spokes through RHACM. | ||
| [role="_abstract"] | ||
| KMM-Hub is a hub-cluster edition of Kernel Module Management for {product-title} multi-cluster deployments. It monitors spoke kernel versions, runs image builds and kmod signing on the hub, and delivers trimmed `Module` resources to spokes through RHACM. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.
|
|
||
| After installing Kernel Module Management (KMM) on the spoke, no further action is required. Create a `ManagedClusterModule` object from the hub to deploy kernel modules on spoke clusters. | ||
| [role="_abstract"] | ||
| To run Kernel Module Management (KMM) on spoke clusters in {product-title}, you can install it with a Red Hat Advanced Cluster Management (RHACM) `Policy` object. After installation, create a `ManagedClusterModule` object from the hub to deploy kernel modules. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.
There was a problem hiding this comment.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.
There was a problem hiding this comment.
|
|
||
| You can use Kernel Module Management (KMM) to build kernel modules that can be loaded or unloaded into the kernel on demand. These modules extend the functionality of the kernel without the need to reboot the system. Modules can be configured as built-in or dynamically loaded. | ||
| [role="_abstract"] | ||
| Kernel Module Management (KMM) on {product-title} loads out-of-tree (OOT) kernel modules on demand without rebooting nodes. You can replace loaded in-tree modules by setting `.spec.moduleLoader.container.inTreeModulesToRemove` in the `Module` CR. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'on-demand' rather than 'on demand'. For more information, see RedHat.TermsErrors.
|
@JoeAldinger: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Summary
Rewrites
[role="_abstract"]short descriptions for Kernel Module Management (KMM) assembly and modules from OSDOCS-18372 (59 files). Addresses AsciiDocDITA.ShortDescription.Jira
https://redhat.atlassian.net/browse/OSDOCS-18372
Versions
4.20+
Merge order
Independent branch from main (abstracts only). Preferred first among OSDOCS-18372 DITA series; rebase later series if same-file conflicts.
Files changed
See PR files list (59 KMM assembly/module files).
Vale rules addressed
Notes
Made with Cursor