Skip to content

Commit

Permalink
Add NGINX configuration for UpstreamSettingsPolicy (#2877)
Browse files Browse the repository at this point in the history
Translate data plane intermediary UpstreamSettingsPolicy configuration into NGINX configuration.

Problem: I want the data plane configuration generated from my UpstreamSettingsPolicy to be translated
into NGINX Configuration.

Solution: Translate the data plane UpstreamSettingsPolicy configuration into NGINX configuration.

Testing: Unit tests.
  • Loading branch information
bjee19 authored and kate-osborn committed Dec 20, 2024
1 parent 0a8a78a commit 6d12c4c
Show file tree
Hide file tree
Showing 12 changed files with 1,395 additions and 267 deletions.
12 changes: 12 additions & 0 deletions apis/v1alpha1/policy_methods.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
17 changes: 13 additions & 4 deletions internal/mode/static/nginx/config/generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,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"
)
Expand Down Expand Up @@ -152,7 +154,10 @@ func (g GeneratorImpl) executeConfigTemplates(
) []file.File {
fileBytes := make(map[string][]byte)

for _, execute := range g.getExecuteFuncs(generator) {
httpUpstreams := g.createUpstreams(conf.Upstreams, upstreamsettings.NewProcessor())
keepAliveCheck := newKeepAliveChecker(httpUpstreams)

for _, execute := range g.getExecuteFuncs(generator, httpUpstreams, keepAliveCheck) {
results := execute(conf)
for _, res := range results {
fileBytes[res.dest] = append(fileBytes[res.dest], res.data...)
Expand All @@ -177,12 +182,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,
keepAliveCheck keepAliveChecker,
) []executeFunc {
return []executeFunc{
executeMainConfig,
executeBaseHTTPConfig,
g.newExecuteServersFunc(generator),
g.executeUpstreams,
g.newExecuteServersFunc(generator, keepAliveCheck),
newExecuteUpstreamsFunc(upstreams),
executeSplitClients,
executeMaps,
executeTelemetry,
Expand Down
13 changes: 12 additions & 1 deletion internal/mode/static/nginx/config/http/config.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -85,9 +87,18 @@ type Upstream struct {
Name string
ZoneSize string // format: 512k, 1m
StateFile string
KeepAlive UpstreamKeepAlive
Servers []UpstreamServer
}

// UpstreamKeepAlive holds the keepalive configuration for an HTTP upstream.
type UpstreamKeepAlive struct {
Time string
Timeout string
Connections int32
Requests int32
}

// UpstreamServer holds all configuration for an HTTP upstream server.
type UpstreamServer struct {
Address string
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package upstreamsettings

import (
ngfAPI "github.com/nginxinc/nginx-gateway-fabric/apis/v1alpha1"
"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/http"
"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config/policies"
)

// Processor processes UpstreamSettingsPolicies.
type Processor struct{}

// UpstreamSettings contains settings from UpstreamSettingsPolicy.
type UpstreamSettings struct {
// ZoneSize is the zone size setting.
ZoneSize string
// KeepAlive contains the keepalive settings.
KeepAlive http.UpstreamKeepAlive
}

// NewProcessor returns a new Processor.
func NewProcessor() Processor {
return Processor{}
}

// Process processes policies into an UpstreamSettings object. The policies are already validated and are guaranteed
// to not contain overlapping settings. This method merges all fields in the policies into a single UpstreamSettings
// object.
func (g Processor) Process(pols []policies.Policy) UpstreamSettings {
return processPolicies(pols)
}

func processPolicies(pols []policies.Policy) UpstreamSettings {
upstreamSettings := 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.KeepAlive.Connections = *usp.Spec.KeepAlive.Connections
}

if usp.Spec.KeepAlive.Requests != nil {
upstreamSettings.KeepAlive.Requests = *usp.Spec.KeepAlive.Requests
}

if usp.Spec.KeepAlive.Time != nil {
upstreamSettings.KeepAlive.Time = string(*usp.Spec.KeepAlive.Time)
}

if usp.Spec.KeepAlive.Timeout != nil {
upstreamSettings.KeepAlive.Timeout = string(*usp.Spec.KeepAlive.Timeout)
}
}
}

return upstreamSettings
}
Loading

0 comments on commit 6d12c4c

Please sign in to comment.