feat: prevent Tasks in terminal state from leaking PVCs #93
Conversation
| } | ||
| found := &v1.PersistentVolumeClaim{} | ||
| err := r.Get(ctx, name, found) | ||
| if err == nil { |
There was a problem hiding this comment.
It would be more idiomatic Go, if you woul remove the nesting and check for a non-nil error after each operation, i.e., Get and Delete.
There was a problem hiding this comment.
Changed.
There was a problem hiding this comment.
I think there is more to do to become idiomatic, i.e.,
err := r.Get(ctx, name, found)
if err == nil {
...
}
return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err)
should be
err := r.Get(ctx, name, found)
if err != nil {
return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err)
}
...
There was a problem hiding this comment.
My bad, in rebasing I realized I had a local commit that I might have forgotten to push before re-requesting the review; so obviously it had not changed for you!
There was a problem hiding this comment.
Thank you for submitting your first PR to Carbyne Stack!
Please add yourself to the NOTICE.md file and have a look at the additional comments provided.
I will try to get to it during the week, thanks for the reviews! |
Thanks. Please let us know when we should have another look by re-requesting our review. |
|
I didn't get the error that go.mod triggers for the tests in the CI in my machine when running make test. |
This was a nasty one. See #94 for the solution. My takeaway: Always pin down all dependencies; "latest" is evil 😈. @adrian-vaca-humanes-wt can you please rebase to master. |
| } | ||
| found := &v1.PersistentVolumeClaim{} | ||
| err := r.Get(ctx, name, found) | ||
| if err == nil { |
There was a problem hiding this comment.
I think there is more to do to become idiomatic, i.e.,
err := r.Get(ctx, name, found)
if err == nil {
...
}
return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err)
should be
err := r.Get(ctx, name, found)
if err != nil {
return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err)
}
...
| found := &v1.PersistentVolumeClaim{} | ||
| err := r.Get(ctx, name, found) | ||
| if err != nil { | ||
| return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err) |
There was a problem hiding this comment.
I think the message here is a bit misleading. I would rather suggest: "to be deleted persistent volume claim not found for task %v: %w"
| if err != nil { | ||
| return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err) | ||
| } | ||
| logger.V(logging.DEBUG).Info("Persistent Volume Claim already exists") |
There was a problem hiding this comment.
This logging statement can be deleted. The log entry of line 392 is enough to cover the happy path.
| return fmt.Errorf("persistent volume claim deletion failed for task %v: %w", key, err) | ||
| } | ||
|
|
||
| logger.V(logging.DEBUG).Info("Deleted Persistent Volume Claim for task %v", key) |
There was a problem hiding this comment.
Test fails (see https://github.com/carbynestack/klyshko/actions/runs/11569275970/job/32208185307) here as it should be:
logger.V(logging.DEBUG).Info("Deleted Persistent Volume Claim for task")
The task identifier is injected by the logger already (see line 375).
There was a problem hiding this comment.
Code LGTM but @adrian-vaca-humanes-wt you should still add yourself to the NOTICE.md file 😃.
(Grouped by company; alphabetical order)
adrian-vaca-humanes-wt
force-pushed
the
clean-up-pvcs
branch
from
332a7e7 to
2a5ffe2
Compare
Done! P.S. Had to force-push to fix the signatures for the DCO check. |
|
Hi @adrian-vaca-humanes-wt, there is still one commit that is not signed, i.e., 2850294. This commit is from me and is there on master already, where it is signed and signed off. How did you bring that commit into your branch? Seems not by means of a rebase. Could you please fix that? |
I did a rebase on master after checking it from upstream. If it's possible to retain your signature, I really don't know how. |
|
Hm. After the rebase my commit should not be part of your PR commit history at all, right? You could try to drop that commit and then do the rebase again. Be sure that it is really a rebase and not a merge commit. If that doesn't work, a workaround would be to branch of from |
Signed-off-by: Adrian Vaca Humanes <[email protected]>
Signed-off-by: Adrian Vaca Humanes <[email protected]>
Signed-off-by: Adrian Vaca Humanes <[email protected]>
Signed-off-by: Adrian Vaca Humanes <[email protected]>
Signed-off-by: Adrian Vaca Humanes <[email protected]>
adrian-vaca-humanes-wt
force-pushed
the
clean-up-pvcs
branch
from
b1dcc68 to
03ed7c5
Compare
Hopefully it's good now! And you are right, I might have pulled before pushing making the rebase effectively a merge then. |
prevent tasks in terminal state from leaking PVCs Signed-off-by: Adrian Vaca Humanes <[email protected]>
Running in EKS and GKE with otherwise default storage configuration, we have observed leaked PVCs. This change ought to prevent that from happening by eagerly deleting them.