Skip to content

GenerateVirtualServer upstreams config refactor #7264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+145 −62
Open

GenerateVirtualServer upstreams config refactor #7264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e2a433f
create function to generate errorPageDetails struct
pdabelf5 Feb 3, 2025
980a835
rename backup endpoint variable
pdabelf5 Feb 3, 2025
cea91f2
move similar generate upstreams to a function
pdabelf5 Feb 4, 2025
a0478b2
Merge branch 'main' into vs-config-refactor
jjngx Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 76 additions & 62 deletions internal/configs/virtualserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,63 +472,37 @@

// generate upstreams for VirtualServer
for _, u := range vsEx.VirtualServer.Spec.Upstreams {

if (sslConfig == nil || !vsc.cfgParams.HTTP2) && isGRPC(u.Type) {
vsc.addWarningf(vsEx.VirtualServer, "gRPC cannot be configured for upstream %s. gRPC requires enabled HTTP/2 and TLS termination.", u.Name)
}

upstreamName := virtualServerUpstreamNamer.GetNameForUpstream(u.Name)
upstreamNamespace := vsEx.VirtualServer.Namespace
endpoints := vsc.generateEndpointsForUpstream(vsEx.VirtualServer, upstreamNamespace, u, vsEx)
backupEndpoints := vsc.generateBackupEndpointsForUpstream(vsEx.VirtualServer, upstreamNamespace, u, vsEx)

// isExternalNameSvc is always false for OSS
_, isExternalNameSvc := vsEx.ExternalNameSvcs[GenerateExternalNameSvcKey(upstreamNamespace, u.Service)]
ups := vsc.generateUpstream(vsEx.VirtualServer, upstreamName, u, isExternalNameSvc, endpoints, backupEndpoints)
upstreams = append(upstreams, ups)

u.TLS.Enable = isTLSEnabled(u, vsc.spiffeCerts, vsEx.VirtualServer.Spec.InternalRoute)
crUpstreams[upstreamName] = u

if hc := generateHealthCheck(u, upstreamName, vsc.cfgParams); hc != nil {
healthChecks = append(healthChecks, *hc)
if u.HealthCheck.StatusMatch != "" {
statusMatches = append(
statusMatches,
generateUpstreamStatusMatch(upstreamName, u.HealthCheck.StatusMatch),
)
}
}
upstreams, healthChecks, statusMatches = generateUpstreams(
sslConfig,
vsc,
u,
vsEx.VirtualServer,
vsEx.VirtualServer.Namespace,
virtualServerUpstreamNamer,
vsEx,
upstreams,
crUpstreams,
healthChecks,
statusMatches,
)
}
// generate upstreams for each VirtualServerRoute
for _, vsr := range vsEx.VirtualServerRoutes {
upstreamNamer := NewUpstreamNamerForVirtualServerRoute(vsEx.VirtualServer, vsr)
for _, u := range vsr.Spec.Upstreams {
if (sslConfig == nil || !vsc.cfgParams.HTTP2) && isGRPC(u.Type) {
vsc.addWarningf(vsr, "gRPC cannot be configured for upstream %s. gRPC requires enabled HTTP/2 and TLS termination", u.Name)
}

upstreamName := upstreamNamer.GetNameForUpstream(u.Name)
upstreamNamespace := vsr.Namespace
endpoints := vsc.generateEndpointsForUpstream(vsr, upstreamNamespace, u, vsEx)
backup := vsc.generateBackupEndpointsForUpstream(vsEx.VirtualServer, upstreamNamespace, u, vsEx)

// isExternalNameSvc is always false for OSS
_, isExternalNameSvc := vsEx.ExternalNameSvcs[GenerateExternalNameSvcKey(upstreamNamespace, u.Service)]
ups := vsc.generateUpstream(vsr, upstreamName, u, isExternalNameSvc, endpoints, backup)
upstreams = append(upstreams, ups)
u.TLS.Enable = isTLSEnabled(u, vsc.spiffeCerts, vsEx.VirtualServer.Spec.InternalRoute)
crUpstreams[upstreamName] = u

if hc := generateHealthCheck(u, upstreamName, vsc.cfgParams); hc != nil {
healthChecks = append(healthChecks, *hc)
if u.HealthCheck.StatusMatch != "" {
statusMatches = append(
statusMatches,
generateUpstreamStatusMatch(upstreamName, u.HealthCheck.StatusMatch),
)
}
}
upstreams, healthChecks, statusMatches = generateUpstreams(
sslConfig,
vsc,
u,
vsr,
vsr.Namespace,
upstreamNamer,
vsEx,
upstreams,
crUpstreams,
healthChecks,
statusMatches,
)
}
}

Expand All @@ -551,11 +525,7 @@

