[release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) #1034

openshift-cherrypick-robot · 2025-07-08T14:58:43Z

This is an automated cherry-pick of #1030

/assign tmshort

…Vs (#3597) * (bugfix): reduce frequency of update requests for CSVs by adding annotations to copied CSVs that are populated with hashes of the non-status fields and the status fields. This seems to be how this was intended to work, but was not actually working this way because the annotations never actually existed on the copied CSV. This resulted in a hot loop of update requests being made on all copied CSVs. Signed-off-by: everettraven <[email protected]> * update unit tests Signed-off-by: everettraven <[email protected]> * updates to test so far Signed-off-by: everettraven <[email protected]> * Small changes Signed-off-by: Brett Tofel <[email protected]> * Add metadata drift guard to copyToNamespace Since we switched to a PartialObjectMetadata cache to save memory, we lost visibility into copied CSV spec and status fields, and the reintroduced nonStatusCopyHash/statusCopyHash annotations only partially solved the problem. Manual edits to a copied CSV could still go undetected, causing drift without reconciliation. This commit adds two new annotations: olm.operatorframework.io/observedGeneration and olm.operatorframework.io/observedResourceVersion. It implements a mechanism to guard agains metadata drift at the top of the existing-copy path in copyToNamespace. If a stored observedGeneration or observedResourceVersion no longer matches the live object, the operator now: • Updates the spec and hash annotations • Updates the status subresource • Records the new generation and resourceVersion in the guard annotations Because the guard only fires when its annotations are already present, all existing unit tests pass unchanged. We preserve the memory benefits of the metadata‐only informer, avoid extra GETs, and eliminate unnecessary API churn. Future work may explore a WithTransform informer to regain full object visibility with minimal memory impact. Signed-off-by: Brett Tofel <[email protected]> * Tests for metadata guard Verifies that exactly three updates (spec, status, guard) are issued when the observedGeneration doesn’t match. Signed-off-by: Brett Tofel <[email protected]> * Persist observed annotations on all status updates Signed-off-by: Brett Tofel <[email protected]> * GCI the file Signed-off-by: Brett Tofel <[email protected]> * Use TransformFunc Unit tests not updated Signed-off-by: Todd Short <[email protected]> * Update operatorgroup tests to compile Signed-off-by: Todd Short <[email protected]> * Restore operatorgroup_test from master Remove metadatalister Signed-off-by: Todd Short <[email protected]> * Remove more PartialObjectMetadata Signed-off-by: Todd Short <[email protected]> * Remove hashes from operator_test Signed-off-by: Todd Short <[email protected]> * Fix error messages for static-analysis Signed-off-by: Todd Short <[email protected]> * Update test annotations and test client Signed-off-by: Todd Short <[email protected]> * Rename pruning to listerwatcher Signed-off-by: Todd Short <[email protected]> * Set resync to 6h Signed-off-by: Todd Short <[email protected]> * Add CSV copy revert syncer Signed-off-by: Todd Short <[email protected]> * Log tweaks Signed-off-by: Todd Short <[email protected]> * Consolidate revert and gc syncers Signed-off-by: Todd Short <[email protected]> * Add logging and reduce the amount of metadata in the TransformFunc Signed-off-by: Todd Short <[email protected]> * Handle the copy CSV revert via a requeue of the primary CSV Signed-off-by: Todd Short <[email protected]> * Revert "Set resync to 6h" This reverts commit 855f940a2199bd4071c51f14ef44728550bf13cf. Signed-off-by: Todd Short <[email protected]> * Add delete handler for copied csv Signed-off-by: Todd Short <[email protected]> * Revert whitespace change Signed-off-by: Todd Short <[email protected]> * Rename function, fix comment Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: everettraven <[email protected]> Signed-off-by: Brett Tofel <[email protected]> Signed-off-by: Todd Short <[email protected]> Co-authored-by: everettraven <[email protected]> Co-authored-by: Brett Tofel <[email protected]> Upstream-repository: operator-lifecycle-manager Upstream-commit: d055f28750cf62f966f566d36990fff5285c7a71 (cherry picked from commit bc111a9)

openshift-ci-robot · 2025-07-08T14:58:55Z

@openshift-cherrypick-robot: Jira Issue OCPBUGS-58259 has been cloned as Jira Issue OCPBUGS-58882. Will retitle bug to link to clone.
/retitle [release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) [release-4.19]

In response to this:

This is an automated cherry-pick of #1030

/assign tmshort

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2025-07-08T14:59:12Z

@openshift-cherrypick-robot: This pull request references Jira Issue OCPBUGS-58882, which is invalid:

expected dependent Jira Issue OCPBUGS-58259 to be in one of the following states: VERIFIED, RELEASE PENDING, CLOSED (ERRATA), CLOSED (CURRENT RELEASE), CLOSED (DONE), CLOSED (DONE-ERRATA), but it is ON_QA instead
expected dependent Jira Issue OCPBUGS-58259 to target a version in 4.19.0, 4.19.z, but it targets "4.19" instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

This is an automated cherry-pick of #1030

/assign tmshort

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 openshift-eng/jira-lifecycle-plugin repository.

tmshort · 2025-07-08T15:01:50Z

/retitle [release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597)

tmshort · 2025-07-08T15:02:38Z

/jira refresh

openshift-ci-robot · 2025-07-08T15:02:43Z

@tmshort: This pull request references Jira Issue OCPBUGS-58882, which is invalid:

expected dependent Jira Issue OCPBUGS-58259 to be in one of the following states: VERIFIED, RELEASE PENDING, CLOSED (ERRATA), CLOSED (CURRENT RELEASE), CLOSED (DONE), CLOSED (DONE-ERRATA), but it is ON_QA instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

/jira refresh

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 openshift-eng/jira-lifecycle-plugin repository.

tmshort · 2025-07-08T15:03:20Z

/approve

openshift-ci · 2025-07-08T15:03:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: openshift-cherrypick-robot, tmshort

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~DOWNSTREAM_OWNERS~~ [tmshort]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci · 2025-07-08T18:15:22Z

@openshift-cherrypick-robot: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

tmshort · 2025-07-08T19:25:52Z

/lgtm

tmshort · 2025-07-09T14:20:50Z

/jira refresh

openshift-ci-robot · 2025-07-09T14:20:59Z

@tmshort: This pull request references Jira Issue OCPBUGS-58882, which is valid. The bug has been moved to the POST state.

7 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.18.z) matches configured target version for branch (4.18.z)
bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)
release note text is set and does not match the template
dependent bug Jira Issue OCPBUGS-58259 is in the state Verified, which is one of the valid states (VERIFIED, RELEASE PENDING, CLOSED (ERRATA), CLOSED (CURRENT RELEASE), CLOSED (DONE), CLOSED (DONE-ERRATA))
dependent Jira Issue OCPBUGS-58259 targets the "4.19.z" version, which is one of the valid target versions: 4.19.0, 4.19.z
bug has dependents

