feat: add support for timeframe in KeptnMetric

metrics-operator/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: keptn.sh
 layout:
 - go.kubebuilder.io/v3
@@ -41,6 +45,9 @@ resources:
   kind: KeptnMetric
   path: github.com/keptn/lifecycle-toolkit/metrics-operator/api/v1alpha3
   version: v1alpha3
+  webhooks:
+    validation: true
+    webhookVersion: v1
 - api:
     crdVersion: v1
     namespaced: true

metrics-operator/api/v1alpha3/keptnmetric_types.go

@@ -31,6 +31,8 @@ type KeptnMetricSpec struct {
 	Query string `json:"query"`
 	// FetchIntervalSeconds represents the update frequency in seconds that is used to update the metric
 	FetchIntervalSeconds uint `json:"fetchIntervalSeconds"`
+	// Range represents the time range for which data is to be queried
+	Range RangeSpec `json:"range,omitempty"`
 }
 
 // KeptnMetricStatus defines the observed state of KeptnMetric
@@ -51,6 +53,12 @@ type ProviderRef struct {
 	Name string `json:"name"`
 }
 
+// RangeSpec defines the time range for which data is to be queried
+type RangeSpec struct {
+	// +kubebuilder:default:="5m"
+	Interval string `json:"interval,omitempty"`
+}
+
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Provider",type=string,JSONPath=`.spec.provider.name`

metrics-operator/api/v1alpha3/keptnmetric_webhook.go

@@ -17,11 +17,77 @@ limitations under the License.
 package v1alpha3
 
 import (
+	"time"
+
+	"github.com/pkg/errors"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/util/validation/field"
 	ctrl "sigs.k8s.io/controller-runtime"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
 )
 
+// log is for logging in this package.
+var keptnmetriclog = logf.Log.WithName("keptnmetric-resource")
+
 func (r *KeptnMetric) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
 		Complete()
 }
+
+//+kubebuilder:webhook:path=/validate-metrics-keptn-sh-v1alpha3-keptnmetric,mutating=false,failurePolicy=fail,sideEffects=None,groups=metrics.keptn.sh,resources=keptnmetrics,verbs=create;update,versions=v1alpha3,name=vkeptnmetric.kb.io,admissionReviewVersions=v1
+
+var _ webhook.Validator = &KeptnMetric{}
+
+// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
+func (r *KeptnMetric) ValidateCreate() error {
+	keptnmetriclog.Info("validate create", "name", r.Name)
+
+	// TODO(user): fill in your validation logic upon object creation.
+	return r.validateKeptnMetric()
+}
+
+// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
+func (r *KeptnMetric) ValidateUpdate(old runtime.Object) error {
+	keptnmetriclog.Info("validate update", "name", r.Name)
+
+	// TODO(user): fill in your validation logic upon object update.
+	return r.validateKeptnMetric()
+}
+
+// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
+func (r *KeptnMetric) ValidateDelete() error {
+	keptnmetriclog.Info("validate delete", "name", r.Name)
+
+	return nil
+}
+
+func (s *KeptnMetric) validateKeptnMetric() error {
+	var allErrs field.ErrorList //defined as a list to allow returning multiple validation errors
+	var err *field.Error
+	if err = s.validateRangeInterval(); err != nil {
+		allErrs = append(allErrs, err)
+	}
+	if len(allErrs) == 0 {
+		return nil
+	}
+
+	return apierrors.NewInvalid(
+		schema.GroupKind{Group: "metrics.keptn.sh", Kind: "KeptnMetric"},
+		s.Name, allErrs)
+}
+
+func (s *KeptnMetric) validateRangeInterval() *field.Error {
+	_, err := time.ParseDuration(s.Spec.Range.Interval)
+	if err != nil {
+		return field.Invalid(
+			field.NewPath("spec").Child("range").Child("interval"),
+			s.Spec.Range.Interval,
+			errors.New("Forbidden! The time interval cannot be parsed. Please check for suitable conventions").Error(),
+		)
+	}
+	return nil
+}

