Skip to content

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

Sign up for GitHub

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

Merged
openshift-merge-bot merged 2 commits into from
Jan 7, 2026
Merged

📖 Clarify install mode docs #2430

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
938db74
Clarify install mode docs
oceanc80 Jan 6, 2026
80eb230
Consistent terminology
oceanc80 Jan 6, 2026
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
3 changes: 2 additions & 1 deletion docs/project/olmv1_limitations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ hide:
Currently, OLM v1 only supports installing operators packaged in [OLM v0 bundles](https://olm.operatorframework.io/docs/tasks/creating-operator-bundle/)
, also known as `registry+v1` bundles. Additionally, the bundled operator, or cluster extension:

* **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.
Copy link

Copilot AI Jan 6, 2026

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

Suggested change
* 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.

Copilot uses AI. Check for mistakes.
* **must not** declare dependencies using any of the following file-based catalog properties:
* `olm.gvk.required`
* `olm.package.required`
Expand Down