Do not use context.Background() on write requests to the k8s API #5649
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
|
Jenkins test this please |
thbkrkr
approved these changes
May 17, 2022
cmd/manager/main.go
Outdated
| gcCtx := tracing.NewContextTransaction(ctx, tracer, "garbage-collection", "on_operator_start", nil) | ||
| err := garbageCollectUsers(gcCtx, cfg, managedNamespaces) | ||
| if err != nil { | ||
| log.Error(err, "user garbage collector failed") |
There was a problem hiding this comment.
Nit: we are going to log twice user garbage collector failed:
2022-05-17T10:09:35.427+0200 ERROR manager user garbage collector failed {
"service.version": "2.3.0-SNAPSHOT+6b671559",
"error": "user garbage collector creation failed: root_error_message"
}
Suggested change
| log.Error(err, "user garbage collector failed") | |
| log.Error(err) |
There was a problem hiding this comment.
I think that method signature does not exist but I can adjust the message a bit to avoid the repetition.
Closed
fantapsody
pushed a commit
to fantapsody/cloud-on-k8s
that referenced
this pull request
Feb 7, 2023
…stic#5649) Introduces the correct context into all requests made with the k8s client-go library that do not use the cache. So the rule is: Create, Update, Delete need a correct context. List, Get do not because the cached client dismisses the context argument anyway. I added one where it was in scope but did not do additional refactoring to introduce one where there was not context in scope. The main motivation for the distinction between reads and writes is to limit scope of the refactoring somewhat.
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.
This is preparatory work for #5467
It introduces the correct context into all requests made with the k8s client-go library that do not use the cache. So the rule is
Create,Update,Deleteneed a correct contextList,Getdo not because the cached client dismisses the context argument anyway. I added one where it was in scope but did not do additional refactoring to introduce one where there was no context in scope.The main motivation for the distinction between reads and writes is to limit scope of the refactoring somewhat.
This will allow us in a next step to add tracing for k8s client requests (sneak preview of how that will look like):
Note for reviewers
This is probably bit of a nightmare to review given the repetitive nature of the change and large change set. Things of interest to focus on could be:
asyncTasksthat are run from the manager/main.go to introduce context and start transactions. This probably worth a closer look and also worth following into the individual tasks like the license info reporter and the telemetry reporter etc.