Requesting review from QA contact:
/cc @kuiwang02

In response to this:

/jira refresh

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 openshift-eng/jira-lifecycle-plugin repository.

oceanc80 · 2025-07-09T14:41:04Z

/label backport-risk-assessed

tmshort · 2025-07-09T14:44:09Z

/hold

jianzhangbjz · 2025-07-11T06:43:50Z

Test passed,
/unhold

openshift-ci-robot · 2025-07-11T06:48:15Z

@openshift-cherrypick-robot: Jira Issue OCPBUGS-58882: All pull requests linked via external trackers have merged:

openshift/operator-framework-olm#1034

Jira Issue OCPBUGS-58882 has been moved to the MODIFIED state.

In response to this:

This is an automated cherry-pick of #1030

/assign tmshort

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-bot · 2025-07-11T07:55:06Z

[ART PR BUILD NOTIFIER]

Distgit: operator-lifecycle-manager
This PR has been included in build operator-lifecycle-manager-container-v4.18.0-202507110703.p0.g4a26a7e.assembly.stream.el9.
All builds following this will include this PR.

openshift-bot · 2025-07-11T07:55:08Z

[ART PR BUILD NOTIFIER]

Distgit: operator-registry
This PR has been included in build operator-registry-container-v4.18.0-202507110703.p0.g4a26a7e.assembly.stream.el9.
All builds following this will include this PR.

openshift-bot · 2025-07-11T08:01:05Z

[ART PR BUILD NOTIFIER]

Distgit: ose-operator-framework-tools
This PR has been included in build ose-operator-framework-tools-container-v4.18.0-202507110703.p0.g4a26a7e.assembly.stream.el9.
All builds following this will include this PR.

tmshort · 2025-07-11T12:48:52Z

/cherry-pick release-4.17

openshift-cherrypick-robot · 2025-07-11T12:49:45Z

@tmshort: #1034 failed to apply on top of branch "release-4.17":

