Skip to content

[WIP] fix: clean up orphaned file share on CreateVolume failure #3151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andyzhangx wants to merge 9 commits into
base: master
Choose a base branch
from
+32 −0
Open

[WIP] fix: clean up orphaned file share on CreateVolume failure #3151

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1613d0e
fix: clean up orphaned file share on CreateVolume failure
andyzhangx May 13, 2026
2eaf4d7
fix: only skip cleanup for user-specified share names on ShareAlready…
andyzhangx May 13, 2026
9425103
fix: derive shareCreatedByCSI from fileShareName to avoid deleting pr…
andyzhangx May 13, 2026
713523c
refactor: extract cleanupShareOnFailure helper to reduce duplication
andyzhangx May 13, 2026
0cbce99
refactor: extract cleanupShareOnFailure as Driver method with backgro…
andyzhangx May 13, 2026
f6fa674
cleanup: remove redundant comment in ShareAlreadyExists branch
andyzhangx May 13, 2026
7597928
fix: move DeleteVolume doc comment to correct function
andyzhangx May 13, 2026
8f87d0b
fix: remove unused ctx parameter from cleanupShareOnFailure
andyzhangx May 13, 2026
98bf8ae
fix: skip share cleanup when azcopy job is still running
andyzhangx May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions pkg/azurefile/controllerserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,6 +710,7 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
}

klog.V(2).Infof("begin to create file share(%s) on account(%s) type(%s) subID(%s) rg(%s) location(%s) size(%d) protocol(%s)", validFileShareName, accountName, sku, subsID, resourceGroup, location, fileShareSize, shareProtocol)
shareCreatedByCSI := true
if err := d.CreateFileShare(ctx, accountOptions, shareOptions, secret, useDataPlaneAPI); err != nil {
if strings.Contains(err.Error(), accountLimitExceedManagementAPI) || strings.Contains(err.Error(), accountLimitExceedDataPlaneAPI) {
Comment thread
andyzhangx marked this conversation as resolved.
klog.Warningf("create file share(%s) on account(%s) type(%s) subID(%s) rg(%s) location(%s) size(%d), error: %v, skip matching current account", validFileShareName, accountName, sku, subsID, resourceGroup, location, fileShareSize, err)
Expand All @@ -731,6 +732,13 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
if req.GetVolumeContentSource() != nil && strings.Contains(err.Error(), "ShareAlreadyExists") {
// for snapshot restore and volume cloning, ignore ShareAlreadyExists error since the file share should be created first
klog.Warningf("create file share(%s) on account(%s) type(%s) subID(%s) rg(%s) location(%s) size(%d), ignore ShareAlreadyExists error for snapshot restore and volume cloning", validFileShareName, accountName, sku, subsID, resourceGroup, location, fileShareSize)
// If the share name was auto-generated by CSI (fileShareName is empty),
// ShareAlreadyExists likely means a previous CreateVolume attempt created it
// but failed later. We should still clean it up on subsequent failures.
// Only skip cleanup when the user explicitly specified a share name.
if fileShareName != "" {
shareCreatedByCSI = false
}
err = nil
Comment thread
andyzhangx marked this conversation as resolved.
} else {
return nil, status.Errorf(codes.Internal, "failed to create file share(%s) on account(%s) type(%s) subsID(%s) rg(%s) location(%s) size(%d), error: %v", validFileShareName, account, sku, subsID, resourceGroup, location, fileShareSize, err)
Expand All @@ -739,18 +747,36 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
if req.GetVolumeContentSource() != nil {
accountSASToken, authAzcopyEnv, err := d.getAzcopyAuth(ctx, accountName, accountKey, storageEndpointSuffix, accountOptions, secret, secretName, secretNamespace, false)
if err != nil {
if shareCreatedByCSI {
klog.V(2).Infof("getAzcopyAuth on account(%s) failed, cleaning up file share(%s)", accountName, validFileShareName)
if cleanupErr := d.DeleteFileShare(ctx, subsID, resourceGroup, accountName, validFileShareName, secret, useDataPlaneAPI); cleanupErr != nil {
Comment thread
andyzhangx marked this conversation as resolved.
Outdated
klog.Warningf("failed to clean up file share(%s) on account(%s) rg(%s) after getAzcopyAuth failure: %v", validFileShareName, accountName, resourceGroup, cleanupErr)
}
Comment thread
andyzhangx marked this conversation as resolved.
Outdated
}
return nil, status.Errorf(codes.Internal, "failed to getAzcopyAuth on account(%s) rg(%s), error: %v", accountOptions.Name, accountOptions.ResourceGroup, err)
Comment thread
andyzhangx marked this conversation as resolved.
}
copyErr := d.copyVolume(ctx, req, accountName, accountSASToken, authAzcopyEnv, secretNamespace, shareOptions, accountOptions, storageEndpointSuffix)
if accountSASToken == "" && copyErr != nil && strings.Contains(copyErr.Error(), authorizationPermissionMismatch) {
klog.Warningf("azcopy copy failed with AuthorizationPermissionMismatch error, should assign \"Storage File Data Privileged Contributor\" role to controller identity, fall back to use sas token, original error: %v", copyErr)
accountSASToken, authAzcopyEnv, err := d.getAzcopyAuth(ctx, accountName, accountKey, storageEndpointSuffix, accountOptions, secret, secretName, secretNamespace, true)
if err != nil {
if shareCreatedByCSI {
klog.V(2).Infof("fallback getAzcopyAuth on account(%s) failed, cleaning up file share(%s)", accountName, validFileShareName)
if cleanupErr := d.DeleteFileShare(ctx, subsID, resourceGroup, accountName, validFileShareName, secret, useDataPlaneAPI); cleanupErr != nil {
klog.Warningf("failed to clean up file share(%s) on account(%s) rg(%s) after getAzcopyAuth failure: %v", validFileShareName, accountName, resourceGroup, cleanupErr)
Comment thread
andyzhangx marked this conversation as resolved.
Outdated
}
}
return nil, status.Errorf(codes.Internal, "failed to getAzcopyAuth on account(%s) rg(%s), error: %v", accountOptions.Name, accountOptions.ResourceGroup, err)
}
copyErr = d.copyVolume(ctx, req, accountName, accountSASToken, authAzcopyEnv, secretNamespace, shareOptions, accountOptions, storageEndpointSuffix)
}
if copyErr != nil {
if shareCreatedByCSI {
klog.V(2).Infof("copyVolume(%s) on account(%s) failed with error: %v, cleaning up file share", validFileShareName, accountName, copyErr)
if cleanupErr := d.DeleteFileShare(ctx, subsID, resourceGroup, accountName, validFileShareName, secret, useDataPlaneAPI); cleanupErr != nil {
klog.Warningf("failed to clean up file share(%s) on account(%s) rg(%s) after copy failure: %v", validFileShareName, accountName, resourceGroup, cleanupErr)
}
}
return nil, copyErr
}
// storeAccountKey is not needed here since copy volume is only using SAS token
Expand Down
Loading