Skip to content

📖 Clarify single controller assumption in OLM v1 design - #2372

Merged
openshift-merge-bot[bot] merged 1 commit into
operator-framework:mainfrom
joelanford:clarify-single-controller-assumption
Dec 4, 2025
Merged

📖 Clarify single controller assumption in OLM v1 design#2372
openshift-merge-bot[bot] merged 1 commit into
operator-framework:mainfrom
joelanford:clarify-single-controller-assumption

Conversation

@joelanford

Copy link
Copy Markdown
Member

Description

Updates the design decision documentation to explicitly state that exactly one controller should exist to reconcile an object, not just "a controller". This clarifies the expected behavior and configuration

Reviewer Checklist

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

Updates the design decision documentation to explicitly state that
exactly one controller should exist to reconcile an object, not just
"a controller". This clarifies the expected behavior and configuration
CopilotAI review requested due to automatic review settings December 4, 2025 14:46
@joelanford
joelanford requested a review from a team as a code ownerDecember 4, 2025 14:46
@netlify

netlifyBot commented Dec 4, 2025

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commite57a2fc
🔍 Latest deploy loghttps://app.netlify.com/projects/olmv1/deploys/69319eb70628160008be441d
😎 Deploy Previewhttps://deploy-preview-2372--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.

@rashmigottipatirashmigottipati left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Dec 4, 2025

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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 updates the OLM v1 design decisions documentation to clarify the controller reconciliation assumption by changing "a controller exists" to "exactly one controller exists" in the statement about user expectations for object reconciliation.

Key Changes

  • Modified line 34 to state users can expect "exactly one controller exists" rather than just "a controller exists" to reconcile objects they have RBAC to create

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/project/olmv1_design_decisions.md
@pedjak

Copy link
Copy Markdown
Contributor

/approve

@openshift-ci

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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

@openshift-ciopenshift-ciBot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 4, 2025
@codecov

codecovBot commented Dec 4, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.87%. Comparing base (4e349e6) to head (e57a2fc).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #2372 +/- ##
==========================================
+ Coverage 70.61% 74.87% +4.26% 
==========================================
Files 95 95 Lines 7375 7336 -39 ==========================================
+ Hits 5208 5493 +285 + Misses 1728 1409 -319 + Partials 439 434 -5 
FlagCoverage Δ
e2e44.85% <ø> (+0.21%)⬆️
experimental-e2e49.32% <ø> (?)
unit58.81% <ø> (+0.36%)⬆️

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.

@openshift-merge-bot
openshift-merge-botBot merged commit d44cbaf into operator-framework:mainDec 4, 2025
33 checks passed
- If an object for an API exists a controller WILL reconcile it, no matter where it is in the cluster.

OLM v1 will make the same assumption that Kubernetes does and that users of Kubernetes APIs do. That is: If a user has RBAC to create an object in the cluster, they can expect that a controller exists that will reconcile that object. If this assumption does not hold, it will be considered a configuration issue, not an OLM v1 bug.
OLM v1 will make the same assumption that Kubernetes does and that users of Kubernetes APIs do. That is: If a user has RBAC to create an object in the cluster, they can expect that exactly one controller exists that will reconcile that object. If this assumption does not hold, it will be considered a configuration issue, not an OLM v1 bug.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@joelanford
joelanford deleted the clarify-single-controller-assumption branch December 5, 2025 15:57
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@joelanford@pedjak@rashmigottipati@grokspawn