Skip to content

Fix: Add owner reference to existing resources when initially missing #8835

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

Fix: Add owner reference to existing resources when initially missing #8835

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
42 changes: 42 additions & 0 deletions pkg/controller/common/reconciler/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,49 @@ func ReconcileResource(params Params) error {
log.Info("Deleted resource successfully")
return create()
}
// Check if owner reference needs to be added/updated independently of NeedsUpdate
if params.Owner != nil {
reconciledMeta, err := meta.Accessor(params.Reconciled)
if err != nil {
return err
}
expectedMeta, err := meta.Accessor(params.Expected)
if err != nil {
return err
}
expectedOwners := expectedMeta.GetOwnerReferences()

// Check if we need to update the owner reference
needsOwnerUpdate := false
if len(expectedOwners) > 0 {
reconciledOwners := reconciledMeta.GetOwnerReferences()
// Check if controller reference is missing or different
controllerRefIndex := -1
for i, owner := range reconciledOwners {
if owner.Controller != nil && *owner.Controller {
controllerRefIndex = i
break
}
}

if controllerRefIndex == -1 {
// No controller reference exists
needsOwnerUpdate = true
} else if reconciledOwners[controllerRefIndex].UID != expectedOwners[0].UID {
// Controller reference exists but points to a different owner
needsOwnerUpdate = true
}
}

if needsOwnerUpdate {
log.Info("Updating owner reference")
k8s.OverrideControllerReference(reconciledMeta, expectedOwners[0])
if err := params.Client.Update(params.Context, params.Reconciled); err != nil {
return err
}
log.Info("Updated owner reference successfully", resourceVersionKey, params.Reconciled.GetResourceVersion())
}
}
//nolint:nestif
// Update if needed
if params.NeedsUpdate() {
Comment on lines +147 to 192
Copy link
Contributor

@barkbay barkbay Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's maybe extract the logic into a dedicated function:

Suggested change
// Check if owner reference needs to be added/updated independently of NeedsUpdate
if params.Owner != nil {
reconciledMeta, err := meta.Accessor(params.Reconciled)
if err != nil {
return err
}
expectedMeta, err := meta.Accessor(params.Expected)
if err != nil {
return err
}
expectedOwners := expectedMeta.GetOwnerReferences()
// Check if we need to update the owner reference
needsOwnerUpdate := false
if len(expectedOwners) > 0 {
reconciledOwners := reconciledMeta.GetOwnerReferences()
// Check if controller reference is missing or different
controllerRefIndex := -1
for i, owner := range reconciledOwners {
if owner.Controller != nil && *owner.Controller {
controllerRefIndex = i
break
}
}
if controllerRefIndex == -1 {
// No controller reference exists
needsOwnerUpdate = true
} else if reconciledOwners[controllerRefIndex].UID != expectedOwners[0].UID {
// Controller reference exists but points to a different owner
needsOwnerUpdate = true
}
}
if needsOwnerUpdate {
log.Info("Updating owner reference")
k8s.OverrideControllerReference(reconciledMeta, expectedOwners[0])
if err := params.Client.Update(params.Context, params.Reconciled); err != nil {
return err
}
log.Info("Updated owner reference successfully", resourceVersionKey, params.Reconciled.GetResourceVersion())
}
}
//nolint:nestif
// Update if needed
if params.NeedsUpdate() {
// Check if owner reference needs to be added/updated independently of NeedsUpdate
needsOwnerReferenceUpdate := k8s.HasExpectedControllerOwnerReference(params.Reconciled, params.Expected)
//nolint:nestif
// Update if needed
if params.NeedsUpdate() || needsOwnerReferenceUpdate {

With HasExpectedControllerOwnerReference in pkg/utils/k8s/owner_refs.go:

// HasExpectedControllerOwnerReference checks whether the controller owner reference (managing controller) on the first resource is the same as the second one.
func HasExpectedControllerOwnerReference(reconciled, expected metav1.Object) bool {
	if reconciled == nil || expected == nil {
		return false
	}

	expectedOwners := expected.GetOwnerReferences()
	expectedControllerOwnerIdx := indexOfCtrlRef(expectedOwners)
	if expectedControllerOwnerIdx == -1 {
		// No expected controller owner reference.
		return false
	}

	reconciledOwners := reconciled.GetOwnerReferences()
	reconciledControllerOwnerIdx := indexOfCtrlRef(reconciledOwners)
	if reconciledControllerOwnerIdx == -1 {
		// No reconciled controller owner reference on the reconciled object while we expect one.
		return true
	}
	return equality.Semantic.DeepEqual(reconciledOwners[reconciledControllerOwnerIdx], expectedOwners[expectedControllerOwnerIdx])
}

Expand Down
38 changes: 38 additions & 0 deletions pkg/controller/common/reconciler/reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,44 @@ func TestReconcileResource(t *testing.T) {
require.Equal(t, "newOwner", serverState.OwnerReferences[0].Name)
},
},
{
name: "Add owner reference to existing resource without owner when NeedsUpdate returns false",
args: func() args {
return args{
Expected: obj.DeepCopy(),
Reconciled: &corev1.Secret{},
Owner: &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Namespace: objectKey.Namespace,
Name: "test-owner",
UID: "test-uid",
},
},
NeedsUpdate: func() bool {
return false
},
UpdateReconciled: noopModifier,
}
},
initialObjects: []client.Object{
&corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Namespace: objectKey.Namespace,
Name: objectKey.Name,
},
},
},
argAssertion: func(args args) {
accessor, err := meta.Accessor(args.Reconciled)
require.NoError(t, err)
require.Len(t, accessor.GetOwnerReferences(), 1, "owner reference should be added")
require.Equal(t, "test-owner", accessor.GetOwnerReferences()[0].Name)
},
serverStateAssertion: func(serverState corev1.Secret) {
require.Len(t, serverState.OwnerReferences, 1, "owner reference should be added on server")
require.Equal(t, "test-owner", serverState.OwnerReferences[0].Name)
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down