-
Notifications
You must be signed in to change notification settings - Fork 165
OCPBUGS-64688: use ObservedGeneration to determine Progressing status #1169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sg00dwin
wants to merge
1
commit into
openshift:main
Choose a base branch
from
sg00dwin:OCPBUGS-64688-progressing-true-during-node-reboot
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+7
−7
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -211,13 +211,13 @@ func (co *consoleOperator) sync_v400(ctx context.Context, controllerContext fact | |||||
|
|
||||||
| statusHandler.AddCondition(status.HandleProgressing("SyncLoopRefresh", "InProgress", func() error { | ||||||
| version := os.Getenv("OPERATOR_IMAGE_VERSION") | ||||||
| // Only report Progressing=True when the deployment is actually rolling out | ||||||
| // or the operator version is changing. Do NOT report Progressing just because | ||||||
| // resources were updated during reconciliation, as per the API guidelines: | ||||||
| // "Operators should not report Progressing when they are reconciling (without action) | ||||||
| // a previously known state." | ||||||
| if !deploymentsub.IsAvailableAndUpdated(actualDeployment) { | ||||||
| return fmt.Errorf("working toward version %s, %v replicas available", version, actualDeployment.Status.AvailableReplicas) | ||||||
| // Only report Progressing when the deployment controller hasn't yet | ||||||
| // processed a spec change made by the operator. Do not use replica | ||||||
| // counts — they fluctuate during external disruptions (node reboots) | ||||||
| // that the operator did not cause. See https://issues.redhat.com/browse/OCPBUGS-64688 | ||||||
| if actualDeployment.Status.ObservedGeneration < actualDeployment.Generation { | ||||||
| return fmt.Errorf("deployment generation %d not yet observed (current: %d)", | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The parenthetical says "current" but passes ObservedGeneration. Consider changing the wording to make it more accurate:
Suggested change
|
||||||
| actualDeployment.Generation, actualDeployment.Status.ObservedGeneration) | ||||||
| } | ||||||
|
|
||||||
| if co.versionGetter.GetVersions()["operator"] != version { | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sg00dwin Could you add some unit tests for the new behavior?
The old IsAvailableAndUpdated at least had its own unit tests in deployment_test.go. The new inline comparison ObservedGeneration < Generation has no test coverage. A table-driven test with cases like: - ObservedGeneration == Generation → no error (not progressing) - ObservedGeneration < Generation → returns error (progressing) - ObservedGeneration > Generation → no error (edge case, already processed)
would help prevent regressions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd also be considering adding an e2e to one of the upgrade jobs? If we can write one that isn't a giant pain.