metrics-operator/api/v1alpha3/keptnmetric_webhook_test.go

@@ -0,0 +1,49 @@
+package v1alpha3
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/pkg/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/validation/field"
+)
+
+func TestKeptnMetric_validateRangeInterval(t *testing.T) {
+
+	tests := []struct {
+		name string
+		Spec KeptnMetricSpec
+		want *field.Error
+	}{
+		{
+			name: "bad-provider",
+			Spec: KeptnMetricSpec{
+				Range: RangeSpec{Interval: "5mins"},
+			},
+			want: field.Invalid(
+				field.NewPath("spec").Child("range").Child("interval"),
+				"5mins",
+				errors.New("Forbidden! The time interval cannot be parsed. Please check for suitable conventions").Error(),
+			),
+		},
+
+		{
+			name: "good-provider",
+			Spec: KeptnMetricSpec{
+				Range: RangeSpec{Interval: "5m"},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			s := &KeptnMetric{
+				ObjectMeta: metav1.ObjectMeta{Name: tt.name},
+				Spec:       KeptnMetricSpec{Range: RangeSpec{Interval: tt.Spec.Range.Interval}},
+			}
+			if got := s.validateRangeInterval(); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("validateRangeInterval() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

metrics-operator/config/certmanager/certificate.yaml

@@ -0,0 +1,39 @@
+# The following manifests contain a self-signed issuer CR and a certificate CR.
+# More document can be found at https://docs.cert-manager.io
+# WARNING: Targets CertManager v1.0. Check https://cert-manager.io/docs/installation/upgrading/ for breaking changes.
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  labels:
+    app.kubernetes.io/name: issuer
+    app.kubernetes.io/instance: selfsigned-issuer
+    app.kubernetes.io/component: certificate
+    app.kubernetes.io/created-by: metrics-operator
+    app.kubernetes.io/part-of: metrics-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: selfsigned-issuer
+  namespace: system
+spec:
+  selfSigned: {}
+---
+apiVersion: cert-manager.io/v1
+kind: Certificate
+metadata:
+  labels:
+    app.kubernetes.io/name: certificate
+    app.kubernetes.io/instance: serving-cert
+    app.kubernetes.io/component: certificate
+    app.kubernetes.io/created-by: metrics-operator
+    app.kubernetes.io/part-of: metrics-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: serving-cert  # this name should match the one appeared in kustomizeconfig.yaml
+  namespace: system
+spec:
+  # $(SERVICE_NAME) and $(SERVICE_NAMESPACE) will be substituted by kustomize
+  dnsNames:
+  - $(SERVICE_NAME).$(SERVICE_NAMESPACE).svc
+  - $(SERVICE_NAME).$(SERVICE_NAMESPACE).svc.cluster.local
+  issuerRef:
+    kind: Issuer
+    name: selfsigned-issuer
+  secretName: webhook-server-cert # this secret will not be prefixed, since it's not managed by kustomize

metrics-operator/config/certmanager/kustomization.yaml

@@ -0,0 +1,5 @@
+resources:
+- certificate.yaml
+
+configurations:
+- kustomizeconfig.yaml

metrics-operator/config/certmanager/kustomizeconfig.yaml

@@ -0,0 +1,16 @@
+# This configuration is for teaching kustomize how to update name ref and var substitution
+nameReference:
+- kind: Issuer
+  group: cert-manager.io
+  fieldSpecs:
+  - kind: Certificate
+    group: cert-manager.io
+    path: spec/issuerRef/name
+
+varReference:
+- kind: Certificate
+  group: cert-manager.io
+  path: spec/commonName
+- kind: Certificate
+  group: cert-manager.io
+  path: spec/dnsNames

metrics-operator/config/crd/bases/metrics.keptn.sh_keptnmetrics.yaml

@@ -212,6 +212,14 @@ spec:
               query:
                 description: Query represents the query to be run
                 type: string
+              range:
+                description: Range represents the time range for which data is to
+                  be queried
+                properties:
+                  interval:
+                    default: 5m
+                    type: string
+                type: object
             required:
             - fetchIntervalSeconds
             - provider

metrics-operator/config/default/manager_webhook_patch.yaml

@@ -0,0 +1,23 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: controller-manager
+  namespace: system
+spec:
+  template:
+    spec:
+      containers:
+      - name: manager
+        ports:
+        - containerPort: 9443
+          name: webhook-server
+          protocol: TCP
+        volumeMounts:
+        - mountPath: /tmp/k8s-webhook-server/serving-certs
+          name: cert
+          readOnly: true
+      volumes:
+      - name: cert
+        secret:
+          defaultMode: 420
+          secretName: webhook-server-cert

metrics-operator/config/default/webhookcainjection_patch.yaml

@@ -0,0 +1,29 @@
+# This patch add annotation to admission webhook config and
+# the variables $(CERTIFICATE_NAMESPACE) and $(CERTIFICATE_NAME) will be substituted by kustomize.
+apiVersion: admissionregistration.k8s.io/v1
+kind: MutatingWebhookConfiguration
+metadata:
+  labels:
+    app.kubernetes.io/name: mutatingwebhookconfiguration
+    app.kubernetes.io/instance: mutating-webhook-configuration
+    app.kubernetes.io/component: webhook
+    app.kubernetes.io/created-by: metrics-operator
+    app.kubernetes.io/part-of: metrics-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: mutating-webhook-configuration
+  annotations:
+    cert-manager.io/inject-ca-from: $(CERTIFICATE_NAMESPACE)/$(CERTIFICATE_NAME)
+---
+apiVersion: admissionregistration.k8s.io/v1
+kind: ValidatingWebhookConfiguration
+metadata:
+  labels:
+    app.kubernetes.io/name: validatingwebhookconfiguration
+    app.kubernetes.io/instance: validating-webhook-configuration
+    app.kubernetes.io/component: webhook
+    app.kubernetes.io/created-by: metrics-operator
+    app.kubernetes.io/part-of: metrics-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: validating-webhook-configuration
+  annotations:
+    cert-manager.io/inject-ca-from: $(CERTIFICATE_NAMESPACE)/$(CERTIFICATE_NAME)

metrics-operator/config/webhook/manifests.yaml

@@ -0,0 +1,29 @@
+---
+apiVersion: admissionregistration.k8s.io/v1
+kind: ValidatingWebhookConfiguration
+metadata:
+  creationTimestamp: null
+  name: metrics-validating-webhook-configuration
+  labels:
+    keptn.sh/inject-cert: "true"
+webhooks:
+  - admissionReviewVersions:
+      - v3
+    clientConfig:
+      service:
+        name: webhook-service
+        namespace: system
+        path: /validate-metrics-keptn-sh-v1alpha3-keptnmetric
+    failurePolicy: Fail
+    name: vkeptnmetric.kb.io
+    rules:
+      - apiGroups:
+          - metrics.keptn.sh
+        apiVersions:
+          - v1alpha3
+        operations:
+          - CREATE
+          - UPDATE
+        resources:
+          - keptnmetrics
+    sideEffects: None

metrics-operator/go.mod

@@ -9,6 +9,8 @@ require (
 	github.com/gorilla/mux v1.8.0
 	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/keptn/lifecycle-toolkit/klt-cert-manager v0.0.0-20230523133947-65b41399b2e0
+	github.com/onsi/ginkgo/v2 v2.8.1
+	github.com/onsi/gomega v1.27.0
 	github.com/open-feature/go-sdk v1.3.0
 	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.15.1
@@ -67,8 +69,6 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
-	github.com/onsi/ginkgo/v2 v2.8.1 // indirect
-	github.com/onsi/gomega v1.27.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/procfs v0.9.0 // indirect