Clone populator: Add clone source watches #3639
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,16 +23,23 @@ import ( | |
| "time" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| snapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| apiequality "k8s.io/apimachinery/pkg/api/equality" | ||
| k8serrors "k8s.io/apimachinery/pkg/api/errors" | ||
| "k8s.io/apimachinery/pkg/api/meta" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
|
|
||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/controller" | ||
| "sigs.k8s.io/controller-runtime/pkg/event" | ||
| "sigs.k8s.io/controller-runtime/pkg/handler" | ||
| "sigs.k8s.io/controller-runtime/pkg/manager" | ||
| "sigs.k8s.io/controller-runtime/pkg/predicate" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
| "sigs.k8s.io/controller-runtime/pkg/source" | ||
|
|
||
| cdiv1 "kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1" | ||
| "kubevirt.io/containerized-data-importer/pkg/controller/clone" | ||
|
|
@@ -81,6 +88,90 @@ type ClonePopulatorReconciler struct { | |
| multiTokenValidator *cc.MultiTokenValidator | ||
| } | ||
|
|
||
| var supportedCloneSources = map[string]client.Object{ | ||
| "VolumeSnapshot": &snapshotv1.VolumeSnapshot{}, | ||
| "PersistentVolumeClaim": &corev1.PersistentVolumeClaim{}, | ||
| } | ||
|
|
||
| func isSourceReady(obj client.Object) bool { | ||
| switch obj := obj.(type) { | ||
| case *snapshotv1.VolumeSnapshot: | ||
| return cc.IsSnapshotReady(obj) | ||
| case *corev1.PersistentVolumeClaim: | ||
| return cc.IsBound(obj) | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func addCloneSourceWatches(mgr manager.Manager, c controller.Controller, log logr.Logger) error { | ||
| getKey := func(kind, namespace, name string) string { | ||
| return kind + "/" + namespace + "/" + name | ||
| } | ||
|
|
||
| if err := mgr.GetClient().List(context.TODO(), &snapshotv1.VolumeSnapshotList{}); err != nil { | ||
| if meta.IsNoMatchError(err) { | ||
| // Back out if there's no point to attempt watch | ||
| return nil | ||
| } | ||
| if !cc.IsErrCacheNotStarted(err) { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| indexingKey := "spec.source" | ||
|
|
||
| // Indexing field for clone sources | ||
| if err := mgr.GetFieldIndexer().IndexField(context.TODO(), &cdiv1.VolumeCloneSource{}, indexingKey, func(obj client.Object) []string { | ||
| cloneSource := obj.(*cdiv1.VolumeCloneSource) | ||
| sourceName := cloneSource.Spec.Source.Name | ||
| sourceNamespace := cloneSource.Namespace | ||
| sourceKind := cloneSource.Spec.Source.Kind | ||
|
|
||
| if _, supported := supportedCloneSources[sourceKind]; !supported || sourceName == "" { | ||
| return nil | ||
| } | ||
|
|
||
| ns := cc.GetNamespace(sourceNamespace, obj.GetNamespace()) | ||
| return []string{getKey(sourceKind, ns, sourceName)} | ||
| }); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Generic mapper function for supported clone sources | ||
| genericSourceMapper := func(sourceKind string) handler.MapFunc { | ||
| return func(ctx context.Context, obj client.Object) (reqs []reconcile.Request) { | ||
| var cloneSources cdiv1.VolumeCloneSourceList | ||
| matchingFields := client.MatchingFields{indexingKey: getKey(sourceKind, obj.GetNamespace(), obj.GetName())} | ||
|
|
||
| if err := mgr.GetClient().List(ctx, &cloneSources, matchingFields); err != nil { | ||
| log.Error(err, "Failed to list VolumeCloneSources") | ||
| return nil | ||
| } | ||
|
|
||
| for _, cs := range cloneSources.Items { | ||
| reqs = append(reqs, reconcile.Request{NamespacedName: types.NamespacedName{Namespace: cs.Namespace, Name: cs.Name}}) | ||
| } | ||
| return reqs | ||
| } | ||
| } | ||
|
|
||
| // Register watches for all supported clone source types | ||
| for kind, obj := range supportedCloneSources { | ||
| if err := c.Watch(source.Kind(mgr.GetCache(), obj, | ||
| handler.EnqueueRequestsFromMapFunc(genericSourceMapper(kind)), | ||
| predicate.Funcs{ | ||
| CreateFunc: func(e event.CreateEvent) bool { return true }, | ||
| DeleteFunc: func(e event.DeleteEvent) bool { return false }, | ||
| UpdateFunc: func(e event.UpdateEvent) bool { return isSourceReady(obj) }, | ||
|
There was a problem hiding this comment. I think this will requeue for any readyToUse snapshot. Instead, what you're after is a single case where readyToUse switches from false to true, so something like containerized-data-importer/pkg/controller/datasource-controller.go Lines 307 to 309 in ce1e83c There was a problem hiding this comment. I assume that we still want to requeue any volume snapshot update even after it becomes ready? This would only allow for one single update requeue. There was a problem hiding this comment. The controller requeues the request if there's an error/some other reason. You only have to catch the transition |
||
| }, | ||
| )); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // NewClonePopulator creates a new instance of the clone-populator controller | ||
| func NewClonePopulator( | ||
| ctx context.Context, | ||
|
|
@@ -131,6 +222,10 @@ func NewClonePopulator( | |
| return nil, err | ||
| } | ||
|
|
||
| if err := addCloneSourceWatches(mgr, clonePopulator, log); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if err := planner.AddCoreWatches(reconciler.log); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
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.
So I don't know if this is a real world issue, but, if there is not snapshot support in the cluster, you'd back out and not set up a PVC watch
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.
I considered it but I don't know how much I should worry about this case... Don't mind handling it if necessary but code might become more complex.
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.
Not so complex:
containerized-data-importer/pkg/controller/dataimportcron-controller.go
Lines 1199 to 1207 in f4ddcc1
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.
By complex I mean that it requires duplicating the watches and mappers instead of having a list of supported sources, but yeah I'll change it if we prefer to handle this error.