Watch and sync changes to related resources #149
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,144 @@ | ||
| /* | ||
| Copyright 2026 The KCP 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 sync | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "go.uber.org/zap" | ||
|
|
||
| "github.com/kcp-dev/api-syncagent/internal/sync/templating" | ||
|
|
||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "k8s.io/client-go/util/workqueue" | ||
| ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/event" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
| mcreconcile "sigs.k8s.io/multicluster-runtime/pkg/reconcile" | ||
| ) | ||
|
|
||
| // byOwnerEventHandler enqueues the primary object by inspecting the OwnerReferences | ||
| // of the changed related object and finding one with the configured Kind. | ||
| type byOwnerEventHandler struct { | ||
| clusterName string | ||
| ownerKind string | ||
| } | ||
|
|
||
| func (h *byOwnerEventHandler) Create(_ context.Context, evt event.TypedCreateEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(evt.Object, q) | ||
| } | ||
|
|
||
| func (h *byOwnerEventHandler) Update(_ context.Context, evt event.TypedUpdateEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(evt.ObjectNew, q) | ||
| } | ||
|
|
||
| func (h *byOwnerEventHandler) Delete(_ context.Context, evt event.TypedDeleteEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(evt.Object, q) | ||
| } | ||
|
|
||
| func (h *byOwnerEventHandler) Generic(_ context.Context, evt event.TypedGenericEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(evt.Object, q) | ||
| } | ||
|
|
||
| func (h *byOwnerEventHandler) enqueue(obj *unstructured.Unstructured, q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| for _, ref := range obj.GetOwnerReferences() { | ||
| if ref.Kind == h.ownerKind { | ||
|
Contributor
There was a problem hiding this comment. This should compare G, V and K, I think. |
||
| q.Add(mcreconcile.Request{ | ||
| ClusterName: h.clusterName, | ||
| Request: reconcile.Request{ | ||
| NamespacedName: types.NamespacedName{ | ||
| Namespace: obj.GetNamespace(), | ||
| Name: ref.Name, | ||
| }, | ||
| }, | ||
| }) | ||
| return | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // byLabelEventHandler enqueues primary objects by evaluating label templates against | ||
| // the changed related object and listing primaries matching the resulting label selector. | ||
| type byLabelEventHandler struct { | ||
| clusterName string | ||
| client ctrlruntimeclient.Client | ||
| primaryDummy *unstructured.Unstructured | ||
| labelTemplates map[string]string | ||
| log *zap.SugaredLogger | ||
| } | ||
|
|
||
| func (h *byLabelEventHandler) Create(ctx context.Context, evt event.TypedCreateEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(ctx, evt.Object, q) | ||
| } | ||
|
|
||
| func (h *byLabelEventHandler) Update(ctx context.Context, evt event.TypedUpdateEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(ctx, evt.ObjectNew, q) | ||
| } | ||
|
|
||
| func (h *byLabelEventHandler) Delete(ctx context.Context, evt event.TypedDeleteEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(ctx, evt.Object, q) | ||
| } | ||
|
|
||
| func (h *byLabelEventHandler) Generic(ctx context.Context, evt event.TypedGenericEvent[*unstructured.Unstructured], q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| h.enqueue(ctx, evt.Object, q) | ||
| } | ||
|
|
||
| func (h *byLabelEventHandler) enqueue(ctx context.Context, obj *unstructured.Unstructured, q workqueue.TypedRateLimitingInterface[mcreconcile.Request]) { | ||
| // Build the template context using the changed related object. | ||
| data := map[string]any{ | ||
| "watchObject": map[string]any{ | ||
| "name": obj.GetName(), | ||
| "namespace": obj.GetNamespace(), | ||
| "labels": obj.GetLabels(), | ||
| }, | ||
| } | ||
|
Contributor
There was a problem hiding this comment. Please create an explicit struct for this templating context in https://github.com/kcp-dev/api-syncagent/blob/main/internal/sync/templating/related.go, which helps in documenting the available template variables. Please also add a corresponding New...() func, to ensure that the newly introduced struct always gets built correctly. You can then extend https://github.com/kcp-dev/api-syncagent/blob/main/docs/content/publish-resources/templating.md, which is trivial once the struct is setup. |
||
|
|
||
| // Evaluate each label template to build the selector. | ||
| matchingLabels := ctrlruntimeclient.MatchingLabels{} | ||
| for key, tpl := range h.labelTemplates { | ||
| value, err := templating.Render(tpl, data) | ||
| if err != nil { | ||
| h.log.Warnw("Failed to evaluate byLabel template", "key", key, "template", tpl, "error", err) | ||
| return | ||
| } | ||
| matchingLabels[key] = value | ||
| } | ||
|
|
||
| // List primary objects matching the derived label selector. | ||
| primaryList := &unstructured.UnstructuredList{} | ||
| primaryList.SetAPIVersion(h.primaryDummy.GetAPIVersion()) | ||
| primaryList.SetKind(h.primaryDummy.GetKind() + "List") | ||
|
|
||
| if err := h.client.List(ctx, primaryList, matchingLabels); err != nil { | ||
| h.log.Warnw("Failed to list primary objects for byLabel watch", "selector", matchingLabels, "error", err) | ||
| return | ||
| } | ||
|
|
||
| for i := range primaryList.Items { | ||
| primary := &primaryList.Items[i] | ||
| q.Add(mcreconcile.Request{ | ||
| ClusterName: h.clusterName, | ||
| Request: reconcile.Request{ | ||
| NamespacedName: types.NamespacedName{ | ||
| Namespace: primary.GetNamespace(), | ||
| Name: primary.GetName(), | ||
| }, | ||
| }, | ||
| }) | ||
| } | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
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.
I can't quite remember why we would only want to do this on the kcp side.. Couldn't we technically also have related objects on the service cluster side? It feels like this watching behaviour should work regardless of the origin side, no? 🤔
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.e. it should always watch on the origin side, regardless where that side actually is.