[cinder-csi-plugin] Add finalizer to VolumeSnapshot when create PVC with the VolumeSnapshot #2369
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| Copyright 2023 The Kubernetes Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package cinder | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| snap "github.com/kubernetes-csi/external-snapshotter/client/v6/clientset/versioned" | ||
| "golang.org/x/net/context" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/watch" | ||
| "k8s.io/client-go/kubernetes" | ||
| "k8s.io/client-go/rest" | ||
| "k8s.io/klog/v2" | ||
| "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" | ||
|
Comment on lines
+22
to
+30
There was a problem hiding this comment. Looks like this is mixing K8s and non-K8s imports. No biggie. |
||
| ) | ||
|
|
||
| const ( | ||
| annStorageProvisioner = "volume.kubernetes.io/storage-provisioner" | ||
| snapshotKind = "VolumeSnapshot" | ||
| ) | ||
|
|
||
| type controllerWatcher struct { | ||
| snapClient snap.Interface | ||
| watcher watch.Interface | ||
| } | ||
|
|
||
| func (cw *controllerWatcher) run() { | ||
|
There was a problem hiding this comment. I am not sure but this to me is general feature instead of CPO ? e.g every cloud has this problem? |
||
| klog.V(2).Info("Controller watcher started") | ||
| for event := range cw.watcher.ResultChan() { | ||
| obj := event.Object.DeepCopyObject() | ||
| pvc, ok := obj.(*corev1.PersistentVolumeClaim) | ||
| if !ok { | ||
| continue | ||
| } | ||
| if pvc.ObjectMeta.Annotations[annStorageProvisioner] != driverName { | ||
| continue | ||
| } | ||
| if pvc.Spec.DataSource == nil || pvc.Spec.DataSource.Kind != snapshotKind { | ||
| continue | ||
| } | ||
| snapshotObj, err := cw.snapClient.SnapshotV1().VolumeSnapshots(pvc.Namespace).Get(context.Background(), pvc.Spec.DataSource.Name, metav1.GetOptions{}) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Error get VolumeSnapshot", "namespace", pvc.Namespace, "name", pvc.Spec.DataSource.Name) | ||
| continue | ||
| } | ||
| update := false | ||
| finalizer := fmt.Sprintf("%s/pvc-%s", driverName, pvc.UID) | ||
| // TODO(JeffYang): Asynchronously add finalizer seems like unsafety, might have some potential issues. | ||
| // Move it into controllerServer CreateVolume after the PR https://github.com/kubernetes-csi/external-provisioner/pull/1070 merged and released. | ||
| // We can synchronously add finalizer there | ||
| if event.Type == watch.Added { | ||
| klog.V(5).InfoS("Receive ADDED event try to add finalizer to VolumeSnapshot", "PersistentVolumeClaim", pvc.Name, "VolumeSnapshot", snapshotObj.Name) | ||
| update = controllerutil.AddFinalizer(snapshotObj, finalizer) | ||
| } | ||
|
Comment on lines
+67
to
+70
There was a problem hiding this comment. Uhm, what if we missed an ADDED event somehow, but then get the MODIFIED one? I believe we should rather look for ADDED/MODIFIED and check if finalizer is there and if it's not add it. |
||
| if event.Type == watch.Deleted { | ||
| klog.V(5).InfoS("Receive DELETED event try to remove finalizer from VolumeSnapshot", "PersistentVolumeClaim", pvc.Name, "VolumeSnapshot", snapshotObj.Name) | ||
| update = controllerutil.RemoveFinalizer(snapshotObj, finalizer) | ||
| } | ||
|
Comment on lines
+71
to
+74
There was a problem hiding this comment. What if you've missed a deletion event here? Are we stuck with a snapshot? |
||
| if update { | ||
| _, err := cw.snapClient.SnapshotV1().VolumeSnapshots(pvc.Namespace).Update(context.Background(), snapshotObj, metav1.UpdateOptions{}) | ||
|
There was a problem hiding this comment. This should be a |
||
| if err != nil { | ||
| klog.ErrorS(err, "Error update VolumeSnapshot", "name", snapshotObj.Name, "finalizer", finalizer) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func StartContollerWatcher(restConfig *rest.Config) error { | ||
| snapClient, err := snap.NewForConfig(restConfig) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Error building snapshot clientset") | ||
| return err | ||
| } | ||
|
|
||
| clientset, err := kubernetes.NewForConfig(restConfig) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Error building kubernetes clientset") | ||
| return err | ||
| } | ||
| pvcClient := clientset.CoreV1().PersistentVolumeClaims(corev1.NamespaceAll) | ||
| watchInterface, err := pvcClient.Watch(context.Background(), metav1.ListOptions{}) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Error starting watcher") | ||
| return err | ||
| } | ||
|
|
||
| cw := controllerWatcher{snapClient: snapClient, watcher: watchInterface} | ||
| go cw.run() | ||
| return nil | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
VSis not widely used I think you mean virtual server ?