refactoring and add support for annotation ttls

Signed-off-by: Markus Blaschke <[email protected]>

Author: mblaschke

README.md

@@ -5,7 +5,7 @@
 [![Quay.io](https://img.shields.io/badge/Quay.io-webdevops%2Fkube--janitor-blue)](https://quay.io/repository/webdevops/kube-janitor)
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/kube-janitor)](https://artifacthub.io/packages/search?repo=kube-janitor)
 
-Kubernetes janitor which deletes resources by TTL label written in Golang
+Kubernetes janitor which deletes resources by TTL annotation or label written in Golang
 
 ## Configuration
 

example.yaml

@@ -1,6 +1,12 @@
-label: ttl
+ttl:
+  ## checks all resources by annotation
+  annotation: janitor/ttl
 
-resources:
-  - {group: "", version: v1, kind: configmaps}
-  - {group: "", version: v1, kind: secrets}
-  - {group: apps, version: v1, kind: deployments}
+  ## checks all resources by label
+  # label: janitor/ttl
+
+  resources:
+    # definition of resources by group, version, kind (GVR)
+    - {group: "", version: v1, kind: configmaps}
+    - {group: "", version: v1, kind: secrets}
+    - {group: apps, version: v1, kind: deployments}

kube_janitor/config.go

@@ -9,8 +9,13 @@ import (
 
 type (
 	Config struct {
-		Label     string             `json:"label"`
-		Resources []*ConfigResources `json:"resources"`
+		Ttl *ConfigTtl `json:"ttl"`
+	}
+
+	ConfigTtl struct {
+		Annotation string             `json:"annotation"`
+		Label      string             `json:"label"`
+		Resources  []*ConfigResources `json:"resources"`
 	}
 
 	ConfigResources struct {
@@ -22,30 +27,42 @@ type (
 
 func NewConfig() *Config {
 	return &Config{
-		Resources: []*ConfigResources{},
+		Ttl: &ConfigTtl{
+			Resources: []*ConfigResources{},
+		},
 	}
 }
 
-func (r *ConfigResources) String() string {
-	return r.AsGVR().String()
-}
-
-func (r *ConfigResources) AsGVR() schema.GroupVersionResource {
-	return schema.GroupVersionResource{
-		Group:    r.Group,
-		Version:  r.Version,
-		Resource: r.Kind,
+func (c *Config) Validate() error {
+	if err := c.Ttl.Validate(); err != nil {
+		return err
 	}
+
+	return nil
 }
 
-func (r *Config) Validate() error {
-	if r.Label == "" {
-		return errors.New("label is required")
+func (c *ConfigTtl) Validate() error {
+	if c.Label == "" && c.Annotation == "" {
+		return errors.New("label or annotation is required")
 	}
 
-	if strings.Contains(r.Label, " ") {
-		return errors.New("label must not contain spaces")
+	if c.Label != "" {
+		if strings.Contains(c.Label, " ") {
+			return errors.New("label must not contain spaces")
+		}
 	}
 
 	return nil
 }
+
+func (c *ConfigResources) String() string {
+	return c.AsGVR().String()
+}
+
+func (c *ConfigResources) AsGVR() schema.GroupVersionResource {
+	return schema.GroupVersionResource{
+		Group:    c.Group,
+		Version:  c.Version,
+		Resource: c.Kind,
+	}
+}

kube_janitor/kube.go

@@ -12,10 +12,10 @@ const (
 	KubeListLimit = 100
 )
 
-func (j *Janitor) kubeEachResource(ctx context.Context, gvr schema.GroupVersionResource, callback func(unstructured unstructured.Unstructured) error) error {
+func (j *Janitor) kubeEachResource(ctx context.Context, gvr schema.GroupVersionResource, labelSelector string, callback func(unstructured unstructured.Unstructured) error) error {
 	listOpts := metav1.ListOptions{
 		Limit:         KubeListLimit,
-		LabelSelector: j.config.Label,
+		LabelSelector: labelSelector,
 	}
 	for {
 		result, err := j.dynClient.Resource(gvr).List(ctx, listOpts)

kube_janitor/manager.go

@@ -9,12 +9,7 @@ import (
 
 	"github.com/go-logr/logr"
 	yaml "github.com/goccy/go-yaml"
-	"github.com/prometheus/client_golang/prometheus"
 	"github.com/webdevops/go-common/log/slogger"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
-
-	prometheusCommon "github.com/webdevops/go-common/prometheus"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
@@ -146,63 +141,9 @@ func (j *Janitor) Start(interval time.Duration) {
 func (j *Janitor) Run() error {
 	j.connect()
 
-	ctx := context.Background()
-
-	metricResourceTtl := prometheusCommon.NewMetricsList()
-
-	for _, resourceType := range j.config.Resources {
-		gvkLogger := j.logger.With(slog.Any("gvk", resourceType))
-		gvkLogger.Debug("checking resources")
-
-		err := j.kubeEachResource(ctx, resourceType.AsGVR(), func(resource unstructured.Unstructured) error {
-
-			if ttl := resource.GetLabels()[j.config.Label]; ttl != "" {
-				resourceLogger := gvkLogger.With(
-					slog.String("namespace", resource.GetNamespace()),
-					slog.String("resource", resource.GetName()),
-					slog.String("ttl", ttl),
-				)
-
-				parsedDate, expired, err := j.checkExpiryDate(resource.GetCreationTimestamp().Time, ttl)
-				if err != nil {
-					resourceLogger.Error("unable to parse expiration date", slog.String("raw", ttl), slog.Any("error", err))
-					return nil
-				}
-
-				metricResourceTtl.AddTime(
-					prometheus.Labels{
-						"version":   resource.GetAPIVersion(),
-						"kind":      resource.GetKind(),
-						"namespace": resource.GetNamespace(),
-						"name":      resource.GetName(),
-						"ttl":       ttl,
-					},
-					*parsedDate,
-				)
-
-				resourceLogger.Debug("found resource with valid TTL", slog.Time("expirationDate", *parsedDate))
-
-				if expired {
-					if j.dryRun {
-						resourceLogger.Info("resource is expired, would delete resource (DRY-RUN)", slog.Time("expirationDate", *parsedDate))
-					} else {
-						resourceLogger.Info("resource is expired, deleting", slog.Time("expirationDate", *parsedDate))
-						err := j.dynClient.Resource(resourceType.AsGVR()).Namespace(resource.GetNamespace()).Delete(ctx, resource.GetName(), metav1.DeleteOptions{})
-						if err != nil {
-							return err
-						}
-					}
-				}
-			}
-
-			return nil
-		})
-		if err != nil {
-			return err
-		}
+	if err := j.runTtlResources(); err != nil {
+		return err
 	}
 
-	metricResourceTtl.GaugeSet(j.prometheus.ttl)
-
 	return nil
 }

kube_janitor/task.ttl.go

@@ -0,0 +1,98 @@
+package kube_janitor
+
+import (
+	"context"
+	"log/slog"
+	"strings"
+
+	"github.com/prometheus/client_golang/prometheus"
+	prometheusCommon "github.com/webdevops/go-common/prometheus"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+)
+
+func (j *Janitor) runTtlResources() error {
+	j.connect()
+
+	ctx := context.Background()
+
+	metricResourceTtl := prometheusCommon.NewMetricsList()
+
+	labelSelector := ""
+	// we can use a label selector if ttl is configured by label
+	if j.config.Ttl.Label != "" {
+		labelSelector = j.config.Ttl.Label
+	}
+
+	for _, resourceType := range j.config.Ttl.Resources {
+		gvkLogger := j.logger.With(slog.Any("gvk", resourceType))
+		gvkLogger.Debug("checking resources")
+
+		err := j.kubeEachResource(ctx, resourceType.AsGVR(), labelSelector, func(resource unstructured.Unstructured) error {
+			var ttlValue string
+
+			if j.config.Ttl.Annotation != "" {
+				// get from meta.annotations
+				if val, exists := resource.GetAnnotations()[j.config.Ttl.Annotation]; exists {
+					ttlValue = strings.TrimSpace(val)
+				}
+			} else if j.config.Ttl.Label != "" {
+				// get from meta.labels
+				if val, exists := resource.GetLabels()[j.config.Ttl.Label]; exists {
+					ttlValue = strings.TrimSpace(val)
+				}
+			}
+
+			// check if we got a valid ttl value
+			if ttlValue == "" {
+				return nil
+			}
+
+			resourceLogger := gvkLogger.With(
+				slog.String("namespace", resource.GetNamespace()),
+				slog.String("resource", resource.GetName()),
+				slog.String("ttl", ttlValue),
+			)
+
+			parsedDate, expired, err := j.checkExpiryDate(resource.GetCreationTimestamp().Time, ttlValue)
+			if err != nil {
+				resourceLogger.Error("unable to parse expiration date", slog.String("raw", ttlValue), slog.Any("error", err))
+				return nil
+			}
+
+			metricResourceTtl.AddTime(
+				prometheus.Labels{
+					"version":   resource.GetAPIVersion(),
+					"kind":      resource.GetKind(),
+					"namespace": resource.GetNamespace(),
+					"name":      resource.GetName(),
+					"ttl":       ttlValue,
+				},
+				*parsedDate,
+			)
+
+			resourceLogger.Debug("found resource with valid TTL", slog.Time("expirationDate", *parsedDate))
+
+			if expired {
+				if j.dryRun {
+					resourceLogger.Info("resource is expired, would delete resource (DRY-RUN)", slog.Time("expirationDate", *parsedDate))
+				} else {
+					resourceLogger.Info("deleting expired resource", slog.Time("expirationDate", *parsedDate))
+					err := j.dynClient.Resource(resourceType.AsGVR()).Namespace(resource.GetNamespace()).Delete(ctx, resource.GetName(), metav1.DeleteOptions{})
+					if err != nil {
+						return err
+					}
+				}
+			}
+
+			return nil
+		})
+		if err != nil {
+			return err
+		}
+	}
+
+	metricResourceTtl.GaugeSet(j.prometheus.ttl)
+
+	return nil
+}