Skip to content

Log when a related resource's origin object can't be found #183

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
rose-krone wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Log when a related resource's origin object can't be found #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 20 additions & 7 deletions internal/sync/syncer_related.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ func (s *ResourceSyncer) processRelatedResource(ctx context.Context, log *zap.Su
policy := relRes.EffectiveCleanupPolicy()

// find the all objects on the origin side that match the given criteria
resolvedObjects, err := resolveRelatedResourceObjects(ctx, origin, dest, relRes)
resolvedObjects, err := resolveRelatedResourceObjects(ctx, log, origin, dest, relRes)
if err != nil {
return false, fmt.Errorf("failed to get resolve origin objects: %w", err)
}
Expand Down Expand Up @@ -479,7 +479,7 @@ func (s *ResourceSyncer) confirmOriginEmpty(ctx context.Context, origin, dest sy
object: origin.object,
}

resolved, err := resolveRelatedResourceObjects(ctx, liveOrigin, dest, relRes)
resolved, err := resolveRelatedResourceObjects(ctx, s.log, liveOrigin, dest, relRes)
if err != nil {
return false, true, err
}
Expand All @@ -495,7 +495,7 @@ type resolvedObject struct {
destination types.NamespacedName
}

func resolveRelatedResourceObjects(ctx context.Context, relatedOrigin, relatedDest syncSide, relRes syncagentv1alpha1.RelatedResourceSpec) ([]resolvedObject, error) {
func resolveRelatedResourceObjects(ctx context.Context, log *zap.SugaredLogger, relatedOrigin, relatedDest syncSide, relRes syncagentv1alpha1.RelatedResourceSpec) ([]resolvedObject, error) {
// resolving the originNamespace first allows us to scope down any .List() calls later
originNamespace := relatedOrigin.object.GetNamespace()
destNamespace := relatedDest.object.GetNamespace()
Expand Down Expand Up @@ -529,7 +529,7 @@ func resolveRelatedResourceObjects(ctx context.Context, relatedOrigin, relatedDe
// this related resource configuration. Again, for label selectors this can be multiple,
// otherwise at most 1.

objects, err := resolveRelatedResourceObjectsInNamespaces(ctx, relatedOrigin, relatedDest, relRes, relRes.Object.RelatedResourceObjectSpec, namespaceMap)
objects, err := resolveRelatedResourceObjectsInNamespaces(ctx, log, relatedOrigin, relatedDest, relRes, relRes.Object.RelatedResourceObjectSpec, namespaceMap)
if err != nil {
return nil, fmt.Errorf("failed to resolve objects: %w", err)
}
Expand Down Expand Up @@ -630,7 +630,7 @@ func mapSlices(a, b []string) map[string]string {
return mapping
}

func resolveRelatedResourceObjectsInNamespaces(ctx context.Context, relatedOrigin, relatedDest syncSide, relRes syncagentv1alpha1.RelatedResourceSpec, spec syncagentv1alpha1.RelatedResourceObjectSpec, namespaceMap map[string]string) ([]resolvedObject, error) {
func resolveRelatedResourceObjectsInNamespaces(ctx context.Context, log *zap.SugaredLogger, relatedOrigin, relatedDest syncSide, relRes syncagentv1alpha1.RelatedResourceSpec, spec syncagentv1alpha1.RelatedResourceObjectSpec, namespaceMap map[string]string) ([]resolvedObject, error) {
result := []resolvedObject{}

for originNamespace, destNamespace := range namespaceMap {
Expand All @@ -653,9 +653,22 @@ func resolveRelatedResourceObjectsInNamespaces(ctx context.Context, relatedOrigi

err = relatedOrigin.client.Get(ctx, types.NamespacedName{Name: originName, Namespace: originNamespace}, originObj)
if err != nil {
// this should rarely happen, only if an object was deleted in between the .List() call
// above and the .Get() call here.
// This should rarely happen, only if an object was deleted in between the .List()
// call above and the .Get() call here. It can also happen permanently if a
// misconfigured object.template/reference/selector computes a name that never
// matches a real object - in that case this branch is hit on every single
// reconcile, forever, with the primary object's reconcile otherwise reporting
// success. Log it so that case is diagnosable without reading the source.
if apierrors.IsNotFound(err) {
if log != nil {
log.Debugw(
"Origin object for related resource not found, skipping",
"identifier", relRes.Identifier,
"namespace", originNamespace,
"name", originName,
)
}

continue
}

Expand Down
2 changes: 1 addition & 1 deletion internal/sync/syncer_related_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ func TestResolveRelatedResourceObjects(t *testing.T) {
Object: testcase.objectSpec,
}

foundObjects, err := resolveRelatedResourceObjects(t.Context(), originSide, destSide, pubRes)
foundObjects, err := resolveRelatedResourceObjects(t.Context(), zap.NewNop().Sugar(), originSide, destSide, pubRes)
if err != nil {
t.Fatalf("Failed to resolve related objects: %v", err)
}
Expand Down