Skip to content

🌱 Add feature-gate kustomize files, docs, and demo for webhook support feature - #1996

Merged
openshift-merge-bot[bot] merged 4 commits into
operator-framework:mainfrom
perdasilva:webhook-support-docs-and-demo
May 29, 2025
Merged

🌱 Add feature-gate kustomize files, docs, and demo for webhook support feature#1996
openshift-merge-bot[bot] merged 4 commits into
operator-framework:mainfrom
perdasilva:webhook-support-docs-and-demo

Conversation

@perdasilva

Copy link
Copy Markdown
Contributor

Description

Adds docs and demo for webhook support feature

Reviewer Checklist

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

@perdasilva
perdasilva requested a review from a team as a code ownerMay 28, 2025 08:38
@netlify

netlifyBot commented May 28, 2025

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commit4be4236
🔍 Latest deploy loghttps://app.netlify.com/projects/olmv1/deploys/6836f262648cbd0007540cc2
😎 Deploy Previewhttps://deploy-preview-1996--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.

Per Goncalves da Silva added 3 commits May 28, 2025 10:44
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>
@perdasilva
perdasilvaforce-pushed the webhook-support-docs-and-demo branch from c5a968d to 0dd796bCompareMay 28, 2025 08:44
@codecov

codecovBot commented May 28, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.11%. Comparing base (71108b2) to head (4be4236).
Report is 6 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #1996 +/- ##
=======================================
Coverage 69.11% 69.11% =======================================
Files 79 79 Lines 7023 7023 =======================================
Hits 4854 4854 Misses 1887 1887 Partials 282 282 
FlagCoverage Δ
e2e43.11% <ø> (ø)
unit59.98% <ø> (ø)

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.

Comment threadconfig/overlays/featuregate/webhook-provider-certmanager/kustomization.yaml Outdated
@@ -0,0 +1,60 @@
#!/usr/bin/env bash

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.

We have : https://github.com/operator-framework/operator-controller/blob/main/.github/workflows/catalogd-demo.yaml

However, could we add a GitHub action to run all demos that we have been adding, so that we can avoid breaking any of them? It is nice because it seems like we end up covering the feature to prevent regressions.

@perdasilvaperdasilvaMay 28, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I worry about doing this for every PR as the number of demos will grow and this might get time consuming. I'm also not entirely convinced that breaking a demo should block a PR from merging to main. We may not want to release, but we shouldn't block progress because of something that can be solved separately, imo. So, maybe this is something we might want to bring up in the community meeting for discussion rather than solving in this PR?

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.

IHMO: If we broke the demo it is like an e2e test,
That means that something that was working stop to work
So, we need to start testing out.

But I either agree that it might be out of the scope of this one
We can create a follow up PR for that and discuss it 👍

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

For me, this is more of a "documentation is out of date" issue than a "we're not doing what we are supposed to do" issue. So, I'd be against adding this check on a PR basis:

  • e2es should already catch any regressions in behavior (the most important thing imo)
  • (as with e2es and unit tests) these will tend to grow in runtime with the number of features/demos added. I think it's worthwhile to have a PR pipeline that is as quick as possible.
  • I think it's unlikely that they will yield that many true positives because the failures will likely be around API surface changes (which should change infrequently, at least, after release). If we have false positives (issues with the demo script, dependencies, etc.) it's another set of problems that aren't related to the PR that can increase the lead time to merge.

So, I think from a cost/value perspective, it would be better to put this check on the critical path of the release job and run it once at the end, or have it as a periodic running once every week or two.

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.

Thanks for your comment – you made some good points! 😊
Just to share another view:

  • We tested one today and it worked fine, no flakes.
  • These tests check real features, like E2E, If something breaks, it’s probably the feature, not the docs.
    (However, +1 for a possible duplication since we can end up have e2e tests and demos doing the same)
  • Performance might be a problem later, but we can wait and see.

I think your opinion makes sense too, and it’s probably not something we need to fix now.
All good from my side!

@camilamacedo86camilamacedo86 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.

I have just two small suggestions: 😊

Everything else looks great to me! 🚀

It would be super helpful to get a review from @tmshort to double-check that the Kustomize changes are safe and won’t cause issues downstream.

Also, tagging @joelanford since he has a clear vision for how the Kustomize files should be organised: https://github.com/operator-framework/operator-controller/pull/1949/files

Thanks a lot! 🙌

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
@perdasilvaperdasilva changed the title 🌱 Add docs and demo for webhook support feature🌱 Add feature-gate kustomize files, docs, and demo for webhook support featureMay 28, 2025

@camilamacedo86camilamacedo86 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.

Hey @perdasilva 👋

I had another look at this one:

  • We’re just adding the kustomize files, so in theory, it shouldn’t break anything downstream 👍
  • Regarding the re-organisation in #1949 – I don’t think we should block this PR because of it. That effort might still evolve, and we can adjust later if needed.

So for me, everything looks good – LGTM 🚀

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

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

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 May 29, 2025
@@ -0,0 +1,62 @@
## Installation of Bundles containing Webhooks

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.

Hey @michaelryanpeter, just for your awareness — since we're adding more +1 drafts here. No pressure at all, just wanted to let you know it's there in case you have bandwidth later. We can always do follow-ups to improve it.

@openshift-merge-bot
openshift-merge-botBot merged commit d41ddd0 into operator-framework:mainMay 29, 2025
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.

2 participants

@perdasilva@camilamacedo86