Skip to content

Conversation

@oceanc80
Copy link
Contributor

@oceanc80 oceanc80 commented Jan 6, 2026

Description

Clarify install mode docs to emphasize the design decision to not fight kubernetes.

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

Copilot AI review requested due to automatic review settings January 6, 2026 21:14
@oceanc80 oceanc80 requested a review from a team as a code owner January 6, 2026 21:14
@netlify
Copy link

netlify bot commented Jan 6, 2026

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 80eb230
🔍 Latest deploy log https://app.netlify.com/projects/olmv1/deploys/695d8f5cd02b1900076d07aa
😎 Deploy Preview https://deploy-preview-2430--olmv1.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.

Copy link

Copilot AI left a 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 AllNamespaces as 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.


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

codecov bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.61%. Comparing base (bcb3d07) to head (80eb230).
⚠️ Report is 2 commits behind head on main.

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     
Flag Coverage Δ
e2e 46.76% <ø> (-0.09%) ⬇️
experimental-e2e 13.68% <ø> (-35.07%) ⬇️
unit 57.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@rashmigottipati rashmigottipati 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 Indicates that a PR is ready to be merged. label Jan 6, 2026
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 6, 2026
@openshift-ci openshift-ci bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 7, 2026
Copy link
Contributor

@pedjak pedjak left a comment

Choose a reason for hiding this comment

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

/approve

@openshift-ci
Copy link

openshift-ci bot commented Jan 7, 2026

[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

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

@pedjak
Copy link
Contributor

pedjak commented Jan 7, 2026

/override codecov/project

@openshift-ci
Copy link

openshift-ci bot commented Jan 7, 2026

@pedjak: Overrode contexts on behalf of pedjak: codecov/project

Details

In response to this:

/override codecov/project

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.

@openshift-merge-bot openshift-merge-bot bot merged commit 5227a12 into operator-framework:main Jan 7, 2026
28 of 29 checks passed
@oceanc80 oceanc80 deleted the update-docs branch January 7, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants