Skip to content

✨ ClusterExtensionConfig API - #2163

Merged
anik120 merged 5 commits into
operator-framework:mainfrom
perdasilva:bundle-config-api
Aug 28, 2025
Merged

✨ ClusterExtensionConfig API#2163
anik120 merged 5 commits into
operator-framework:mainfrom
perdasilva:bundle-config-api

Conversation

@perdasilva

@perdasilvaperdasilva commented Aug 26, 2025

Copy link
Copy Markdown
Contributor

Description

  • Adds the .spec.config stanza to the experimental ClusterExtension API as a discriminated union with a single type: "Inline"
  • Updates Single/OwnNamespace to take the watchNamespace configuration from .spec.config.inline
  • Updates the Single/OwnNamespace docs
  • The facility to configure the watchNamespace via annotation is left in temporarily in order to not disrupt downstream tests. Once they have been updated to use .spec.config, the annotation facility will be removed.

Example

apiVersion: olm.operatorframework.io/v1
kind: ClusterExtension
metadata:
name: test
spec:
namespace: test
serviceAccount:
name: test-installer
config:
configType: Inline
inline:
watchNamespace: some-namespace
source:
sourceType: Catalog
catalog:
packageName: test-operator

Reviewer Checklist

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

@openshift-ciopenshift-ciBot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 26, 2025
@perdasilvaperdasilva changed the title Bundle config api✨ Bundle config apiAug 26, 2025
@netlify

netlifyBot commented Aug 26, 2025

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commit6ebde89
🔍 Latest deploy loghttps://app.netlify.com/projects/olmv1/deploys/68b0043b17e8e2000889bcf7
😎 Deploy Previewhttps://deploy-preview-2163--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.

@codecov

codecovBot commented Aug 26, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 81.08108% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.71%. Comparing base (3b5e6fb) to head (6ebde89).
⚠️ Report is 6 commits behind head on main.

Files with missing linesPatch %Lines
api/v1/zz_generated.deepcopy.go61.11%7 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #2163 +/- ##
==========================================
+ Coverage 72.67% 72.71% +0.04% 
==========================================
Files 79 79 Lines 7340 7378 +38 ==========================================
+ Hits 5334 5365 +31 - Misses 1659 1666 +7 
Partials 347 347 
FlagCoverage Δ
e2e44.14% <8.10%> (-0.12%)⬇️
experimental-e2e56.16% <51.35%> (+1.32%)⬆️
unit58.20% <51.35%> (-0.02%)⬇️

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.

@perdasilvaperdasilva changed the title ✨ Bundle config api✨ ClusterExtensionConfig APIAug 26, 2025
@perdasilva
perdasilvaforce-pushed the bundle-config-api branch 2 times, most recently from 544b420 to 5dd6ee0CompareAugust 26, 2025 14:29
@perdasilva
perdasilva marked this pull request as ready for review August 26, 2025 14:31
@perdasilva
perdasilva requested a review from a team as a code ownerAugust 26, 2025 14:31
@openshift-ciopenshift-ciBot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 26, 2025
Comment threadapi/v1/clusterextension_types.go Outdated
Comment threadapi/v1/clusterextension_types.go
Comment threadinternal/operator-controller/applier/helm.go Outdated
Comment threadmanifests/boxcutter-e2e.yaml Outdated
Comment threadmanifests/boxcutter-e2e.yaml Outdated
@perdasilva
perdasilvaforce-pushed the bundle-config-api branch 2 times, most recently from 5c921e0 to a78b3a5CompareAugust 26, 2025 15:16
Comment threadapi/v1/clusterextension_types.go Outdated
Per Goncalves da Silva added 3 commits August 26, 2025 18:15
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
@joelanford

Copy link
Copy Markdown
Member

/approve

@openshift-ciopenshift-ciBot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 26, 2025
//
// config is optional. When not specified, the default configuration of the resolved bundle will be used.
//
// <opcon:experimental>

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.

Look at that experimental tag...

@tmshort

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Aug 26, 2025
@openshift-ciopenshift-ciBot removed the lgtm Indicates that a PR is ready to be merged. label Aug 26, 2025
@tmshort

Copy link
Copy Markdown
Contributor

/lgtm

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

tmshort commented Aug 26, 2025

Copy link
Copy Markdown
Contributor

/hold

@openshift-ciopenshift-ciBot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 26, 2025
Per Goncalves da Silva added 2 commits August 28, 2025 09:24
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
@openshift-ciopenshift-ciBot removed the lgtm Indicates that a PR is ready to be merged. label Aug 28, 2025
@perdasilvaperdasilva removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 28, 2025

@anik120anik120 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 Aug 28, 2025
@openshift-ci

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: anik120, joelanford

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

@anik120
anik120 merged commit d95f426 into operator-framework:mainAug 28, 2025
26 checks passed
anik120 added a commit to anik120/operator-controller that referenced this pull request Sep 16, 2025
With operator-framework#2166 and operator-framework#2163 in place, annotation based config support can be removed.
Signed-off-by: Anik Bhattacharjee <anbhatta@redhat.com>
anik120 added a commit to anik120/operator-controller that referenced this pull request Sep 16, 2025
With operator-framework#2166 and operator-framework#2163 in place, annotation based config support can be removed.
Signed-off-by: Anik Bhattacharjee <anbhatta@redhat.com>
anik120 added a commit to anik120/operator-controller that referenced this pull request Sep 17, 2025
With operator-framework#2166 and operator-framework#2163 in place, annotation based config support can be removed.
Signed-off-by: Anik Bhattacharjee <anbhatta@redhat.com>
openshift-merge-botBot pushed a commit that referenced this pull request Sep 17, 2025
* OPRUN-4106: remove support for annotation based config
With #2166 and #2163 in place, annotation based config support can be removed.
Signed-off-by: Anik Bhattacharjee <anbhatta@redhat.com>
* update docs and demo to use new config spec
---------
Signed-off-by: Anik Bhattacharjee <anbhatta@redhat.com>
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.

4 participants

@perdasilva@joelanford@tmshort@anik120