fix: #3146 Support close open/fail for Ready Tracker & surface errors swallowed by grp.Wait() #3308
Conversation
This file contains 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
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
2 times, most recently
from
0b9e1f4
to
96644d8
Compare
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
2 times, most recently
from
25e891e
to
2c5000d
Compare
maxsmythe
reviewed
Mar 28, 2024
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
2 times, most recently
from
e1fa4a6
to
cbfcfc8
Compare
David-Jaeyoon-Lee
changed the title
|
Separating out constraint template v1beta1 -> v1 changes in separate PR. |
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
3 times, most recently
from
77559ff
to
7c5e5a0
Compare
maxsmythe
approved these changes
Apr 10, 2024
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3308 +/- ##
==========================================
- Coverage 54.49% 46.65% -7.85%
==========================================
Files 134 218 +84
Lines 12329 14833 +2504
==========================================
+ Hits 6719 6920 +201
- Misses 5116 7101 +1985
- Partials 494 812 +318
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
2 times, most recently
from
1705b33
to
aa2b049
Compare
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
from
c9601c0
to
7d63dbf
Compare
ritazh
reviewed
Apr 13, 2024
ritazh
reviewed
Apr 13, 2024
|
Thanks for the PR @David-Jaeyoon-Lee |
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
3 times, most recently
from
ab0fdbb
to
bf1ac93
Compare
pkg/readiness/ready_tracker.go
Outdated
| @@ -45,7 +45,7 @@ import ( | |||
| logf "sigs.k8s.io/controller-runtime/pkg/log" | |||
| ) | |||
|
|
|||
| var crashOnFailureFetchingExpectations = flag.Bool("crash-on-failure-fetching-expectations", false, "When set (defaults to false), gatekeeper will ignore errors that occur when gathering expectations. This prevents bootstrapping errors from crashing Gatekeeper at the cost of increasing the risk Gatekeeper will under-enforce policy by serving before it has loaded in all policies. Enabling this will help prevent under-enforcement at the risk of crashing during startup for issues like network errors.") | |||
| var crashOnFailureFetchingExpectations = flag.Bool("crash-on-failure-fetching-expectations", false, "When set (defaults to false), gatekeeper will ignore errors that occur when gathering expectations. This prevents bootstrapping errors from crashing Gatekeeper at the cost of increasing the risk Gatekeeper will under-enforce policy by serving before it has loaded in all policies. Enabling this will help prevent under-enforcement at the risk of crashing during startup for issues like network errors. Note that enabling this flag currently does not achieve the aforementioned effect since fetching expectations are set to retry until success so failures during fetching expectations currently do not occurr.") | |||
There was a problem hiding this comment.
@maxsmythe Just wanted to double check this wording
There was a problem hiding this comment.
"When set" -> "unless set"
|
@ritazh Here are the requested changes! let me know if there is anything else that needs to be changes :) |
maxsmythe
approved these changes
Apr 27, 2024
pkg/readiness/ready_tracker.go
Outdated
| @@ -45,7 +45,7 @@ import ( | |||
| logf "sigs.k8s.io/controller-runtime/pkg/log" | |||
| ) | |||
|
|
|||
| var crashOnFailureFetchingExpectations = flag.Bool("crash-on-failure-fetching-expectations", false, "When set (defaults to false), gatekeeper will ignore errors that occur when gathering expectations. This prevents bootstrapping errors from crashing Gatekeeper at the cost of increasing the risk Gatekeeper will under-enforce policy by serving before it has loaded in all policies. Enabling this will help prevent under-enforcement at the risk of crashing during startup for issues like network errors.") | |||
| var crashOnFailureFetchingExpectations = flag.Bool("crash-on-failure-fetching-expectations", false, "When set (defaults to false), gatekeeper will ignore errors that occur when gathering expectations. This prevents bootstrapping errors from crashing Gatekeeper at the cost of increasing the risk Gatekeeper will under-enforce policy by serving before it has loaded in all policies. Enabling this will help prevent under-enforcement at the risk of crashing during startup for issues like network errors. Note that enabling this flag currently does not achieve the aforementioned effect since fetching expectations are set to retry until success so failures during fetching expectations currently do not occurr.") | |||
There was a problem hiding this comment.
"When set" -> "unless set"
|
May need to wrap fakeClient in a mutex to prevent the race condition, also there are lint errors |
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
2 times, most recently
from
fc45d15
to
1b69eac
Compare
|
I still need to fix lint errors for the Error return value is not checked for the goroutine deleted object polling. Any ideas on how to fix this? @maxsmythe |
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
from
1b69eac
to
ef710df
Compare
Add fail-close support for fetching expectations by adding error handling & surfacing the errors being swallowed by grp.Wait(). Signed-off-by: David-Jaeyoon-Lee <[email protected]>
Remove the starting hyphen from the crash-on-failure-fetching-expectations flag Signed-off-by: David-Jaeyoon-Lee <[email protected]>
and add unit tests Fix comments and return error in trackConfigAndSyncSets. Add unit tests for each track method & each wait in Run method. Signed-off-by: David-Jaeyoon-Lee <[email protected]>
in test Signed-off-by: David-Jaeyoon-Lee <[email protected]>
David-Jaeyoon-Lee
force-pushed
the
davjlee/refactor/ready-tracker
branch
from
ef710df
to
f6ee82e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it:
This change fixes Run() method in Ready Tracker to have a fail-close option so that if we fail to fetch expectations we surface those errors & fail. By default, this won't be enabled & we will fail-open.
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #3146
Special notes for your reviewer: Refer to issue link for more information