feat(spacetemplates): added metrics for spacetempalte controller

config/samples/space_with_tpl_merge.yaml

@@ -40,14 +40,23 @@ spec:
         - name: ali
           kind: User
   networkPolicies:
-    enableDefaultStrictMode: false # false
+    enableDefaultStrictMode: true # false
     items:
       - policyTypes:
+          - Ingress
           - Egress
         egress:
           - to:
               - ipBlock:
-                  cidr: 1.1.1.1/0
+                  cidr: 0.0.0.0/0
                   except:
                     - 192.168.0.0/16
+        ingress:
+          - from:
+              - namespaceSelector:
+                  matchLabels:
+                    app.kubernetes.io/instance: space-all-in-one
+              - podSelector: { }
+              - ipBlock:
+                  cidr: 192.168.0.0/16
         podSelector: { }

controllers/space/reconciler.go

@@ -134,20 +134,19 @@ func (r *Reconciler) reconcileSpaceFromTemplate(ctx context.Context, space *naut
 		return ctrl.Result{}, err
 	}
 
-	// Update the existing Space resource with the data from the SpaceTemplate
+	// Merge and override space.ResourceQuota and spacetemplate.ResourceQuota
 	rs, err := r.MergeResourceQuotas(space, spacetpl)
 	if err == nil {
 		space.Spec.ResourceQuota = *rs
 	}
-
+	// Merge and override space.AdditionalRoleBindings and spacetemplate.AdditionalRoleBindings
 	rb, err := r.MergeRoleBindings(space, spacetpl)
 	if err == nil {
 		space.Spec.AdditionalRoleBindings = rb
 	}
 
