-
Notifications
You must be signed in to change notification settings - Fork 70
📖 Clarify install mode docs #2430
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Clarify install mode docs #2430
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR enhances the OLM v1 documentation by clarifying the install mode requirements and recommendations. The change emphasizes that AllNamespaces is the preferred install mode while explaining that SingleNamespace and OwnNamespace modes are only supported for backwards compatibility with OLM v0, with a reference to the design decision about not fighting Kubernetes and its limitation of one CRD instance per cluster.
Key Changes:
- Restructured the install mode requirement to emphasize
AllNamespacesas the recommended mode - Added explanatory note about backwards compatibility support for other install modes and their limitations
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/project/olmv1_limitations.md
Outdated
|
|
||
| * **must** support installation via the `AllNamespaces`, `SingleNamespace`, or `OwnNamespace` install modes. | ||
| * **must** support installation via the `AllNamespaces` install mode. | ||
| * Note that `AllNamespaces` is the recommended install mode. OLMv1 supports `SingleNamespace` and `OwnNamespace` modes for `registry+v1` bundles for backwards compatibility with OLMv0, but these are not recommended install modes as there is a [hard limitation](https://operator-framework.github.io/operator-controller/project/olmv1_design_decisions/#do-not-fight-kubernetes) of only one instance of a given CRD in the cluster. |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The term "OLMv1" should be consistently written as "OLM v1" (with a space) to match the terminology used throughout the rest of the document. The same applies to "OLMv0" which should be "OLM v0".
| * Note that `AllNamespaces` is the recommended install mode. OLMv1 supports `SingleNamespace` and `OwnNamespace` modes for `registry+v1` bundles for backwards compatibility with OLMv0, but these are not recommended install modes as there is a [hard limitation](https://operator-framework.github.io/operator-controller/project/olmv1_design_decisions/#do-not-fight-kubernetes) of only one instance of a given CRD in the cluster. | |
| * Note that `AllNamespaces` is the recommended install mode. OLM v1 supports `SingleNamespace` and `OwnNamespace` modes for `registry+v1` bundles for backwards compatibility with OLM v0, but these are not recommended install modes as there is a [hard limitation](https://operator-framework.github.io/operator-controller/project/olmv1_design_decisions/#do-not-fight-kubernetes) of only one instance of a given CRD in the cluster. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2430 +/- ##
==========================================
- Coverage 73.05% 69.61% -3.45%
==========================================
Files 100 100
Lines 7641 7641
==========================================
- Hits 5582 5319 -263
- Misses 1623 1888 +265
+ Partials 436 434 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
rashmigottipati
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
pedjak
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/approve
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, pedjak, rashmigottipati 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 |
|
/override codecov/project |
|
@pedjak: Overrode contexts on behalf of pedjak: codecov/project 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. |
5227a12
into
operator-framework:main
Description
Clarify install mode docs to emphasize the design decision to not fight kubernetes.
Reviewer Checklist