feat(hybridgateway): update naming for autogenerated resources (#2566)

Signed-off-by: Francesco Giudici <[email protected]>
Co-authored-by: Jakub Warczarek <[email protected]>

Author: fgiudici

CHANGELOG.md

@@ -133,6 +133,8 @@
 - For Hybrid `Gateway`s the operator does not run the `ControlPlane` anymore, as
   the `DataPlane` is configured to use `Koko` as Konnect control plane.
   [#2253](https://github.com/Kong/kong-operator/pull/2253)
+- HybridGateway auto-generated resource names has been revised.
+  [#2566](https://github.com/Kong/kong-operator/pull/2566)
 
 ### Fixes
 

controller/hybridgateway/converter/http_route.go

@@ -312,13 +312,10 @@ func (c *httpRouteConverter) translate(ctx context.Context, logger logr.Logger)
 	log.Debug(logger, "Found supported parent references",
 		"parentRefCount", len(supportedParentRefs))
 
-	httpRouteName := c.route.Namespace + "-" + c.route.Name
-
 	for _, pRefData := range supportedParentRefs {
 		pRef := pRefData.parentRef
 		cp := pRefData.cpRef
 		hostnames := pRefData.hostnames
-		cpRefName := "cp" + utils.Hash32(cp)
 
 		log.Debug(logger, "Processing parent reference",
 			"parentRef", pRef,
@@ -331,8 +328,9 @@ func (c *httpRouteConverter) translate(ctx context.Context, logger logr.Logger)
 				"backendRefCount", len(rule.BackendRefs),
 				"matchCount", len(rule.Matches),
 				"filterCount", len(rule.Filters))
+
 			// Build the KongUpstream resource.
-			upstreamName := namegen.NewName(httpRouteName, cpRefName, utils.Hash32(rule.BackendRefs)).String()
+			upstreamName := namegen.NewKongUpstreamName(cp, rule)
 			log.Trace(logger, "Building KongUpstream resource",
 				"upstream", upstreamName,
 				"controlPlane", cp.KonnectNamespacedRef)
@@ -385,7 +383,7 @@ func (c *httpRouteConverter) translate(ctx context.Context, logger logr.Logger)
 			}
 
 			// Build the KongService resource.
-			serviceName := namegen.NewName(httpRouteName, cpRefName, utils.Hash32(rule.BackendRefs)).String()
+			serviceName := namegen.NewKongServiceName(cp, rule)
 			log.Trace(logger, "Building KongService resource",
 				"service", serviceName,
 				"upstream", upstreamName)
@@ -411,7 +409,7 @@ func (c *httpRouteConverter) translate(ctx context.Context, logger logr.Logger)
 				"service", serviceName)
 
 			// Build the kong route resource.
-			routeName := namegen.NewName(httpRouteName, cpRefName, utils.Hash32(rule.Matches)).String()
+			routeName := namegen.NewKongRouteName(c.route, cp, rule)
 			log.Trace(logger, "Building KongRoute resource",
 				"kongRoute", routeName,
 				"service", serviceName,
@@ -450,8 +448,7 @@ func (c *httpRouteConverter) translate(ctx context.Context, logger logr.Logger)
 				"filterCount", len(rule.Filters))
 
 			for _, filter := range rule.Filters {
-				filterHash := utils.Hash32(filter)
-				pluginName := namegen.NewName(httpRouteName, cpRefName, filterHash).String()
+				pluginName := namegen.NewKongPluginName(filter)
 
 				log.Trace(logger, "Building KongPlugin resource",
 					"plugin", pluginName,
@@ -474,7 +471,7 @@ func (c *httpRouteConverter) translate(ctx context.Context, logger logr.Logger)
 				c.outputStore = append(c.outputStore, &plugin)
 
 				// Create a KongPluginBinding to bind the KongPlugin to each rule match.
-				bindingName := routeName + "." + filterHash
+				bindingName := namegen.NewKongPluginBindingName(routeName, pluginName)
 				log.Trace(logger, "Building KongPluginBinding resource",
 					"binding", bindingName,
 					"plugin", pluginName,

controller/hybridgateway/namegen/name.go

@@ -3,71 +3,79 @@ package namegen
 import (
 	"strings"
 
+	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
+
+	commonv1alpha1 "github.com/kong/kong-operator/api/common/v1alpha1"
 	"github.com/kong/kong-operator/controller/hybridgateway/utils"
+	gwtypes "github.com/kong/kong-operator/internal/types"
 )
 
-// Name represents a structured naming scheme for Kong entities to be identified by the HTTPRoute, ParentReference,
-// and HTTPRoute section from which the resource is derived.
-type Name struct {
-	httpRouteID string
-	parentRefID string
-	sectionID   string
-}
-
-// String returns the full name as a dot-separated string.
-func (h *Name) String() string {
-	const maxLen = 253 - len("faf385ae") - 1 // reserve space for one extra hash (+ 1 dot) for child resources (e.g., KongTargets)
+const (
+	httpProcolPrefix = "http"
+	defaultCPPrefix  = "cp"
+	namegenPrefix    = "ngn"
+	maxLen           = 253
+)
 
-	parts := []string{}
-	if h.httpRouteID != "" {
-		parts = append(parts, h.httpRouteID)
+// newName generates a name by concatenating the given components if the length is within the limit of
+// Kubernetes resource names, otherwise it returns a hashed version of the concatenated elements.
+func newName(elements ...string) string {
+	if name := strings.Join(elements, "."); len(name) <= maxLen {
+		return name
 	}
-	if h.parentRefID != "" {
-		parts = append(parts, h.parentRefID)
-	}
-	if h.sectionID != "" {
-		parts = append(parts, h.sectionID)
-	}
-	fullName := strings.Join(parts, ".")
 
-	if len(fullName) <= maxLen {
-		return fullName
-	}
+	// If the name exceeds the max length, return a hashed version of the concatenated elements
+	return namegenPrefix + utils.Hash64(elements)
+}
 
-	// If the full name exceeds the max length, we fallback to a hashed version of each component
-	const DefaultHTTPRoutePrefix = "http"
-	const DefaultParentRefPrefix = "cp"
-	const DefaultSectPrefix = "res"
-	const maxCompLen = (maxLen - 2) / 3
+// NewKongUpstreamName generates a KongUpstream name based on the ControlPlaneRef and HTTPRouteRule passed as arguments.
+func NewKongUpstreamName(cp *commonv1alpha1.ControlPlaneRef, rule gatewayv1.HTTPRouteRule) string {
+	return newName(
+		defaultCPPrefix+utils.Hash32(cp),
+		utils.Hash32(rule.BackendRefs),
+	)
+}
 
-	httpRouteID := h.httpRouteID
-	parentRefID := h.parentRefID
-	sectionID := h.sectionID
+// NewKongServiceName generates a KongService name based on the ControlPlaneRef and HTTPRouteRule passed as arguments.
+func NewKongServiceName(cp *commonv1alpha1.ControlPlaneRef, rule gatewayv1.HTTPRouteRule) string {
+	return newName(
+		httpProcolPrefix,
+		defaultCPPrefix+utils.Hash32(cp),
+		utils.Hash32(rule.BackendRefs),
+	)
+}
 
-	if len(httpRouteID) > maxCompLen {
-		httpRouteID = DefaultHTTPRoutePrefix + utils.Hash32(httpRouteID)
-	}
-	if len(parentRefID) > maxCompLen {
-		parentRefID = DefaultParentRefPrefix + utils.Hash32(parentRefID)
-	}
-	if len(sectionID) > maxCompLen {
-		sectionID = DefaultSectPrefix + utils.Hash32(sectionID)
-	}
+// NewKongRouteName generates a KongRoute name based on the HTTPRoute, ControlPlaneRef, and HTTPRouteRule passed as arguments.
+func NewKongRouteName(route *gwtypes.HTTPRoute, cp *commonv1alpha1.ControlPlaneRef, rule gatewayv1.HTTPRouteRule) string {
+	return newName(
+		httpProcolPrefix,
+		route.Namespace+"-"+route.Name,
+		defaultCPPrefix+utils.Hash32(cp),
+		utils.Hash32(rule.Matches),
+	)
+}
 
-	parts = []string{httpRouteID, parentRefID}
-	if sectionID != "" {
-		parts = append(parts, sectionID)
-	}
-	fullName = strings.Join(parts, ".")
+// NewKongPluginName generates a KongPlugin name based on the HTTPRouteFilter passed as argument.
+func NewKongPluginName(filter gatewayv1.HTTPRouteFilter) string {
+	return newName("pl" + utils.Hash32(filter))
+}
 
-	return fullName
+// NewKongPluginBindingName generates a KongPlugin name based on the KongRoute and the KongPlugin names.
+func NewKongPluginBindingName(routeID, pluginId string) string {
+	return newName(routeID, pluginId)
 }
 
-// NewName creates a new Name instance with the given components.
-func NewName(httpRouteID, parentRefID, sectionID string) *Name {
-	return &Name{
-		httpRouteID: httpRouteID,
-		parentRefID: parentRefID,
-		sectionID:   sectionID,
+// NewKongTargetName generates a KongTarget name based on the KongUpstream name, the Service Endpoint ip,
+// the service port and the HTTPBackendRef.
+func NewKongTargetName(upstreamID, endpointID string, port int, br *gwtypes.HTTPBackendRef) string {
+	obj := struct {
+		endpointID string
+		port       int
+		backend    *gwtypes.HTTPBackendRef
+	}{
+		endpointID: endpointID,
+		port:       port,
+		backend:    br,
 	}
+	return newName(upstreamID, utils.Hash32(obj))
 }