Fixing the installation docs to install from the stable channel.#1744
Fixing the installation docs to install from the stable channel.#1744ybettan merged 1 commit intorh-ecosystem-edge:mainfrom
stable channel.#1744Conversation
✅ Deploy Preview for openshift-kmm ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughChanged OLM Subscription examples in documentation: switched channel from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
|
/retest |
cdvultur
left a comment
There was a problem hiding this comment.
Let's update the references in the Configuring Toleration sections also
docs/mkdocs/documentation/install.md
Outdated
There was a problem hiding this comment.
This one also needs updated to stable
docs/mkdocs/documentation/install.md
Outdated
There was a problem hiding this comment.
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>
d1b594a to
e29c96b
Compare
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
🧩 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 usingchannel: release-1.0(notstable). (docs.redhat.com) - KMM Hub Operator (
name: kernel-module-management-hub): the Red Hat docs show the subscription usingchannel: stablewithsource: 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-marketplaceExample 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.0To 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 yamlCitations:
- 1: https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/specialized_hardware_and_driver_enablement/kernel-module-management-operator
- 2: https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/specialized_hardware_and_driver_enablement/kernel-module-management-operator
- 3: https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/specialized_hardware_and_driver_enablement/kernel-module-management-operator
- 4: https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/specialized_hardware_and_driver_enablement/kernel-module-management-operator
🏁 Script executed:
cd docs/mkdocs/documentation && wc -l install.md && sed -n '25,55p' install.mdRepository: 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).
|
/retest |
|
/cherry-pick release-2.5 |
|
@ybettan: #1744 failed to apply on top of branch "release-2.5": 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 kubernetes-sigs/prow repository. |
|
2.5 cherry-pick: #1745 |
The old doc was installing from the
release-1.0channel which is outdated./assign @cdvultur
Summary by CodeRabbit