Merge pull request #194 from nginxinc/keepalive

Add keepalive configmap key and annotation

Author: pleshakov

examples/customization/README.md

@@ -39,6 +39,7 @@ The table below summarizes some of the options. More options (extensions) are av
 | `nginx.org/listen-ports-ssl` | N/A | Configures HTTPS ports that NGINX will listen on. | `[443]` |
 | N/A | `worker-processes` | Sets the value of the [worker_processes](http://nginx.org/en/docs/ngx_core_module.html#worker_processes) directive. | `auto` |
 | N/A | `worker-cpu-affinity` | Sets the value of the [worker_cpu_affinity](http://nginx.org/en/docs/ngx_core_module.html#worker_cpu_affinity) directive. | N/A |
+| `nginx.org/keepalive` | `keepalive` | Sets the value of the [keepalive](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive) directive. Note that `proxy_set_header Connection "";` is added to the generated configuration when the value > 0. | `0` |
 
 ## Using ConfigMaps
 

examples/customization/nginx-config.yaml

@@ -46,3 +46,4 @@ data:
     charset  koi8-r;
   worker-processes: "1" # default is "auto". Sets the value of the worker_processes directive. See http://nginx.org/en/docs/ngx_core_module.html#worker_processes
   worker-cpu-affinity: "auto" # No default. Sets the value of the worker_cpu_affinity directive. See http://nginx.org/en/docs/ngx_core_module.html#worker_cpu_affinity
+  keepalive: "32" # default is 0. When > 0, sets the value of the keepalive directive and adds 'proxy_set_header Connection "";' to a location block. See http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive

nginx-controller/controller/controller.go

@@ -575,6 +575,13 @@ func (lbc *LoadBalancerController) syncCfgm(task Task) {
 		if workerCPUAffinity, exists := cfgm.Data["worker-cpu-affinity"]; exists {
 			cfg.MainWorkerCPUAffinity = workerCPUAffinity
 		}
+		if keepalive, exists, err := nginx.GetMapKeyAsInt(cfgm.Data, "keepalive", cfgm); exists {
+			if err != nil {
+				glog.Error(err)
+			} else {
+				cfg.Keepalive = keepalive
+			}
+		}
 	}
 
 	var ingExes []*nginx.IngressEx

nginx-controller/nginx/config.go

@@ -27,6 +27,7 @@ type Config struct {
 	LBMethod                      string
 	MainWorkerProcesses           string
 	MainWorkerCPUAffinity         string
+	Keepalive                     int64
 
 	// http://nginx.org/en/docs/http/ngx_http_realip_module.html
 	RealIPHeader    string

nginx-controller/nginx/configurator.go

@@ -179,7 +179,16 @@ func (cnf *Configurator) generateNginxCfg(ingEx *IngressEx, pems map[string]stri
 		servers = append(servers, server)
 	}
 
-	return IngressNginxConfig{Upstreams: upstreamMapToSlice(upstreams), Servers: servers}
+	var keepalive string
+	if ingCfg.Keepalive > 0 {
+		keepalive = strconv.FormatInt(ingCfg.Keepalive, 10)
+	}
+
+	return IngressNginxConfig{
+		Upstreams: upstreamMapToSlice(upstreams),
+		Servers:   servers,
+		Keepalive: keepalive,
+	}
 }
 
 func (cnf *Configurator) createConfig(ingEx *IngressEx) Config {
@@ -323,6 +332,14 @@ func (cnf *Configurator) createConfig(ingEx *IngressEx) Config {
 		ingCfg.SSLPorts = sslPorts
 	}
 
+	if keepalive, exists, err := GetMapKeyAsInt(ingEx.Ingress.Annotations, "nginx.org/keepalive", ingEx.Ingress); exists {
+		if err != nil {
+			glog.Error(err)
+		} else {
+			ingCfg.Keepalive = keepalive
+		}
+	}
+
 	return ingCfg
 }
 

nginx-controller/nginx/nginx.go

@@ -32,6 +32,7 @@ type NginxController struct {
 type IngressNginxConfig struct {
 	Upstreams []Upstream
 	Servers   []Server
+	Keepalive string
 }
 
 // Upstream describes an NGINX upstream

nginx-controller/nginx/templates/nginx-plus.ingress.tmpl

@@ -7,6 +7,7 @@ upstream {{$upstream.Name}} {
 	{{if $upstream.StickyCookie}}
 	sticky cookie {{$upstream.StickyCookie}};
 	{{end}}
+	{{if $.Keepalive}}keepalive {{$.Keepalive}};{{end}}
 }{{end}}
 
 {{range $server := .Servers}}
@@ -74,7 +75,9 @@ server {
 		{{if $location.Websocket}}
 		proxy_set_header Upgrade $http_upgrade;
 		proxy_set_header Connection $connection_upgrade;
-		{{end}}
+		{{- else}}
+		{{- if $.Keepalive}}proxy_set_header Connection "";{{end}}
+		{{- end}}
 
 		{{- if $location.LocationSnippets}}
 		{{range $value := $location.LocationSnippets}}

nginx-controller/nginx/templates/nginx.ingress.tmpl

@@ -3,6 +3,7 @@ upstream {{$upstream.Name}} {
 	{{if $upstream.LBMethod }}{{$upstream.LBMethod}};{{end}}
 	{{range $server := $upstream.UpstreamServers}}
 	server {{$server.Address}}:{{$server.Port}};{{end}}
+	{{if $.Keepalive}}keepalive {{$.Keepalive}};{{end}}
 }{{end}}
 
 {{range $server := .Servers}}
@@ -55,7 +56,9 @@ server {
 		{{if $location.Websocket}}
 		proxy_set_header Upgrade $http_upgrade;
 		proxy_set_header Connection $connection_upgrade;
-		{{end}}
+		{{- else}}
+		{{- if $.Keepalive}}proxy_set_header Connection "";{{end}}
+		{{- end}}
 
 		{{- if $location.LocationSnippets}}
 		{{range $value := $location.LocationSnippets}}

nginx-controller/nginx/templates/templates_test.go

@@ -43,6 +43,7 @@ var ingCfg = nginx.IngressNginxConfig{
 		},
 	},
 	Upstreams: []nginx.Upstream{testUps},
+	Keepalive: "16",
 }
 
 var mainCfg = nginx.NginxMainConfig{