feat: add nautobot service reference

Author: abhimanyu003

go/nautobotop/api/v1alpha1/nautobot_types.go

@@ -28,6 +28,7 @@ type NautobotSpec struct {
 	// +kubebuilder:default=10
 	SyncIntervalSeconds int               `json:"syncIntervalSeconds,omitempty"`
 	NautobotSecretRef   SecretKeySelector `json:"nautobotSecretRef,omitempty"`
+	NautobotServiceRef  ServiceSelector   `json:"nautobotServiceRef,omitempty"`
 	DeviceTypesRef      []ConfigMapRef    `json:"deviceTypeRef,omitempty"`
 }
 

go/nautobotop/api/v1alpha1/secret_type.go

@@ -23,3 +23,19 @@ type SecretKeySelector struct {
 	// +kubebuilder:validation:Pattern:=^[-._a-zA-Z0-9]+$
 	Key string `json:"key,omitempty"`
 }
+
+type ServiceSelector struct {
+	// The name of the Service resource being referred to.
+	// +kubebuilder:validation:MinLength:=1
+	// +kubebuilder:validation:MaxLength:=253
+	// +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+	Name string `json:"name,omitempty"`
+
+	// The namespace of the Service resource being referred to.
+	// Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
+	// +optional
+	// +kubebuilder:validation:MinLength:=1
+	// +kubebuilder:validation:MaxLength:=63
+	// +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+	Namespace *string `json:"namespace,omitempty"`
+}

go/nautobotop/api/v1alpha1/zz_generated.deepcopy.go

@@ -93,6 +93,23 @@ spec:
                     pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
                     type: string
                 type: object
+              nautobotServiceRef:
+                properties:
+                  name:
+                    description: The name of the Service resource being referred to.
+                    maxLength: 253
+                    minLength: 1
+                    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                    type: string
+                  namespace:
+                    description: |-
+                      The namespace of the Service resource being referred to.
+                      Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
+                    maxLength: 63
+                    minLength: 1
+                    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+                    type: string
+                type: object
               syncIntervalSeconds:
                 default: 10
                 type: integer

go/nautobotop/config/crd/bases/sync.rax.io_nautobots.yaml

@@ -93,6 +93,23 @@ spec:
                     pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
                     type: string
                 type: object
+              nautobotServiceRef:
+                properties:
+                  name:
+                    description: The name of the Service resource being referred to.
+                    maxLength: 253
+                    minLength: 1
+                    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                    type: string
+                  namespace:
+                    description: |-
+                      The namespace of the Service resource being referred to.
+                      Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
+                    maxLength: 63
+                    minLength: 1
+                    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+                    type: string
+                type: object
               syncIntervalSeconds:
                 default: 10
                 type: integer

go/nautobotop/helm/crds/clients.yaml

@@ -88,20 +88,20 @@ func (r *NautobotReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		}
 	}
 
-	// Fetch the Nautobot nautobotService to get its ClusterIP
-	var nautobotService corev1.Service
-	if err := r.Get(ctx, types.NamespacedName{Namespace: "default", Name: "nautobot-default"}, &nautobotService); err != nil {
-		log.Error(err, "failed to fetch Service nautobot-default")
-		return ctrl.Result{}, err
-	}
-
 	// Retrieve the Nautobot authentication token from a secret or external source
 	nautobotAuthToken, err := r.getAuthTokenFromSecretRef(ctx, nautobotCR)
 	if err != nil {
 		log.Error(err, "failed parse find nautoBotAuthToken")
 		return ctrl.Result{}, err
 	}
 
+	// Fetch the Nautobot service to get its ClusterIP
+	nautobotService, err := r.getServiceFromServiceRef(ctx, nautobotCR)
+	if err != nil {
+		log.Error(err, "failed to fetch Nautobot service")
+		return ctrl.Result{}, err
+	}
+
 	// Aggregate device type data from all referenced ConfigMaps
 	deviceTypeMap, err := r.aggregateDeviceTypeDataFromConfigMap(ctx, nautobotCR.Spec.DeviceTypesRef)
 	if err != nil {
@@ -202,6 +202,16 @@ func (r *NautobotReconciler) getAuthTokenFromSecretRef(ctx context.Context, naut
 	return "", fmt.Errorf("secret key %s not found in secret", nautobotCR.Spec.NautobotSecretRef.Key)
 }
 
+// getServiceFromServiceRef: this will fetch Nautobot service from the given reference.
+func (r *NautobotReconciler) getServiceFromServiceRef(ctx context.Context, nautobotCR syncv1alpha1.Nautobot) (*corev1.Service, error) {
+	service := &corev1.Service{}
+	err := r.Get(ctx, types.NamespacedName{Name: nautobotCR.Spec.NautobotServiceRef.Name, Namespace: *nautobotCR.Spec.NautobotServiceRef.Namespace}, service)
+	if err != nil {
+		return nil, err
+	}
+	return service, nil
+}
+
 // SetupWithManager sets up the controller with the Manager.
 func (r *NautobotReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).