MEDIUM: merge HTTPConnectionMode annotations into one.

This commit creates the annotation `http-connection-mode` to
replace the way to set the HTTP connection mode and deprecates
`http-keep-alive` and `http-server-close`.

Both the `http-keep-alive` and `http-server-close` annotations
change the value of `defaults.HTTPConnectionMode`. But since the
`http-keep-alive` annotation is evaluated last, it overwrites
whatever value `http-server-close` has previously set, even if
`http-keep-alive` is empty, undefined, or `'false'`.

It's better to merge these annotations into one since they are
mutually exclusive. After all, if you set `http-keep-alive: 'false'`,
you won't get the expected result: no options will be set and the
default will be used, **which is keep-alive**. Also, a third
alternative is not supported via annotations (httpclose).

The new annotation takes precedence over the old ones.

Author: fabianonunes

pkg/annotations/annotations.go

@@ -71,8 +71,6 @@ func (a annImpl) Global(g *models.Global, l *models.LogTargets) []Annotation {
 
 func (a annImpl) Defaults(d *models.Defaults) []Annotation {
 	return []Annotation{
-		global.NewOption("http-server-close", d),
-		global.NewOption("http-keep-alive", d),
 		global.NewOption("dontlognull", d),
 		global.NewOption("logasap", d),
 		global.NewTimeout("timeout-http-request", d),
@@ -85,6 +83,7 @@ func (a annImpl) Defaults(d *models.Defaults) []Annotation {
 		global.NewTimeout("timeout-tunnel", d),
 		global.NewTimeout("timeout-http-keep-alive", d),
 		global.NewLogFormat("log-format", d),
+		global.NewHTTPConnectionMode("http-connection-mode", d),
 	}
 }
 

pkg/annotations/global/connectionMode.go

@@ -0,0 +1,78 @@
+package global
+
+import (
+	"fmt"
+
+	"github.com/haproxytech/client-native/v3/models"
+
+	"github.com/haproxytech/kubernetes-ingress/pkg/annotations/common"
+	"github.com/haproxytech/kubernetes-ingress/pkg/store"
+	"github.com/haproxytech/kubernetes-ingress/pkg/utils"
+)
+
+var logger = utils.GetLogger()
+
+type HTTPConnectionMode struct {
+	name     string
+	defaults *models.Defaults
+}
+
+func NewHTTPConnectionMode(n string, d *models.Defaults) *HTTPConnectionMode {
+	return &HTTPConnectionMode{name: n, defaults: d}
+}
+
+func (a *HTTPConnectionMode) GetName() string {
+	return a.name
+}
+
+// processAlternativeAnnotations process connection mode annotations
+// Deprecated: this function can be removed when `http-server-close` and `http-keep-alive` become obsolete
+func (a *HTTPConnectionMode) processAlternativeAnnotations(httpConnectionMode string, annotations ...map[string]string) bool {
+	if httpConnectionMode != "" {
+		return false
+	}
+	var mode string
+	alternativeAnnotations := []string{"http-server-close", "http-keep-alive"}
+	for _, annotation := range alternativeAnnotations {
+		value := common.GetValue(annotation, annotations...)
+		if value == "" {
+			continue
+		}
+		enabled, err := utils.GetBoolValue(value, annotation)
+		if err != nil {
+			logger.Error(err.Error())
+			continue
+		}
+		logger.Warningf("annotation [%s] is DEPRECATED, use [http-connection-mode: \"%s\"] instead", annotation, annotation)
+		if enabled {
+			mode = annotation
+		}
+	}
+	if mode != "" {
+		a.defaults.HTTPConnectionMode = mode
+		return true
+	}
+	return false
+}
+
+func (a *HTTPConnectionMode) Process(k store.K8s, annotations ...map[string]string) error {
+	input := common.GetValue(a.GetName(), annotations...)
+
+	// this block can be removed when annotations `http-server-close` and `http-keep-alive` become obsolete
+	if a.processAlternativeAnnotations(input, annotations...) {
+		return nil
+	}
+
+	switch input {
+	case
+		"",
+		"http-keep-alive",
+		"http-server-close",
+		"httpclose":
+		break
+	default:
+		return fmt.Errorf("invalid http-connection-mode value '%s'", input)
+	}
+	a.defaults.HTTPConnectionMode = input
+	return nil
+}

pkg/annotations/global/option.go

@@ -30,8 +30,6 @@ func (a *Option) Process(k store.K8s, annotations ...map[string]string) error {
 	input := common.GetValue(a.GetName(), annotations...)
 	if input == "" {
 		switch a.name {
-		case "http-server-close", "http-keep-alive":
-			a.defaults.HTTPConnectionMode = ""
 		case "dontlognull":
 			a.defaults.Dontlognull = ""
 		case "logasap":
@@ -48,10 +46,6 @@ func (a *Option) Process(k store.K8s, annotations ...map[string]string) error {
 	}
 	if enabled {
 		switch a.name {
-		case "http-server-close":
-			a.defaults.HTTPConnectionMode = "http-server-close"
-		case "http-keep-alive":
-			a.defaults.HTTPConnectionMode = "http-keep-alive"
 		case "dontlognull":
 			a.defaults.Dontlognull = "enabled"
 		case "logasap":
@@ -61,8 +55,6 @@ func (a *Option) Process(k store.K8s, annotations ...map[string]string) error {
 		}
 	} else {
 		switch a.name {
-		case "http-server-close", "http-keep-alive":
-			a.defaults.HTTPConnectionMode = ""
 		case "dontlognull":
 			a.defaults.Dontlognull = "disabled"
 		case "logasap":