[Misc]: ignore AlreadyExists and NotFound in controller operations #1507
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @googs1025, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the robustness and idempotency of Kubernetes controller operations by gracefully handling common API errors. Specifically, it modifies the pod creation and deletion logic within the podset and roleset controllers to ignore AlreadyExists errors during creation and NotFound errors during deletion. This prevents the controller from returning an error when the desired state (pod created or deleted) has already been achieved, leading to more stable and resilient reconciliation loops.
Highlights
- Idempotent Pod Creation: The controller now checks for AlreadyExists errors when attempting to create a pod. If the pod already exists, the operation is skipped, preventing an error.
- Idempotent Pod Deletion: Similarly, when deleting pods, the controller now ignores NotFound errors, ensuring that if a pod is already gone, the deletion attempt doesn't result in an error.
- Batch Operation Robustness: These error handling improvements are applied to both individual pod reconciliation in podset_controller.go and batch pod operations in roleset/utils.go, enhancing the overall stability of the controllers.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request improves the idempotency of controller operations by ignoring AlreadyExists errors on resource creation and NotFound errors on resource deletion. The changes in pkg/controller/podset/podset_controller.go are correct and follow best practices.
However, I've found a critical data race issue in pkg/controller/roleset/utils.go within the deletePodsInBatch function due to incorrect variable scoping in a concurrent context. Please see my detailed comment for the fix.
pkg/controller/roleset/utils.go
Outdated
| return utils.SlowStartBatch(len(podsToDelete), PodOperationInitBatchSize, func(index int) error { | ||
| return cli.Delete(ctx, podsToDelete[index]) | ||
| pod := podsToDelete[index] | ||
| err = cli.Delete(ctx, pod) |
There was a problem hiding this comment.
This assignment to err can cause a data race. err is a named return variable of deletePodsInBatch, and SlowStartBatch runs this function concurrently. Multiple goroutines writing to this variable is a race condition.
You should declare a new local variable by using := instead of =. This will shadow the outer err variable and make the operation safe for concurrent execution.
| err = cli.Delete(ctx, pod) | |
| err := cli.Delete(ctx, pod) |
Signed-off-by: googs1025 <[email protected]>
googs1025
force-pushed
the
fix/create_err
branch
from
e48b5cf to
ae2fe77
Compare
| if apierrors.IsAlreadyExists(err) { | ||
| klog.InfoS("Pod already exists, skipping", "pod", pod.Name, "podset", podSet.Name) | ||
| continue | ||
| } |
There was a problem hiding this comment.
Shouldn't we add unit test for this behavior?
There was a problem hiding this comment.
I don't think it's necessary, and it doesn't change the actual logic. 😄
|
cc @Jeffwan |
3 participants
Pull Request Description
[Please provide a clear and concise description of your changes here]
Related Issues
Resolves: #[Insert issue number(s)]
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.