Skip to content

Fixing the installation docs to install from the stable channel.#1744

Merged
ybettan merged 1 commit intorh-ecosystem-edge:mainfrom
ybettan:subscription-4.20
Feb 12, 2026
Merged

Fixing the installation docs to install from the stable channel.#1744
ybettan merged 1 commit intorh-ecosystem-edge:mainfrom
ybettan:subscription-4.20

Conversation

@ybettan
Copy link
Member

@ybettan ybettan commented Feb 12, 2026

The old doc was installing from the release-1.0 channel which is outdated.


/assign @cdvultur

Summary by CodeRabbit

  • Documentation
    • Updated OpenShift OLM Subscription examples to use the stable update channel.
    • Simplified examples by removing explicit starting-version entries, and adjusted toleration configuration examples to match the stable channel — making docs clearer and encouraging flexible automatic updates.

@netlify
Copy link

netlify bot commented Feb 12, 2026

Deploy Preview for openshift-kmm ready!

Name Link
🔨 Latest commit e29c96b
🔍 Latest deploy log https://app.netlify.com/projects/openshift-kmm/deploys/698da6388f358900084305f1
😎 Deploy Preview https://deploy-preview-1744--openshift-kmm.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Walkthrough

Changed OLM Subscription examples in documentation: switched channel from release-1.0 to stable and removed the explicit startingCSV field for kernel-module-management.v1.0.0. Docs-only change; no code behavior modified.

Changes

Cohort / File(s) Summary
Documentation
docs/mkdocs/documentation/install.md
Updated OLM Subscription examples: channel release-1.0stable; removed startingCSV: kernel-module-management.v1.0.0 entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

lgtm

Suggested reviewers

  • cdvultur
  • enriquebelarte
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly summarizes the main change: updating installation documentation to use the stable channel instead of release-1.0, which aligns perfectly with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ybettan ybettan removed the request for review from bthurber February 12, 2026 09:39
@ybettan
Copy link
Member Author

ybettan commented Feb 12, 2026

/retest

Copy link
Contributor

@cdvultur cdvultur left a comment

Choose a reason for hiding this comment

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

Let's update the references in the Configuring Toleration sections also

Copy link
Contributor

@cdvultur cdvultur Feb 12, 2026

Choose a reason for hiding this comment

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

This one also needs updated to stable

Copy link
Contributor

Choose a reason for hiding this comment

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

And this one also , needs removal

The old doc was installing from the `release-1.0` channel which is
outdated.

Signed-off-by: Yoni Bettan <yonibettan@gmail.com>
Copy link
Contributor

@cdvultur cdvultur left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Feb 12, 2026
@openshift-ci
Copy link

openshift-ci bot commented Feb 12, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cdvultur, ybettan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/mkdocs/documentation/install.md`:
- Line 41: The doc currently lists the spoke Kernel Module Management operator
with an incorrect channel; update the operator entry for name:
kernel-module-management (namespace openshift-kmm) to use channel: release-1.0
and add startingCSV: kernel-module-management.v1.0.0 so the spoke operator
matches Red Hat's required channel and initial CSV (do not use channel: stable
which is for the hub operator kernel-module-management-hub).

namespace: openshift-kmm
spec:
channel: release-1.0
channel: stable
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🌐 Web query:

kernel-module-management operator redhat-operators stable channel

💡 Result:

In the redhat-operators catalog, the Kernel Module Management content uses different channel names depending on which package you install:

  • Spoke / single-cluster KMM Operator (name: kernel-module-management): the Red Hat docs show the subscription using channel: release-1.0 (not stable). (docs.redhat.com)
  • KMM Hub Operator (name: kernel-module-management-hub): the Red Hat docs show the subscription using channel: stable with source: redhat-operators. (docs.redhat.com)

Example KMM Hub Subscription (stable channel):

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: kernel-module-management-hub
  namespace: openshift-kmm-hub
spec:
  channel: stable
  name: kernel-module-management-hub
  source: redhat-operators
  sourceNamespace: openshift-marketplace

(docs.redhat.com)

Example KMM (spoke) Subscription (release-1.0 channel):

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: kernel-module-management
  namespace: openshift-kmm
spec:
  channel: release-1.0
  name: kernel-module-management
  source: redhat-operators
  sourceNamespace: openshift-marketplace
  startingCSV: kernel-module-management.v1.0.0

(docs.redhat.com)

To confirm what channels your cluster currently sees from the catalog:

oc get packagemanifest kernel-module-management -n openshift-marketplace -o yaml
oc get packagemanifest kernel-module-management-hub -n openshift-marketplace -o yaml

Citations:


🏁 Script executed:

cd docs/mkdocs/documentation && wc -l install.md && sed -n '25,55p' install.md

Repository: rh-ecosystem-edge/kernel-module-management

Length of output: 1353


Correct the channel and restore startingCSV for the spoke operator.

This documentation is for the spoke Kernel Module Management operator (name: kernel-module-management, namespace openshift-kmm), not the hub variant. According to Red Hat's official OpenShift documentation, the spoke operator must use channel: release-1.0 and should include startingCSV: kernel-module-management.v1.0.0. The stable channel is for the hub operator (kernel-module-management-hub) only.

🤖 Prompt for AI Agents
In `@docs/mkdocs/documentation/install.md` at line 41, The doc currently lists the
spoke Kernel Module Management operator with an incorrect channel; update the
operator entry for name: kernel-module-management (namespace openshift-kmm) to
use channel: release-1.0 and add startingCSV: kernel-module-management.v1.0.0 so
the spoke operator matches Red Hat's required channel and initial CSV (do not
use channel: stable which is for the hub operator kernel-module-management-hub).

@ybettan
Copy link
Member Author

ybettan commented Feb 12, 2026

/retest

@ybettan ybettan merged commit ba24117 into rh-ecosystem-edge:main Feb 12, 2026
21 checks passed
@ybettan
Copy link
Member Author

ybettan commented Feb 12, 2026

/cherry-pick release-2.5

@openshift-cherrypick-robot

@ybettan: #1744 failed to apply on top of branch "release-2.5":

Applying: Fixing the installation docs to install from the `stable` channel.
Using index info to reconstruct a base tree...
M	docs/mkdocs/documentation/install.md
Falling back to patching base and 3-way merge...
Auto-merging docs/mkdocs/documentation/install.md
CONFLICT (content): Merge conflict in docs/mkdocs/documentation/install.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Fixing the installation docs to install from the `stable` channel.

Details

In response to this:

/cherry-pick release-2.5

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.

@ybettan
Copy link
Member Author

ybettan commented Feb 12, 2026

2.5 cherry-pick: #1745

@ybettan ybettan deleted the subscription-4.20 branch February 15, 2026 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants