Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/mkdocs/documentation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,11 @@ metadata:
name: kernel-module-management
namespace: openshift-kmm
spec:
channel: release-1.0
channel: stable
Copy link
Copy Markdown

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

installPlanApproval: Automatic
name: kernel-module-management
source: redhat-operators
sourceNamespace: openshift-marketplace
startingCSV: kernel-module-management.v1.0.0
```

### Configuring tolerations for KMM
Expand All @@ -62,12 +61,11 @@ metadata:
name: kernel-module-management
namespace: openshift-kmm
spec:
channel: release-1.0
channel: stable
installPlanApproval: Automatic
name: kernel-module-management
source: redhat-operators
sourceNamespace: openshift-marketplace
startingCSV: kernel-module-management.v1.0.0
config:
tolerations:
- key: "node.kubernetes.io/unschedulable"
Expand Down
Loading