CLEANUP/MINOR: simplify frontend custom annotations

Author: oktalz

deploy/tests/integration/base-suite.go

@@ -159,6 +159,7 @@ func (suite *BaseSuite) StopController() {
 	testController := suite.TestControllers[suite.T().Name()]
 	testController.Controller.Stop()
 	testController.Store.Clean()
+	annotations.Clean()
 	close(testController.EventChan)
 }
 

documentation/annotations-custom.md

@@ -112,7 +112,7 @@ backend default_svc_http-echo_http
   ...
 ```
 
-we can see that a config snippet was added, but compared to regular snippet, our annotation has full validation that we defined (and also its limiting what we can put)
+we can see that a config snippet was added, but compared to regular snippet, our annotation has full validation that we defined (and also it is limiting what we can put)
 
 what happens if we try to add value that is not accepted ?
 
@@ -147,6 +147,13 @@ if template is not defined, value as is will be copied
 
 usage
 
+```yaml
+backend.example.com/maxconn: "1000"
+```
+
+⚠ `duration`, `int`, `uint`, `bool` and `float` values needs to be defined as strings in annotation value. This is limitation of k8s for annotation values. If using type `json` normal number and boolean values can be used.
+
+**invalid**
 ```yaml
 backend.example.com/maxconn: 1000
 ```
@@ -314,7 +321,7 @@ config
       rule: "value > duration('42s') && value <= duration('42m')" # CEL expression
 ```
 
-## How do i create frontend annotations ?
+## How do I create frontend annotations ?
 
 in same way as backend ones, except there is no `frontend` object in k8s. Therefore we will use configmap
 
@@ -325,24 +332,39 @@ metadata:
   name: haproxy-kubernetes-ingress
   namespace: haproxy-controller
   annotations:
-    frontend.http.example.com/timeout-server: "5s"
-    frontend.http.example.com/timeout-client: "6s"
-    frontend.https.example.com/timeout-server: "7s"
-    frontend.stats.example.com/timeout-server: "8s"
+    frontend.example.com/timeout-server: "5s"
+    frontend.example.com/timeout-client: "6s"
 data:
-  syslog-server: |
-    address: stdout, format: raw, facility:daemon
-  cr-global: haproxy-controller/global-full
+  ...
 ```
 
-its similar as with other configuration values, except we define it as configmap annotations
+it is similar as with other configuration values, except we define it as configmap annotations.
 
 ### Structure
 
-`frontend.<frontend-name>.<org>/<custom-annotation-name>`
+`frontend.<prefix>/<custom-annotation-name>`
+
+With HAProxy Ingress controller, you have 3 different frontends: `http`, `https` and `stats`, each can be customized with custom annotations.
 
-the only difference is extra information what frontend this settings belong to. With HAProxy Ingress controller, you have 3 different frontends: `http`, `https` and `stats`, each can be customized with custom annotations.
+If you want to create a annotation for specific frontend use `resources` as shown in example:
 
+```yaml
+apiVersion: ingress.v3.haproxy.org/v3
+kind: ValidationRules
+metadata:
+  name: custom-validation-rules
+  namespace: haproxy-controller
+spec:
+  prefix: "haproxy.org"
+  validation_rules:
+    maxconn:
+      section: frontend
+      resources:
+        - http
+        - https
+      type: int
+      rule: "value >= 10 && value <= 1000000"
+```
 
 ## Where can custom annotations can be defined ?
 
@@ -357,7 +379,7 @@ metadata:
   name: haproxy-kubernetes-ingress
   namespace: haproxy-controller
   annotations:
-    frontend.<frontend-name>.<org>/<custom-annotation-name>: <value>
+    frontend.<org>/<custom-annotation-name>: <value>
 ```
 
 ### Backend Annotations

pkg/annotations/cfgSnippet-user-annotations.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	"github.com/haproxytech/kubernetes-ingress/pkg/annotations/validators"
+	"github.com/haproxytech/kubernetes-ingress/pkg/store"
 )
 
 func processCustomAnnotationsFrontend(customAnnotations map[string]string, a *CfgSnippet, validator *validators.Validator) error {
@@ -71,6 +72,14 @@ func processCustomAnnotationsFrontend(customAnnotations map[string]string, a *Cf
 		}
 		processConfigSnippetFrontendCustom(a.frontend, origin, rdata, len(keys)-index+1)
 	}
+	if len(keys) == 0 && len(cfgSnippet.frontendsCustom[a.frontend]) != 0 {
+		// go through cfgSnippet.frontendsCustom[a.frontend] and mark them as deleted
+		for _, value := range cfgSnippet.frontendsCustom[a.frontend] {
+			value.status = store.DELETED
+			value.value = []string{}
+			value.updated = []string{}
+		}
+	}
 
 	return nil
 }

pkg/annotations/cfgSnippet.go

@@ -85,6 +85,19 @@ func InitCfgSnippet() {
 	cfgSnippet.disabledSnippets = make(map[CfgSnippetType]struct{})
 }
 
+// Clean removes all deleted custom config snippets from the global map cfgSnippet.
+// It iterates over the frontend custom config snippets and checks if any of them
+// have a status of DELETED. If so, it deletes them from the map.
+func Clean() {
+	for _, v := range cfgSnippet.frontendsCustom {
+		for annKey, annVal := range v {
+			if annVal.status == store.DELETED {
+				delete(v, annKey)
+			}
+		}
+	}
+}
+
 type ConfigSnippetOptions struct {
 	Backend  *string
 	Frontend *string
@@ -156,8 +169,8 @@ func (a *CfgSnippet) Process(k store.K8s, annotations ...map[string]string) erro
 		customAnnotations := map[string]string{}
 		for _, annotation := range annotations {
 			for k, v := range annotation {
-				if strings.HasPrefix(k, "frontend."+a.frontend+"."+validator.Prefix()) {
-					key := strings.TrimPrefix(k, "frontend."+a.frontend+"."+validator.Prefix())
+				if strings.HasPrefix(k, "frontend."+validator.Prefix()) {
+					key := strings.TrimPrefix(k, "frontend."+validator.Prefix())
 					customAnnotations[key] = v
 				}
 			}
@@ -268,13 +281,20 @@ func UpdateFrontendCfgSnippet(api api.HAProxyClient, frontends ...string) (updat
 		if !ok && !okCustom {
 			continue
 		}
+		deleted := []string{}
 		if okCustom {
 			newData := make([]string, 0)
-			for _, v := range customData {
+			for k, v := range customData {
+				if v.status == store.DELETED {
+					updated = append(updated, "DELETED: "+k)
+					deleted = append(deleted, k)
+					continue
+				}
 				newData = append(newData, v.value...)
 				updated = append(updated, v.updated...)
 			}
-			if len(customData) > 0 {
+
+			if len(newData) > 0 {
 				newData = append(newData, "### custom annotations end ###")
 			}
 			if data != nil && len(data.value) > 0 {
@@ -283,7 +303,7 @@ func UpdateFrontendCfgSnippet(api api.HAProxyClient, frontends ...string) (updat
 				data = &cfgData{value: newData}
 			}
 		}
-		if data == nil || len(data.value) == 0 {
+		if len(deleted) == 0 && (data == nil || len(data.value) == 0) {
 			continue
 		}
 		err = api.FrontendCfgSnippetSet(ft, data.value)

pkg/controller/controller.go

@@ -350,6 +350,7 @@ func (c *HAProxyController) clean(failedSync bool) {
 	logger.Error(c.setupHAProxyRules())
 	if !failedSync {
 		c.store.Clean()
+		annotations.Clean()
 	}
 }