-	netPolicies, err := r.MergeNetworkPolicies(space, spacetpl)
-	if err == nil {
-		space.Spec.NetworkPolicies.Items = netPolicies.Items
+	if reflect.ValueOf(space.Spec.NetworkPolicies).IsZero() {
+		space.Spec.NetworkPolicies = spacetpl.Spec.NetworkPolicies
 	}
 
 	if reflect.ValueOf(space.Spec.LimitRanges).IsZero() {

controllers/space/utlis.go

@@ -9,7 +9,6 @@ import (
 
 	nauticusiov1alpha1 "github.com/edixos/nauticus/api/v1alpha1"
 	corev1 "k8s.io/api/core/v1"
-	networkingv1 "k8s.io/api/networking/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -64,25 +63,11 @@ func (r *Reconciler) MergeRoleBindings(space *nauticusiov1alpha1.Space, spaceTem
 		}
 	}
 
-	return mergedRoleBindings, nil
-}
-
-func (r *Reconciler) MergeNetworkPolicies(space *nauticusiov1alpha1.Space, spaceTemplate *nauticusiov1alpha1.SpaceTemplate) (nauticusiov1alpha1.NetworkPolicies, error) {
-	mergedPolicies := space.Spec.NetworkPolicies
-
-	// Check if EnableDefaultStrictMode is not provided in the space
-	if reflect.ValueOf(mergedPolicies.EnableDefaultStrictMode).IsZero() {
-		mergedPolicies.EnableDefaultStrictMode = spaceTemplate.Spec.NetworkPolicies.EnableDefaultStrictMode
-	}
-
-	for _, templatePolicy := range spaceTemplate.Spec.NetworkPolicies.Items {
-		// Check if the policy already exists in mergedPolicies
-		if !cmpNetworkPolicy(mergedPolicies, templatePolicy) {
-			mergedPolicies.Items = append(mergedPolicies.Items, templatePolicy)
-		}
+	if len(mergedRoleBindings) > 0 {
+		return mergedRoleBindings, nil
 	}
 
-	return mergedPolicies, nil
+	return nil, errors.New("no additional roles bindings merged from the template")
 }
 
 func overrideResourceQuotas(resourceQuotas *corev1.ResourceQuotaSpec, spaceHard, templateHard corev1.ResourceList, resource corev1.ResourceName) {
@@ -105,13 +90,3 @@ func cmpRoleBinding(roleBindings []nauticusiov1alpha1.AdditionalRoleBinding, rol
 
 	return false
 }
-
-func cmpNetworkPolicy(mergedPolicies nauticusiov1alpha1.NetworkPolicies, policy networkingv1.NetworkPolicySpec) bool {
-	for _, mergedPolicy := range mergedPolicies.Items {
-		if reflect.DeepEqual(mergedPolicy, policy) {
-			return true
-		}
-	}
-
-	return false
-}

controllers/spacetemplate/metrics.go

@@ -0,0 +1,26 @@
+// Copyright 2022-2023 Edixos
+// SPDX-License-Identifier: Apache-2.0
+package spacetemplate
+
+import (
+	"github.com/edixos/nauticus/api/v1alpha1"
+	"github.com/edixos/nauticus/pkg/controller/constants"
+	"github.com/edixos/nauticus/pkg/metrics"
+)
+
+func (r *Reconciler) setMetrics(spacetpl *v1alpha1.SpaceTemplate, conditionType v1alpha1.ConditionType) {
+	switch conditionType {
+	case v1alpha1.ConditionType(constants.SpaceTplConditionReady):
+		metrics.ReadySpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+		metrics.InProgresSpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+		metrics.FailedSpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+	case v1alpha1.ConditionType(constants.SpaceTplConditionCreating):
+		metrics.ReadySpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+		metrics.InProgresSpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+		metrics.FailedSpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+	case v1alpha1.ConditionType(constants.SpaceTplConditionFailed):
+		metrics.ReadySpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+		metrics.InProgresSpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+		metrics.FailedSpaceTemplates.WithLabelValues(spacetpl.Name).Set(0)
+	}
+}

controllers/spacetemplate/reconsiler.go

@@ -6,9 +6,10 @@ package spacetemplate
 import (
 	"context"
 
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
 	nauticusiov1alpha1 "github.com/edixos/nauticus/api/v1alpha1"
 	"github.com/edixos/nauticus/pkg/controller/constants"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
@@ -19,19 +20,24 @@ func (r *Reconciler) reconcileSpaceTemplate(ctx context.Context, spaceTpl *nauti
 		controllerutil.AddFinalizer(spaceTpl, constants.NauticusSpaceFinalizer)
 
 		if err = r.Update(ctx, spaceTpl); err != nil {
+			r.Log.Info("Reconciling SpaceTemplate")
+			r.ProcessInProgressCondition(ctx, spaceTpl, constants.SpaceTplConditionCreating, metav1.ConditionUnknown, constants.SpaceTplCreatingReason, constants.SpaceTplCreatingMessage)
+			r.setMetrics(spaceTpl, nauticusiov1alpha1.ConditionType(constants.SpaceTplConditionCreating))
+			r.EmitEvent(spaceTpl, spaceTpl.GetName(), controllerutil.OperationResultCreated, constants.SpaceTplCreatingMessage, nil)
+
 			return ctrl.Result{}, err
 		}
+
+		r.ProcessFailedCondition(ctx, spaceTpl, constants.SpaceTplConditionFailed, metav1.ConditionFalse, constants.SpaceTplFailedReason, constants.SpaceTplFailedMessage)
+		r.setMetrics(spaceTpl, nauticusiov1alpha1.ConditionType(constants.SpaceTplConditionFailed))
+
+		r.EmitEvent(spaceTpl, spaceTpl.GetName(), controllerutil.OperationResultUpdatedStatus, constants.SpaceTplFailedMessage, nil)
 	}
 
-	r.ProcessCondition(
-		ctx,
-		spaceTpl,
-		constants.SpaceTplConditionReady,
-		metav1.ConditionTrue,
-		constants.SpaceTplSyncSuccessReason,
-		constants.SpaceTplSyncSuccessMessage,
-	)
-	r.EmitEvent(spaceTpl, spaceTpl.GetName(), controllerutil.OperationResultCreated, constants.SpaceTplCreatingMessage, nil)
+	r.ProcessFailedCondition(ctx, spaceTpl, constants.SpaceTplConditionReady, metav1.ConditionTrue, constants.SpaceTplSyncSuccessReason, constants.SpaceTplSyncSuccessMessage)
+	r.setMetrics(spaceTpl, nauticusiov1alpha1.ConditionType(constants.SpaceTplConditionReady))
+
+	r.EmitEvent(spaceTpl, spaceTpl.GetName(), controllerutil.OperationResultUpdatedStatus, constants.SpaceTplSyncSuccessMessage, nil)
 
 	return ctrl.Result{
 		RequeueAfter: constants.RequeueAfter,

pkg/controller/constants/constants.go

@@ -22,10 +22,15 @@ const (
 	SpaceSyncFailMessage    string = "Space failed to sync"
 	SpaceCreatingMessage    string = "Creating Space in progress"
 
-	SpaceTplConditionReady string = "Ready"
+	SpaceTplConditionReady    string = "Ready"
+	SpaceTplConditionCreating string = "Creating"
+	SpaceTplConditionFailed   string = "Failed"
 
+	SpaceTplCreatingReason    string = "SpaceTemplateCreating"
 	SpaceTplSyncSuccessReason string = "SpaceTemplateSyncedSuccessfully"
+	SpaceTplFailedReason      string = "SpaceTemplateSyncFailed"
 
 	SpaceTplSyncSuccessMessage string = "SpaceTemplate synced successfully"
 	SpaceTplCreatingMessage    string = "Creating SpaceTemplate in progress"
+	SpaceTplFailedMessage      string = "SpaceTemplate Failed to sync"
 )

pkg/metrics/metrics.go

@@ -27,8 +27,28 @@ var (
 			Help: "In Progress Spaces",
 		}, []string{"name"},
 	)
+
+	ReadySpaceTemplates = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Name: "ready_spacetemplates",
+			Help: "ready SpaceTemplates",
+		}, []string{"name"},
+	)
+
+	FailedSpaceTemplates = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Name: "not_ready_spacetemplates",
+			Help: "not ready SpaceTemplates",
+		}, []string{"name"},
+	)
+	InProgresSpaceTemplates = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Name: "in_progress_spacetemplates",
+			Help: "In Progress SpaceTemplates",
+		}, []string{"name"},
+	)
 )
 
 func init() {
-	metrics.Registry.MustRegister(FailedSpaces, ReadySpaces, InProgressSpaces)
+	metrics.Registry.MustRegister(FailedSpaces, ReadySpaces, InProgressSpaces, ReadySpaceTemplates, FailedSpaceTemplates, InProgresSpaceTemplates)
 }