Add ownerReference to child resource on update (netbox-community#369)

A gap discovered in a backup and restore test was that the NetBox Operator child resources do not get the ownerReference set on Update. The goal of this PR is to make sure the IpAddressClaim, PrefixClaim and IpRangeClaim controllers add the ownerReference to the IpAddress, Prefix and IpRange CR when it reconciles/updates them.

Author: jstudler

internal/controller/ipaddressclaim_controller.go

@@ -192,6 +192,10 @@ func (r *IpAddressClaimReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 			ipAddress.Spec.Comments = updatedIpAddressSpec.Comments
 			ipAddress.Spec.Description = updatedIpAddressSpec.Description
 			ipAddress.Spec.PreserveInNetbox = updatedIpAddressSpec.PreserveInNetbox
+			err = controllerutil.SetControllerReference(o, ipAddress, r.Scheme)
+			if err != nil {
+				return err
+			}
 			return nil
 		})
 		if err != nil {

internal/controller/iprangeclaim_controller.go

@@ -147,6 +147,11 @@ func (r *IpRangeClaimReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		// update spec of IpRange object
 		logger.V(4).Info("update iprange resource")
 		ipRange.Spec = generateIpRangeSpec(o, ipRange.Spec.StartAddress, ipRange.Spec.EndAddress, logger)
+		err = controllerutil.SetControllerReference(o, ipRange, r.Scheme)
+		if err != nil {
+			return ctrl.Result{}, err
+		}
+
 		err = r.Client.Update(ctx, ipRange)
 		if err != nil {
 			return ctrl.Result{}, err

internal/controller/prefixclaim_controller.go

@@ -318,6 +318,10 @@ func (r *PrefixClaimReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 			prefix.Spec.Description = updatedPrefixSpec.Description
 			prefix.Spec.Comments = updatedPrefixSpec.Comments
 			prefix.Spec.PreserveInNetbox = updatedPrefixSpec.PreserveInNetbox
+			err = controllerutil.SetControllerReference(prefixClaim, prefix, r.Scheme)
+			if err != nil {
+				return err
+			}
 			return nil
 		}); err != nil {
 			return ctrl.Result{}, err

kind/load-local-data-job/main.py

@@ -350,7 +350,7 @@ class Prefix:
     ),
     Prefix(
         prefix="3.0.5.0/24",
-        description="",
+        description="chainsaw test prefixclaim-ipv4-update-ownerreference",
         site=None,
         tenant={
             "name": "MY_TENANT",
@@ -525,7 +525,7 @@ class Prefix:
     ),
     Prefix(
         prefix="3.1.3.0/24",
-        description="",
+        description="chainsaw test ipaddressclaim-ipv4-update-ownerreference",
         site=None,
         tenant={
             "name": "MY_TENANT",
@@ -766,7 +766,7 @@ class Prefix:
     ),
     Prefix(
         prefix="3.2.4.0/24",
-        description="",
+        description="chainsaw test iprangeclaim-ipv4-update-ownerreference",
         site=None,
         tenant={
             "name": "MY_TENANT",

tests/e2e/Prefix/IPv4/prefixclaim-ipv4-invalid-parentprefixselector/chainsaw-test.yaml

@@ -1,4 +1,3 @@
----
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
@@ -54,4 +53,4 @@ spec:
       cleanup:
         - script:
             content: |
-                kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-invalid-parentprefixselector -n $NAMESPACE
+              kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-invalid-parentprefixselector -n $NAMESPACE

tests/e2e/Prefix/IPv4/prefixclaim-ipv4-invalid-parentprefixselector/netbox_v1_prefixclaim.yaml

@@ -1,4 +1,3 @@
----
 apiVersion: netbox.dev/v1
 kind: PrefixClaim
 metadata:

tests/e2e/Prefix/IPv4/prefixclaim-ipv4-parentprefix-apply-update/chainsaw-test.yaml

@@ -1,4 +1,3 @@
----
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
@@ -84,4 +83,4 @@ spec:
       cleanup:
         - script:
             content: |
-                kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-parentprefix-apply-update -n $NAMESPACE
+              kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-parentprefix-apply-update -n $NAMESPACE

tests/e2e/Prefix/IPv4/prefixclaim-ipv4-parentprefix-apply-update/netbox_v1_prefixclaim-update.yaml

@@ -1,4 +1,3 @@
----
 apiVersion: netbox.dev/v1
 kind: PrefixClaim
 metadata:

tests/e2e/Prefix/IPv4/prefixclaim-ipv4-parentprefix-apply-update/netbox_v1_prefixclaim.yaml

@@ -1,4 +1,3 @@
----
 apiVersion: netbox.dev/v1
 kind: PrefixClaim
 metadata:

tests/e2e/Prefix/IPv4/prefixclaim-ipv4-parentprefix-restore/chainsaw-test.yaml

@@ -1,4 +1,3 @@
----
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
@@ -133,46 +132,46 @@ spec:
     - name: Set preserveInNetbox to false
       description: Set preserveInNetbox to false to clean up the NetBox test instance
       try:
-      - patch:
-          resource:
-            apiVersion: netbox.dev/v1
-            kind: PrefixClaim
-            metadata:
-              name: prefixclaim-ipv4-parentprefix-restore-1
-            spec:
-              preserveInNetbox: false
-      - patch:
-          resource:
-            apiVersion: netbox.dev/v1
-            kind: PrefixClaim
-            metadata:
-              name: prefixclaim-ipv4-parentprefix-restore-2
-            spec:
-              preserveInNetbox: false
-      - assert:
-          resource:
-            apiVersion: netbox.dev/v1
-            kind: Prefix
-            metadata:
-              name: prefixclaim-ipv4-parentprefix-restore-1
-            status:
-              (conditions[?type == 'Ready']):
-              - observedGeneration: 2
-                status: 'True'
-      - assert:
-          resource:
-            apiVersion: netbox.dev/v1
-            kind: Prefix
-            metadata:
-              name: prefixclaim-ipv4-parentprefix-restore-2
-            status:
-              (conditions[?type == 'Ready']):
-              - observedGeneration: 2
-                status: 'True'
+        - patch:
+            resource:
+              apiVersion: netbox.dev/v1
+              kind: PrefixClaim
+              metadata:
+                name: prefixclaim-ipv4-parentprefix-restore-1
+              spec:
+                preserveInNetbox: false
+        - patch:
+            resource:
+              apiVersion: netbox.dev/v1
+              kind: PrefixClaim
+              metadata:
+                name: prefixclaim-ipv4-parentprefix-restore-2
+              spec:
+                preserveInNetbox: false
+        - assert:
+            resource:
+              apiVersion: netbox.dev/v1
+              kind: Prefix
+              metadata:
+                name: prefixclaim-ipv4-parentprefix-restore-1
+              status:
+                (conditions[?type == 'Ready']):
+                  - observedGeneration: 2
+                    status: 'True'
+        - assert:
+            resource:
+              apiVersion: netbox.dev/v1
+              kind: Prefix
+              metadata:
+                name: prefixclaim-ipv4-parentprefix-restore-2
+              status:
+                (conditions[?type == 'Ready']):
+                  - observedGeneration: 2
+                    status: 'True'
     - name: Cleanup events
       description: Events cleanup required to fix issues with failing tests that assert the wrong Error resource
       cleanup:
         - script:
             content: |
-                kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-parentprefix-restore-1 -n $NAMESPACE
-                kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-parentprefix-restore-2 -n $NAMESPACE
+              kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-parentprefix-restore-1 -n $NAMESPACE
+              kubectl delete events --field-selector involvedObject.name=prefixclaim-ipv4-parentprefix-restore-2 -n $NAMESPACE