// generates config for VirtualServer routes
for _, r := range vsEx.VirtualServer.Spec.Routes {
errorPages := errorPageDetails{
pages: r.ErrorPages,
index: len(errorPageLocations),
owner: vsEx.VirtualServer,
}
errorPages := generateErrorPageDetails(r.ErrorPages, errorPageLocations, vsEx.VirtualServer)
errorPageLocations = append(errorPageLocations, generateErrorPageLocations(errorPages.index, errorPages.pages)...)

// ignore routes that reference VirtualServerRoute
Expand Down Expand Up @@ -699,11 +669,7 @@
isVSR := true
upstreamNamer := NewUpstreamNamerForVirtualServerRoute(vsEx.VirtualServer, vsr)
for _, r := range vsr.Spec.Subroutes {
errorPages := errorPageDetails{
pages: r.ErrorPages,
index: len(errorPageLocations),
owner: vsr,
}
errorPages := generateErrorPageDetails(r.ErrorPages, errorPageLocations, vsr)
errorPageLocations = append(errorPageLocations, generateErrorPageLocations(errorPages.index, errorPages.pages)...)
vsrNamespaceName := fmt.Sprintf("%v/%v", vsr.Namespace, vsr.Name)
// use the VirtualServer error pages if the route does not define any
Expand Down Expand Up @@ -929,6 +895,46 @@
return vsCfg, vsc.warnings
}

func generateUpstreams(
sslConfig *version2.SSL,
vsc *virtualServerConfigurator,
u conf_v1.Upstream,
owner runtime.Object,
ownerNamespace string,
upstreamNamer *upstreamNamer,
vsEx *VirtualServerEx,
upstreams []version2.Upstream,
crUpstreams map[string]conf_v1.Upstream,
healthChecks []version2.HealthCheck,
statusMatches []version2.StatusMatch,
) ([]version2.Upstream, []version2.HealthCheck, []version2.StatusMatch) {
if (sslConfig == nil || !vsc.cfgParams.HTTP2) && isGRPC(u.Type) {
vsc.addWarningf(owner, "gRPC cannot be configured for upstream %s. gRPC requires enabled HTTP/2 and TLS termination", u.Name)
}

Check warning on line 913 in internal/configs/virtualserver.go

View check run for this annotation

Codecov / codecov/patch

internal/configs/virtualserver.go#L912-L913 

Added lines #L912 - L913 were not covered by tests

upstreamName := upstreamNamer.GetNameForUpstream(u.Name)
endpoints := vsc.generateEndpointsForUpstream(owner, ownerNamespace, u, vsEx)
backup := vsc.generateBackupEndpointsForUpstream(owner, ownerNamespace, u, vsEx)

// isExternalNameSvc is always false for OSS
_, isExternalNameSvc := vsEx.ExternalNameSvcs[GenerateExternalNameSvcKey(ownerNamespace, u.Service)]
ups := vsc.generateUpstream(owner, upstreamName, u, isExternalNameSvc, endpoints, backup)
upstreams = append(upstreams, ups)
u.TLS.Enable = isTLSEnabled(u, vsc.spiffeCerts, vsEx.VirtualServer.Spec.InternalRoute)
crUpstreams[upstreamName] = u

if hc := generateHealthCheck(u, upstreamName, vsc.cfgParams); hc != nil {
healthChecks = append(healthChecks, *hc)
if u.HealthCheck.StatusMatch != "" {
statusMatches = append(
statusMatches,
generateUpstreamStatusMatch(upstreamName, u.HealthCheck.StatusMatch),
)
}

Check warning on line 933 in internal/configs/virtualserver.go

View check run for this annotation

Codecov / codecov/patch

internal/configs/virtualserver.go#L927-L933 

Added lines #L927 - L933 were not covered by tests
}
return upstreams, healthChecks, statusMatches
}

// rateLimit hold the configuration for the ratelimiting Policy
type rateLimit struct {
Reqs []version2.LimitReq
Expand Down Expand Up @@ -3194,6 +3200,14 @@
return ePages
}

func generateErrorPageDetails(errorPages []conf_v1.ErrorPage, errorPageLocations []version2.ErrorPageLocation, owner runtime.Object) errorPageDetails {
return errorPageDetails{
pages: errorPages,
index: len(errorPageLocations),
owner: owner,
}
}

func generateErrorPageLocations(errPageIndex int, errorPages []conf_v1.ErrorPage) []version2.ErrorPageLocation {
var errorPageLocations []version2.ErrorPageLocation
for i, e := range errorPages {
Expand Down
69 changes: 69 additions & 0 deletions internal/configs/virtualserver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16912,6 +16912,75 @@ func TestGenerateErrorPageLocations(t *testing.T) {
}
}

func TestGenerateErrorPageDetails(t *testing.T) {
t.Parallel()
tests := []struct {
errorPages []conf_v1.ErrorPage
errorLocations []version2.ErrorPageLocation
owner runtime.Object
expected errorPageDetails
}{
{}, // empty
{
errorPages: []conf_v1.ErrorPage{
{
Codes: []int{404, 405, 500, 502},
Return: &conf_v1.ErrorPageReturn{
ActionReturn: conf_v1.ActionReturn{
Code: 200,
Headers: nil,
},
},
Redirect: nil,
},
},
errorLocations: []version2.ErrorPageLocation{
{
Name: "@error_page_0_0",
DefaultType: "text/plain",
Return: &version2.Return{
Text: "All Good",
},
},
},
owner: &conf_v1.VirtualServer{
ObjectMeta: meta_v1.ObjectMeta{
Namespace: "namespace",
Name: "name",
},
},
expected: errorPageDetails{
pages: []conf_v1.ErrorPage{
{
Codes: []int{404, 405, 500, 502},
Return: &conf_v1.ErrorPageReturn{
ActionReturn: conf_v1.ActionReturn{
Code: 200,
Headers: nil,
},
},
Redirect: nil,
},
},
index: 1,
owner: &conf_v1.VirtualServer{
ObjectMeta: meta_v1.ObjectMeta{
Namespace: "namespace",
Name: "name",
},
},
},
},
}

for _, test := range tests {
result := generateErrorPageDetails(test.errorPages, test.errorLocations, test.owner)
if !reflect.DeepEqual(result, test.expected) {
t.Errorf("generateErrorPageDetails() returned %v but expected %v", result, test.expected)
}
}
}

func TestGenerateProxySSLName(t *testing.T) {
t.Parallel()
result := generateProxySSLName("coffee-v1", "default")
Expand Down
Loading