Add NGINX configuration for UpstreamSettingsPolicy

apis/v1alpha1/policy_methods.go

@@ -31,3 +31,15 @@ func (p *ObservabilityPolicy) GetPolicyStatus() v1alpha2.PolicyStatus {
 func (p *ObservabilityPolicy) SetPolicyStatus(status v1alpha2.PolicyStatus) {
 	p.Status = status
 }
+
+func (p *UpstreamSettingsPolicy) GetTargetRefs() []v1alpha2.LocalPolicyTargetReference {
+	return p.Spec.TargetRefs
+}
+
+func (p *UpstreamSettingsPolicy) GetPolicyStatus() v1alpha2.PolicyStatus {
+	return p.Status
+}
+
+func (p *UpstreamSettingsPolicy) SetPolicyStatus(status v1alpha2.PolicyStatus) {
+	p.Status = status
+}

config/crd/bases/gateway.nginx.org_upstreamsettingspolicies.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.2
+    controller-gen.kubebuilder.io/version: v0.16.5
   labels:
     gateway.networking.k8s.io/policy: direct
   name: upstreamsettingspolicies.gateway.nginx.org
@@ -76,13 +76,13 @@ spec:
                       Time defines the maximum time during which requests can be processed through one keep-alive connection.
                       After this time is reached, the connection is closed following the subsequent request processing.
                       Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_time
-                    pattern: ^\d{1,4}(ms|s)?$
+                    pattern: ^[0-9]{1,4}(ms|s|m|h)?$
                     type: string
                   timeout:
                     description: |-
                       Timeout defines the keep-alive timeout for upstreams.
                       Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout
-                    pattern: ^\d{1,4}(ms|s)?$
+                    pattern: ^[0-9]{1,4}(ms|s|m|h)?$
                     type: string
                 type: object
               targetRefs:

internal/mode/static/nginx/config/generator.go

@@ -6,9 +6,11 @@ import (
 	"github.com/go-logr/logr"
 
 	ngfConfig "github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/config"
+	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/http"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies/clientsettings"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies/observability"
+	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies/upstreamsettings"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/file"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/state/dataplane"
 )
@@ -131,7 +133,10 @@ func (g GeneratorImpl) executeConfigTemplates(
 ) []file.File {
 	fileBytes := make(map[string][]byte)
 
-	for _, execute := range g.getExecuteFuncs(generator) {
+	upstreams := g.createUpstreams(conf.Upstreams, upstreamsettings.NewProcessor())
+	upstreamMap := g.createUpstreamMap(upstreams)
+
+	for _, execute := range g.getExecuteFuncs(generator, upstreams, upstreamMap) {
 		results := execute(conf)
 		for _, res := range results {
 			fileBytes[res.dest] = append(fileBytes[res.dest], res.data...)
@@ -156,12 +161,16 @@ func (g GeneratorImpl) executeConfigTemplates(
 	return files
 }
 
-func (g GeneratorImpl) getExecuteFuncs(generator policies.Generator) []executeFunc {
+func (g GeneratorImpl) getExecuteFuncs(
+	generator policies.Generator,
+	upstreams []http.Upstream,
+	upstreamMap UpstreamMap,
+) []executeFunc {
 	return []executeFunc{
 		executeMainConfig,
 		executeBaseHTTPConfig,
-		g.newExecuteServersFunc(generator),
-		g.executeUpstreams,
+		g.newExecuteServersFunc(generator, upstreamMap),
+		g.newExecuteUpstreamsFunc(upstreams),
 		executeSplitClients,
 		executeMaps,
 		executeTelemetry,

internal/mode/static/nginx/config/http/config.go

@@ -1,6 +1,8 @@
 package http
 
-import "github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/shared"
+import (
+	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/shared"
+)
 
 const (
 	InternalRoutePathPrefix = "/_ngf-internal"
@@ -82,9 +84,13 @@ const (
 
 // Upstream holds all configuration for an HTTP upstream.
 type Upstream struct {
-	Name     string
-	ZoneSize string // format: 512k, 1m
-	Servers  []UpstreamServer
+	Name                 string
+	ZoneSize             string // format: 512k, 1m
+	KeepAliveTime        string
+	KeepAliveTimeout     string
+	Servers              []UpstreamServer
+	KeepAliveConnections int32
+	KeepAliveRequests    int32
 }
 
 // UpstreamServer holds all configuration for an HTTP upstream server.

internal/mode/static/nginx/config/policies/processor.go

@@ -0,0 +1,21 @@
+package policies
+
+// UpstreamSettingsProcessor defines an interface for an UpstreamSettingsPolicy processor
+// to implement the process function.
+type UpstreamSettingsProcessor interface {
+	Process(policies []Policy) UpstreamSettings
+}
+
+// UpstreamSettings contains settings from UpstreamSettingsPolicy.
+type UpstreamSettings struct {
+	// ZoneSize is the zone size setting.
+	ZoneSize string
+	// KeepAliveTime is the keep-alive time setting.
+	KeepAliveTime string
+	// KeepAliveTimeout is the keep-alive timeout setting.
+	KeepAliveTimeout string
+	// KeepAliveConnections is the keep-alive connections setting.
+	KeepAliveConnections int32
+	// KeepAliveRequests is the keep-alive requests setting.
+	KeepAliveRequests int32
+}

internal/mode/static/nginx/config/policies/upstreamsettings/processor.go

@@ -0,0 +1,56 @@
+package upstreamsettings
+
+import (
+	ngfAPI "github.com/nginxinc/nginx-gateway-fabric/apis/v1alpha1"
+	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies"
+)
+
+// Processor processes UpstreamSettingsPolicies.
+type Processor struct{}
+
+// NewProcessor returns a new instance of Processor.
+func NewProcessor() *Processor {
+	return &Processor{}
+}
+
+// Process processes policy configuration for an upstream block.
+func (g Processor) Process(pols []policies.Policy) policies.UpstreamSettings {
+	return processPolicies(pols)
+}
+
+func processPolicies(pols []policies.Policy) policies.UpstreamSettings {
+	upstreamSettings := policies.UpstreamSettings{}
+
+	for _, pol := range pols {
+		usp, ok := pol.(*ngfAPI.UpstreamSettingsPolicy)
+		if !ok {
+			continue
+		}
+
+		// we can assume that there will be no instance of two or more policies setting the same
+		// field for the same service
+		if usp.Spec.ZoneSize != nil {
+			upstreamSettings.ZoneSize = string(*usp.Spec.ZoneSize)
+		}
+
+		if usp.Spec.KeepAlive != nil {
+			if usp.Spec.KeepAlive.Connections != nil {
+				upstreamSettings.KeepAliveConnections = *usp.Spec.KeepAlive.Connections
+			}
+
+			if usp.Spec.KeepAlive.Requests != nil {
+				upstreamSettings.KeepAliveRequests = *usp.Spec.KeepAlive.Requests
+			}
+
+			if usp.Spec.KeepAlive.Time != nil {
+				upstreamSettings.KeepAliveTime = string(*usp.Spec.KeepAlive.Time)
+			}
+
+			if usp.Spec.KeepAlive.Timeout != nil {
+				upstreamSettings.KeepAliveTimeout = string(*usp.Spec.KeepAlive.Timeout)
+			}
+		}
+	}
+
+	return upstreamSettings
+}

internal/mode/static/nginx/config/policies/upstreamsettings/processor_test.go

@@ -0,0 +1,166 @@
+package upstreamsettings
+
+import (
+	"testing"
+
+	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	ngfAPI "github.com/nginxinc/nginx-gateway-fabric/apis/v1alpha1"
+	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/helpers"
+	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies"
+)
+
+func TestProcess(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name                string
+		expUpstreamSettings policies.UpstreamSettings
+		policies            []policies.Policy
+	}{
+		{
+			name: "all fields populated",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{
+						ZoneSize: helpers.GetPointer[ngfAPI.Size]("2m"),
+						KeepAlive: helpers.GetPointer(ngfAPI.UpstreamKeepAlive{
+							Connections: helpers.GetPointer(int32(1)),
+							Requests:    helpers.GetPointer(int32(1)),
+							Time:        helpers.GetPointer[ngfAPI.Duration]("5s"),
+							Timeout:     helpers.GetPointer[ngfAPI.Duration]("10s"),
+						}),
+					},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{
+				ZoneSize:             "2m",
+				KeepAliveConnections: 1,
+				KeepAliveRequests:    1,
+				KeepAliveTime:        "5s",
+				KeepAliveTimeout:     "10s",
+			},
+		},
+		{
+			name: "zone size set",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{
+						ZoneSize: helpers.GetPointer[ngfAPI.Size]("2m"),
+					},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{
+				ZoneSize: "2m",
+			},
+		},
+		{
+			name: "keep alive connections set",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{
+						KeepAlive: helpers.GetPointer(ngfAPI.UpstreamKeepAlive{
+							Connections: helpers.GetPointer(int32(1)),
+						}),
+					},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{
+				KeepAliveConnections: 1,
+			},
+		},
+		{
+			name: "keep alive requests set",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{
+						KeepAlive: helpers.GetPointer(ngfAPI.UpstreamKeepAlive{
+							Requests: helpers.GetPointer(int32(1)),
+						}),
+					},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{
+				KeepAliveRequests: 1,
+			},
+		},
+		{
+			name: "keep alive time set",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{
+						KeepAlive: helpers.GetPointer(ngfAPI.UpstreamKeepAlive{
+							Time: helpers.GetPointer[ngfAPI.Duration]("5s"),
+						}),
+					},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{
+				KeepAliveTime: "5s",
+			},
+		},
+		{
+			name: "keep alive timeout set",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{
+						KeepAlive: helpers.GetPointer(ngfAPI.UpstreamKeepAlive{
+							Timeout: helpers.GetPointer[ngfAPI.Duration]("10s"),
+						}),
+					},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{
+				KeepAliveTimeout: "10s",
+			},
+		},
+		{
+			name: "no fields populated",
+			policies: []policies.Policy{
+				&ngfAPI.UpstreamSettingsPolicy{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "usp",
+						Namespace: "test",
+					},
+					Spec: ngfAPI.UpstreamSettingsPolicySpec{},
+				},
+			},
+			expUpstreamSettings: policies.UpstreamSettings{},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			g := NewWithT(t)
+			processor := NewProcessor()
+
+			g.Expect(processor.Process(test.policies)).To(Equal(test.expUpstreamSettings))
+		})
+	}
+}