Merge branch 'main' into feature/nginxingress-implement-header-manipulation

Author: eladmotola

.golangci.yml

@@ -44,5 +44,10 @@ issues:
         - gocyclo
         - errcheck
         - dupl
+    # Allow underscores in emitter package names
+    - path: pkg/i2gw/emitters/
+      linters:
+        - revive
+      text: "var-naming: don't use an underscore in package name"
   exclude:
     - Using the variable on range scope `tc` in function literal

PROVIDER.md

@@ -42,6 +42,10 @@ import (
 
 	// Call init for notifications
 	_ "github.com/kubernetes-sigs/ingress2gateway/pkg/i2gw/notifications"
+
+	// Call init for emitters
+	_ "github.com/kubernetes-sigs/ingress2gateway/pkg/i2gw/emitters/gce"
+	_ "github.com/kubernetes-sigs/ingress2gateway/pkg/i2gw/emitters/standard"
 )
 
 type PrintRunner struct {
@@ -72,6 +76,10 @@ type PrintRunner struct {
 
 	// Provider specific flags --<provider>-<flag>.
 	providerSpecificFlags map[string]*string
+
+	// emitter indicates which emitter is used to generate the Gateway API resources.
+	// Defaults to "standard".
+	emitter string
 }
 
 // PrintGatewayAPIObjects performs necessary steps to digest and print
@@ -88,7 +96,7 @@ func (pr *PrintRunner) PrintGatewayAPIObjects(cmd *cobra.Command, _ []string) er
 		return fmt.Errorf("failed to initialize namespace filter: %w", err)
 	}
 
-	gatewayResources, notificationTablesMap, err := i2gw.ToGatewayAPIResources(cmd.Context(), pr.namespaceFilter, pr.inputFile, pr.providers, pr.getProviderSpecificFlags())
+	gatewayResources, notificationTablesMap, err := i2gw.ToGatewayAPIResources(cmd.Context(), pr.namespaceFilter, pr.inputFile, pr.providers, pr.emitter, pr.getProviderSpecificFlags())
 	if err != nil {
 		return err
 	}
@@ -314,11 +322,23 @@ func newPrintCommand() *cobra.Command {
 		Use:   "print",
 		Short: "Prints Gateway API objects generated from ingress and provider-specific resources.",
 		RunE:  pr.PrintGatewayAPIObjects,
-		PreRunE: func(_ *cobra.Command, _ []string) error {
+		PreRunE: func(cmd *cobra.Command, _ []string) error {
 			openAPIExist := slices.Contains(pr.providers, "openapi3")
 			if openAPIExist && len(pr.providers) != 1 {
 				return fmt.Errorf("openapi3 must be the only provider when specified")
 			}
+
+			// Auto-set emitter for GCE provider
+			gceProviderUsed := slices.Contains(pr.providers, "gce")
+			emitterFlagChanged := cmd.Flags().Changed("emitter")
+
+			if gceProviderUsed {
+				if emitterFlagChanged && pr.emitter != "gce" {
+					return fmt.Errorf("when using the gce provider, the emitter must be 'gce' (got '%s')", pr.emitter)
+				}
+				pr.emitter = "gce"
+			}
+
 			return nil
 		},
 	}
@@ -336,6 +356,9 @@ func newPrintCommand() *cobra.Command {
 		`If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even
 if specified with --namespace.`)
 
+	cmd.Flags().StringVar(&pr.emitter, "emitter", "standard",
+		fmt.Sprintf("If present, the tool will try to use the specified emitter to generate the Gateway API resources, supported values are %v. The `standard` emitter will only output Gateway API", i2gw.GetSupportedEmitters()))
+
 	cmd.Flags().StringSliceVar(&pr.providers, "providers", []string{},
 		fmt.Sprintf("If present, the tool will try to convert only resources related to the specified providers, supported values are %v.", i2gw.GetSupportedProviders()))
 

cmd/print.go

@@ -0,0 +1,64 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package i2gw
+
+import (
+	emitterir "github.com/kubernetes-sigs/ingress2gateway/pkg/i2gw/emitter_intermediate"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/validation/field"
+	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
+	gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
+	gatewayv1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
+)
+
+type Emitter interface {
+	// Emit converts stored IR with the Provider into
+	// Gateway API resources and extensions
+	Emit(emitterir.EmitterIR) (GatewayResources, field.ErrorList)
+}
+
+// GatewayResources contains all Gateway-API objects and provider Gateway
+// extensions.
+type GatewayResources struct {
+	Gateways       map[types.NamespacedName]gatewayv1.Gateway
+	GatewayClasses map[types.NamespacedName]gatewayv1.GatewayClass
+
+	HTTPRoutes map[types.NamespacedName]gatewayv1.HTTPRoute
+	GRPCRoutes map[types.NamespacedName]gatewayv1.GRPCRoute
+	TLSRoutes  map[types.NamespacedName]gatewayv1alpha2.TLSRoute
+	TCPRoutes  map[types.NamespacedName]gatewayv1alpha2.TCPRoute
+	UDPRoutes  map[types.NamespacedName]gatewayv1alpha2.UDPRoute
+
+	BackendTLSPolicies map[types.NamespacedName]gatewayv1.BackendTLSPolicy
+	ReferenceGrants    map[types.NamespacedName]gatewayv1beta1.ReferenceGrant
+
+	GatewayExtensions []unstructured.Unstructured
+}
+
+// EmitterConstructorByName is a map of EmitterConstructor functions by a
+// emitter name. Different Emitter implementations should add their construction
+// func at startup.
+var EmitterConstructorByName = map[EmitterName]EmitterConstructor{}
+
+type EmitterName string
+
+type EmitterConstructor func(conf *EmitterConf) Emitter
+
+type EmitterConf struct {
+	// TODO: add fields as needed.
+}

pkg/i2gw/emitter.go

@@ -14,17 +14,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package intermediate
+package gce
 
-type GceGatewayIR struct {
+type GatewayIR struct {
 	EnableHTTPSRedirect bool
 	SslPolicy           *SslPolicyConfig
 }
 type SslPolicyConfig struct {
 	Name string
 }
-type GceHTTPRouteIR struct{}
-type GceServiceIR struct {
+type HTTPRouteIR struct{}
+type ServiceIR struct {
 	SessionAffinity *SessionAffinityConfig
 	SecurityPolicy  *SecurityPolicyConfig
 	HealthCheck     *HealthCheckConfig
@@ -45,18 +45,3 @@ type HealthCheckConfig struct {
 	Port               *int64
 	RequestPath        *string
 }
-
-func mergeGceGatewayIR(current, existing *GceGatewayIR) *GceGatewayIR {
-	// If either GceGatewayIR is nil, return the other one as the merged result.
-	if current == nil {
-		return existing
-	}
-	if existing == nil {
-		return current
-	}
-
-	// If both GceGatewayIRs are not nil, merge their fields.
-	var mergedGatewayIR GceGatewayIR
-	mergedGatewayIR.EnableHTTPSRedirect = current.EnableHTTPSRedirect || existing.EnableHTTPSRedirect
-	return &mergedGatewayIR
-}