Applying: bug: OCPBUGS-37982: Reduce Frequency of Update Requests for Copied CSVs (#3597)
Using index info to reconstruct a base tree...
M	staging/operator-lifecycle-manager/pkg/controller/operators/catalog/operator.go
M	staging/operator-lifecycle-manager/pkg/controller/operators/olm/operator.go
M	staging/operator-lifecycle-manager/pkg/controller/operators/olm/operatorgroup.go
M	vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog/operator.go
M	vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/operator.go
M	vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/operatorgroup.go
M	vendor/modules.txt
Falling back to patching base and 3-way merge...
Auto-merging vendor/modules.txt
Auto-merging vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/operatorgroup.go
Auto-merging vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/operator.go
CONFLICT (content): Merge conflict in vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/operator.go
Removing vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/internal/pruning/listerwatcher.go
Auto-merging vendor/github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog/operator.go
Auto-merging staging/operator-lifecycle-manager/pkg/controller/operators/olm/operatorgroup.go
Auto-merging staging/operator-lifecycle-manager/pkg/controller/operators/olm/operator.go
CONFLICT (content): Merge conflict in staging/operator-lifecycle-manager/pkg/controller/operators/olm/operator.go
Removing staging/operator-lifecycle-manager/pkg/controller/operators/internal/pruning/listerwatcher.go
Auto-merging staging/operator-lifecycle-manager/pkg/controller/operators/catalog/operator.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 bug: OCPBUGS-37982: Reduce Frequency of Update Requests for Copied CSVs (#3597)

In response to this:

/cherry-pick release-4.17

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-cherrypick-robot assigned tmshort Jul 8, 2025

openshift-cherrypick-robot mentioned this pull request Jul 8, 2025

OCPBUGS-58259: Reduce Frequency of Update Requests for Copied CSVs (#3597) [release-4.19] #1030

Merged

openshift-ci bot changed the title ~~[release-4.18] OCPBUGS-58259: Reduce Frequency of Update Requests for Copied CSVs (#3597) [release-4.19]~~ [release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) [release-4.19] Jul 8, 2025

openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Jul 8, 2025

openshift-ci bot requested review from ankitathomas and dinhxuanvu July 8, 2025 14:59

openshift-ci bot changed the title ~~[release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) [release-4.19]~~ [release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) Jul 8, 2025

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 8, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 8, 2025

openshift-ci-robot added jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Jul 9, 2025

openshift-ci bot requested a review from kuiwang02 July 9, 2025 14:21

openshift-ci bot added the backport-risk-assessed Indicates a PR to a release branch has been evaluated and considered safe to accept. label Jul 9, 2025

openshift-ci bot assigned bandrade, emmajiafan and jianzhangbjz Jul 9, 2025

openshift-ci bot assigned KeenonLee, kuiwang02 and Xia-Zhao-rh Jul 9, 2025

openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 9, 2025

openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 11, 2025

openshift-merge-bot bot merged commit 4a26a7e into openshift:release-4.18 Jul 11, 2025
13 checks passed

[release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) #1034

[release-4.18] OCPBUGS-58882: Reduce Frequency of Update Requests for Copied CSVs (#3597) #1034

Uh oh!

Conversation

openshift-cherrypick-robot commented Jul 8, 2025

Uh oh!

openshift-ci-robot commented Jul 8, 2025

Uh oh!

openshift-ci-robot commented Jul 8, 2025

Uh oh!

tmshort commented Jul 8, 2025

Uh oh!

tmshort commented Jul 8, 2025

Uh oh!

openshift-ci-robot commented Jul 8, 2025

Uh oh!

tmshort commented Jul 8, 2025

Uh oh!

openshift-ci bot commented Jul 8, 2025

Uh oh!

openshift-ci bot commented Jul 8, 2025

Uh oh!

tmshort commented Jul 8, 2025

Uh oh!

tmshort commented Jul 9, 2025

Uh oh!

openshift-ci-robot commented Jul 9, 2025

Uh oh!

oceanc80 commented Jul 9, 2025

Uh oh!

tmshort commented Jul 9, 2025

Uh oh!

jianzhangbjz commented Jul 11, 2025

Uh oh!

Uh oh!

openshift-ci-robot commented Jul 11, 2025

Uh oh!

openshift-bot commented Jul 11, 2025

Uh oh!

openshift-bot commented Jul 11, 2025

Uh oh!

openshift-bot commented Jul 11, 2025

Uh oh!

tmshort commented Jul 11, 2025

Uh oh!

openshift-cherrypick-robot commented Jul 11, 2025

Uh oh!

Uh oh!