Skip to content

OSDOCS-18372: DITA abstracts — KMM - #117165

Open
JoeAldinger wants to merge 1 commit into
openshift:mainfrom
JoeAldinger:osdocs-18372-dita-abstracts-1
Open

OSDOCS-18372: DITA abstracts — KMM#117165
JoeAldinger wants to merge 1 commit into
openshift:mainfrom
JoeAldinger:osdocs-18372-dita-abstracts-1

Conversation

@JoeAldinger

@JoeAldinger JoeAldinger commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

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

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted
  • File list supplied from Jira ticket MODULES (attachment download blocked in agent environment)

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 3, 2026
@openshift-ci-robot

openshift-ci-robot commented Aug 3, 2026

Copy link
Copy Markdown

@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.

Details

In response to this:

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

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted
  • File list supplied from Jira ticket MODULES (attachment download blocked in agent environment)

Made with Cursor

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.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 3, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown


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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'on-demand' rather than 'on demand'. For more information, see RedHat.TermsErrors.

@openshift-ci

openshift-ci Bot commented Aug 3, 2026

Copy link
Copy Markdown

@JoeAldinger: all tests passed!

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants