search

kubernetes-csi / external-resizer

Sidecar container that watches Kubernetes PersistentVolumeClaims objects and triggers controller side expansion operation against a CSI endpoint
Apache License 2.0
119 stars 120 forks source link

fix: do not emit `VolumeResizeFailed` on conflict while trying to set `FileSystemResizeRequired` or `VolumeResizeSuccess` #392

Closed jakobmoellerdev closed 1 month ago

jakobmoellerdev commented 2 months ago

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change /kind bug /kind cleanup /kind design /kind documentation /kind failing-test /kind feature /kind flake

What this PR does / why we need it:

When doing a CSI call to ExpandVolume, external-resizer tries to update the PVC with FilesystemResizeRequired . Usually this works fine, however, in case of a PVC conflict, the external-resizer emits an event on the PVC with VolumeResizeFailed. This event is misleading because the Resize did not actually fail, merely the update to the PVC as requiring the Resize failed. Since this will almost always (unless we face endless races) recover gracefully for conflicts, we should avoid sending the event in this case, and rather recover normally. The logs will still emit a sync failure so admins will still be able to notice races, the event will just no longer be published.

Here is an example we collected during test runs in the downstream CSI driver TopoLVM:

│ Name:             topo-pvc.17c9d3a398b23494                                                                                                                                                                                                                                   │
│ Namespace:        e2etest-xgwhounmef                                                                                                                                                                                                                                          │
│ Labels:           <none>                                                                                                                                                                                                                                                      │
│ Annotations:      <none>                                                                                                                                                                                                                                                      │
│ API Version:      v1                                                                                                                                                                                                                                                          │
│ Count:            1                                                                                                                                                                                                                                                           │
│ Event Time:       <nil>                                                                                                                                                                                                                                                       │
│ First Timestamp:  2024-04-26T12:17:12Z                                                                                                                                                                                                                                        │
│ Involved Object:                                                                                                                                                                                                                                                              │
│   API Version:       v1                                                                                                                                                                                                                                                       │
│   Kind:              PersistentVolumeClaim                                                                                                                                                                                                                                    │
│   Name:              topo-pvc                                                                                                                                                                                                                                                 │
│   Namespace:         e2etest-xgwhounmef                                                                                                                                                                                                                                       │
│   Resource Version:  1509                                                                                                                                                                                                                                                     │
│   UID:               d447f77e-fcb4-49f7-acea-73d26b524755                                                                                                                                                                                                                     │
│ Kind:                Event                                                                                                                                                                                                                                                    │
│ Last Timestamp:      2024-04-26T12:17:12Z                                                                                                                                                                                                                                     │
│ Message:             Mark PVC "e2etest-xgwhounmef/topo-pvc" as file system resize required failed: can't patch status of  PVC e2etest-xgwhounmef/topo-pvc with Operation cannot be fulfilled on persistentvolumeclaims "topo-pvc": the object has been modified; please apply │
│  your changes to the latest version and try again                                                                                                                                                                                                                             │
│ Metadata:                                                                                                                                                                                                                                                                     │
│   Creation Timestamp:  2024-04-26T12:17:12Z                                                                                                                                                                                                                                   │
│   Resource Version:    1524                                                                                                                                                                                                                                                   │
│   UID:                 0199e840-7f9a-422e-b44e-c3014f8f5c0e                                                                                                                                                                                                                   │
│ Reason:                VolumeResizeFailed

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

When encountering a resource conflict while attempting set `FileSystemResizeRequired` or `VolumeResizeSuccess`, there is no longer a `VolumeResizeFailed` event emitted.
k8s-ci-robot commented 2 months ago

Welcome @jakobmoellerdev!

It looks like this is your first PR to kubernetes-csi/external-resizer 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/external-resizer has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot commented 2 months ago

Hi @jakobmoellerdev. Thanks for your PR.

I'm waiting for a kubernetes-csi member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
jsafrane commented 1 month ago

/ok-to-test

jsafrane commented 1 month ago

/lgtm /approve

k8s-ci-robot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jakobmoellerdev, jsafrane

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-csi/external-resizer/blob/master/OWNERS)~~ [jsafrane] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment