Consolidate Status and Condition reporting (#265)

* refactor event/status reporting

* only perform update call if the condition changed

* don't use private fields of EventStatusRecorder

* set ready false at beginning of reconcile loop

* add information about kind image loading with containerd

* fix match string for chainsaw tests

* change format string to wrap error

Author: alexandernorth

README.md

@@ -30,7 +30,10 @@ There are several ways to install NetBox Operator on your Cluster:
 
 ## Running both NetBox Operator and NetBox on a local kind cluster
 
-Note: This requires Docker BuildKit.
+> **Note:** This requires Docker BuildKit.
+
+> **Note:** There is currently a bug where if Docker uses containerd for pulling and storing images, kind fails to load the image into the cluster ([GitHub Issue](https://github.com/kubernetes-sigs/kind/issues/3795)).
+To resolve this, temporarily disable this option in the Docker settings: "General > Use containerd for pulling and storing images"
 
 - Create kind cluster with a NetBox deployment: `make create-kind`
 - Deploy the NetBox Operator on the local kind cluster: `make deploy-kind` (In case you're using podman use `CONTAINER_TOOL=podman make deploy-kind`)

api/v1/ipaddress_types.go

@@ -99,6 +99,10 @@ type IpAddress struct {
 	Status IpAddressStatus `json:"status,omitempty"`
 }
 
+func (i *IpAddress) Conditions() *[]metav1.Condition {
+	return &i.Status.Conditions
+}
+
 //+kubebuilder:object:root=true
 
 // IpAddressList contains a list of IpAddress

api/v1/ipaddressclaim_types.go

@@ -104,6 +104,10 @@ type IpAddressClaim struct {
 	Status IpAddressClaimStatus `json:"status,omitempty"`
 }
 
+func (i *IpAddressClaim) Conditions() *[]metav1.Condition {
+	return &i.Status.Conditions
+}
+
 //+kubebuilder:object:root=true
 
 // IpAddressClaimList contains a list of IpAddressClaim

api/v1/iprange_types.go

@@ -108,6 +108,10 @@ type IpRange struct {
 	Status IpRangeStatus `json:"status,omitempty"`
 }
 
+func (i *IpRange) Conditions() *[]metav1.Condition {
+	return &i.Status.Conditions
+}
+
 //+kubebuilder:object:root=true
 
 // IpRangeList contains a list of IpRange

api/v1/iprangeclaim_types.go

@@ -133,6 +133,10 @@ type IpRangeClaim struct {
 	Status IpRangeClaimStatus `json:"status,omitempty"`
 }
 
+func (i *IpRangeClaim) Conditions() *[]metav1.Condition {
+	return &i.Status.Conditions
+}
+
 //+kubebuilder:object:root=true
 
 // IpRangeClaimList contains a list of IpRangeClaim

api/v1/prefix_types.go

@@ -104,6 +104,10 @@ type Prefix struct {
 	Status PrefixStatus `json:"status,omitempty"`
 }
 
+func (p *Prefix) Conditions() *[]metav1.Condition {
+	return &p.Status.Conditions
+}
+
 // +kubebuilder:object:root=true
 
 // PrefixList contains a list of Prefix

api/v1/prefixclaim_types.go

@@ -132,6 +132,10 @@ type PrefixClaim struct {
 	Status PrefixClaimStatus `json:"status,omitempty"`
 }
 
+func (p *PrefixClaim) Conditions() *[]metav1.Condition {
+	return &p.Status.Conditions
+}
+
 // +kubebuilder:object:root=true
 
 // PrefixClaimList contains a list of PrefixClaim

api/v1/shared_conditions.go

@@ -0,0 +1,26 @@
+/*
+Copyright 2024 Swisscom (Schweiz) AG.
+
+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 v1
+
+import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+var ConditionReadyFalseNewResource = metav1.Condition{
+	Type:    "Ready",
+	Status:  "False",
+	Reason:  "NewResource",
+	Message: "Pending Reconciliation",
+}

cmd/main.go

@@ -168,67 +168,67 @@ func main() {
 	}
 
 	if err = (&controller.IpAddressReconciler{
-		Client:            mgr.GetClient(),
-		Scheme:            mgr.GetScheme(),
-		Recorder:          mgr.GetEventRecorderFor("ip-address-controller"),
-		NetboxClient:      netboxClient,
-		OperatorNamespace: operatorNamespace,
-		RestConfig:        mgr.GetConfig(),
+		Client:              mgr.GetClient(),
+		Scheme:              mgr.GetScheme(),
+		EventStatusRecorder: controller.NewEventStatusRecorder(mgr.GetClient(), mgr.GetEventRecorderFor("ip-address-controller")),
+		NetboxClient:        netboxClient,
+		OperatorNamespace:   operatorNamespace,
+		RestConfig:          mgr.GetConfig(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "IpAddress")
 		os.Exit(1)
 	}
 	if err = (&controller.IpAddressClaimReconciler{
-		Client:            mgr.GetClient(),
-		Scheme:            mgr.GetScheme(),
-		Recorder:          mgr.GetEventRecorderFor("ip-address-claim-controller"),
-		NetboxClient:      netboxClient,
-		OperatorNamespace: operatorNamespace,
-		RestConfig:        mgr.GetConfig(),
+		Client:              mgr.GetClient(),
+		Scheme:              mgr.GetScheme(),
+		EventStatusRecorder: controller.NewEventStatusRecorder(mgr.GetClient(), mgr.GetEventRecorderFor("ip-address-claim-controller")),
+		NetboxClient:        netboxClient,
+		OperatorNamespace:   operatorNamespace,
+		RestConfig:          mgr.GetConfig(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "IpAddressClaim")
 		os.Exit(1)
 	}
 	if err = (&controller.PrefixReconciler{
-		Client:            mgr.GetClient(),
-		Scheme:            mgr.GetScheme(),
-		Recorder:          mgr.GetEventRecorderFor("prefix-controller"),
-		NetboxClient:      netboxClient,
-		OperatorNamespace: operatorNamespace,
-		RestConfig:        mgr.GetConfig(),
+		Client:              mgr.GetClient(),
+		Scheme:              mgr.GetScheme(),
+		EventStatusRecorder: controller.NewEventStatusRecorder(mgr.GetClient(), mgr.GetEventRecorderFor("prefix-controller")),
+		NetboxClient:        netboxClient,
+		OperatorNamespace:   operatorNamespace,
+		RestConfig:          mgr.GetConfig(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Prefix")
 		os.Exit(1)
 	}
 	if err = (&controller.PrefixClaimReconciler{
-		Client:            mgr.GetClient(),
-		Scheme:            mgr.GetScheme(),
-		Recorder:          mgr.GetEventRecorderFor("prefix-claim-controller"),
-		NetboxClient:      netboxClient,
-		OperatorNamespace: operatorNamespace,
-		RestConfig:        mgr.GetConfig(),
+		Client:              mgr.GetClient(),
+		Scheme:              mgr.GetScheme(),
+		EventStatusRecorder: controller.NewEventStatusRecorder(mgr.GetClient(), mgr.GetEventRecorderFor("prefix-claim-controller")),
+		NetboxClient:        netboxClient,
+		OperatorNamespace:   operatorNamespace,
+		RestConfig:          mgr.GetConfig(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "PrefixClaim")
 		os.Exit(1)
 	}
 	if err = (&controller.IpRangeClaimReconciler{
-		Client:            mgr.GetClient(),
-		Scheme:            mgr.GetScheme(),
-		Recorder:          mgr.GetEventRecorderFor("ip-range-claim-controller"),
-		NetboxClient:      netboxClient,
-		OperatorNamespace: operatorNamespace,
-		RestConfig:        mgr.GetConfig(),
+		Client:              mgr.GetClient(),
+		Scheme:              mgr.GetScheme(),
+		EventStatusRecorder: controller.NewEventStatusRecorder(mgr.GetClient(), mgr.GetEventRecorderFor("ip-range-claim-controller")),
+		NetboxClient:        netboxClient,
+		OperatorNamespace:   operatorNamespace,
+		RestConfig:          mgr.GetConfig(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "IpRangeClaim")
 		os.Exit(1)
 	}
 	if err = (&controller.IpRangeReconciler{
-		Client:            mgr.GetClient(),
-		Scheme:            mgr.GetScheme(),
-		Recorder:          mgr.GetEventRecorderFor("ip-range-controller"),
-		NetboxClient:      netboxClient,
-		OperatorNamespace: operatorNamespace,
-		RestConfig:        mgr.GetConfig(),
+		Client:              mgr.GetClient(),
+		Scheme:              mgr.GetScheme(),
+		EventStatusRecorder: controller.NewEventStatusRecorder(mgr.GetClient(), mgr.GetEventRecorderFor("ip-range-controller")),
+		NetboxClient:        netboxClient,
+		OperatorNamespace:   operatorNamespace,
+		RestConfig:          mgr.GetConfig(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "IpRange")
 		os.Exit(1)

internal/controller/interfaces.go

@@ -0,0 +1,27 @@
+/*
+Copyright 2024 Swisscom (Schweiz) AG.
+
+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 controller
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+type ObjectWithConditions interface {
+	client.Object
+	Conditions() *[]metav1.Condition
+}