hostPorts list

Author: Gasoid

apis/v1alpha2/nginxproxy_types.go

@@ -479,10 +479,10 @@ type ContainerSpec struct {
 	// +optional
 	Lifecycle *corev1.Lifecycle `json:"lifecycle,omitempty"`
 
-	// HostPort configuration
+	// HostPorts are the list of ports to expose on the host
 	//
 	// +optional
-	HostPort *HostPort `json:"hostPort,omitempty"`
+	HostPorts []HostPort `json:"hostPorts,omitempty"`
 
 	// VolumeMounts describe the mounting of Volumes within a container.
 	//
@@ -616,14 +616,13 @@ type NodePort struct {
 
 // HostPort to expose on the host.
 type HostPort struct {
-	// Whether to enable hostPort feature
-	// If not specified, or set to false, hostPort will not be enabled.
-	//
-	// +optional
-	Enable bool `json:"enable"`
+	// ContainerPort is nginx port.
+	// kubebuilder:validation:Minimum=1
+	// kubebuilder:validation:Maximum=65535
+	ContainerPort int32 `json:"containerPort"`
 
 	// Number of port to expose on the host.
 	// kubebuilder:validation:Minimum=1
 	// kubebuilder:validation:Maximum=65535
-	Port int32 `json:"port"`
+	HostPort int32 `json:"hostPort"`
 }

charts/nginx-gateway-fabric/README.md

@@ -264,12 +264,10 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
 | `certGenerator.ttlSecondsAfterFinished` | How long to wait after the cert generator job has finished before it is removed by the job controller. | int | `30` |
 | `clusterDomain` | The DNS cluster domain of your Kubernetes cluster. | string | `"cluster.local"` |
 | `gateways` | A list of Gateway objects. View https://gateway-api.sigs.k8s.io/reference/spec/#gateway for full Gateway reference. | list | `[]` |
-| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"config":{},"container":{"hostPort":{"enable":false,"port":443}},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","loadBalancerClass":"","loadBalancerIP":"","loadBalancerSourceRanges":[],"nodePorts":[],"type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
+| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"config":{},"container":{"hostPorts":[]},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","loadBalancerClass":"","loadBalancerIP":"","loadBalancerSourceRanges":[],"nodePorts":[],"type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
 | `nginx.config` | The configuration for the data plane that is contained in the NginxProxy resource. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{}` |
-| `nginx.container` | The container configuration for the NGINX container. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{"hostPort":{"enable":false,"port":443}}` |
-| `nginx.container.hostPort` | The hostPort configuration | object | `{"enable":false,"port":443}` |
-| `nginx.container.hostPort.enable` | Enables hostPort. | bool | `false` |
-| `nginx.container.hostPort.port` | The port | int | `443` |
+| `nginx.container` | The container configuration for the NGINX container. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{"hostPorts":[]}` |
+| `nginx.container.hostPorts` | The hostPort configuration | list | `[]` |
 | `nginx.debug` | Enable debugging for NGINX. Uses the nginx-debug binary. The NGINX error log level should be set to debug in the NginxProxy resource. | bool | `false` |
 | `nginx.image.repository` | The NGINX image to use. | string | `"ghcr.io/nginx/nginx-gateway-fabric/nginx"` |
 | `nginx.imagePullSecret` | The name of the secret containing docker registry credentials. Secret must exist in the same namespace as the helm release. The control plane will copy this secret into any namespace where NGINX is deployed. | string | `""` |

charts/nginx-gateway-fabric/values.schema.json

@@ -314,29 +314,29 @@
         "container": {
           "description": "The container configuration for the NGINX container. This is applied globally to all Gateways managed by this\ninstance of NGINX Gateway Fabric.",
           "properties": {
-            "hostPort": {
+            "hostPorts": {
               "description": "The hostPort configuration",
-              "properties": {
-                "enable": {
-                  "default": false,
-                  "description": "Enables hostPort.",
-                  "required": [],
-                  "title": "enable",
-                  "type": "boolean"
+              "items": {
+                "properties": {
+                  "containerPort": {
+                    "maximum": 65535,
+                    "minimum": 1,
+                    "required": [],
+                    "type": "integer"
+                  },
+                  "hostPort": {
+                    "maximum": 65535,
+                    "minimum": 1,
+                    "required": [],
+                    "type": "integer"
+                  }
                 },
-                "port": {
-                  "default": 443,
-                  "description": "The port",
-                  "maximum": 65535,
-                  "minimum": 1,
-                  "required": [],
-                  "title": "port",
-                  "type": "integer"
-                }
+                "required": [],
+                "type": "object"
               },
               "required": [],
-              "title": "hostPort",
-              "type": "object"
+              "title": "hostPorts",
+              "type": "array"
             }
           },
           "required": [],

charts/nginx-gateway-fabric/values.yaml

@@ -398,18 +398,26 @@ nginx:
   # instance of NGINX Gateway Fabric.
   container:
 
+    # @schema
+    # type: array
+    # items:
+    #   type: object
+    #   properties:
+    #     containerPort:
+    #       type: integer
+    #       required: true
+    #       minimum: 1
+    #       maximum: 65535
+    #     hostPort:
+    #       type: integer
+    #       required: true
+    #       minimum: 1
+    #       maximum: 65535
+    # @schema
     # -- The hostPort configuration
-    hostPort:
-      # -- Enables hostPort.
-      enable: false
-
-      # @schema
-      # type: integer
-      # minimum: 1
-      # maximum: 65535
-      # @schema
-      # -- The port
-      port: 443
+    hostPorts: []
+    # - containerPort: 80
+    #   hostPort: 80
 
     # -- The resource requirements of the NGINX container.
     # resources: {}

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

@@ -337,19 +337,22 @@ spec:
                                   StopSignal can only be set for Pods with a non-empty .spec.os.name
                                 type: string
                             type: object
-                          hostPort:
+                          hostPorts:
                             description: |-
-                              Number of port to expose on the host.
-                              If specified, this must be a valid port number, 0 < x < 65536.
-                            properties:
-                              enable:
+                              List of ports to expose on the host.
+                            items:
+                              containerPort:
                                 description: |-
-                                  Whether to enable hostPort
-                                type: boolean
-                              port:
+                                  ContainerPort number of nginx
+                                type: integer
+                              hostPort:
                                 description: |-
-                                  Port number
+                                  HostPort number to expose on the host
                                 type: integer
+                              required:
+                              - containerPort
+                              - hostPort
+                            type: array
                           resources:
                             description: Resources describes the compute resource
                               requirements.

deploy/crds.yaml

@@ -924,17 +924,20 @@ spec:
                             type: object
                           hostPort:
                             description: |-
-                              Number of port to expose on the host.
-                              If specified, this must be a valid port number, 0 < x < 65536.
-                            properties:
-                              enable:
+                              List of ports to expose on the host.
+                            items:
+                              containerPort:
                                 description: |-
-                                  Whether to enable hostPort
-                                type: boolean
-                              port:
+                                  ContainerPort number of nginx
+                                type: integer
+                              hostPort:
                                 description: |-
-                                  Port number
+                                  HostPort number to expose on the host
                                 type: integer
+                              required:
+                              - containerPort
+                              - hostPort
+                            type: array
                           resources:
                             description: Resources describes the compute resource
                               requirements.

internal/controller/provisioner/objects.go

@@ -781,8 +781,12 @@ func (p *NginxProvisioner) buildNginxPodTemplateSpec(
 				container.Args = append(container.Args, "debug")
 			}
 
-			if containerSpec.HostPort != nil && containerSpec.HostPort.Enable && len(container.Ports) > 0 {
-				container.Ports[0].HostPort = containerSpec.HostPort.Port
+			for _, hostPort := range containerSpec.HostPorts {
+				for i, port := range container.Ports {
+					if hostPort.ContainerPort == port.ContainerPort {
+						container.Ports[i].HostPort = hostPort.HostPort
+					}
+				}
 			}
 
 			spec.Spec.Containers[0] = container

internal/controller/provisioner/objects_test.go

@@ -293,7 +293,7 @@ func TestBuildNginxResourceObjects_NginxProxyConfig(t *testing.T) {
 							corev1.ResourceCPU: resource.Quantity{Format: "100m"},
 						},
 					},
-					HostPort: &ngfAPIv1alpha2.HostPort{Enable: true, Port: int32(8443)},
+					HostPorts: []ngfAPIv1alpha2.HostPort{{ContainerPort: int32(8443), HostPort: int32(8443)}},
 				},
 			},
 		},
@@ -339,7 +339,6 @@ func TestBuildNginxResourceObjects_NginxProxyConfig(t *testing.T) {
 	g.Expect(container.Ports).To(ContainElement(corev1.ContainerPort{
 		ContainerPort: 8080,
 		Name:          "metrics",
-		HostPort:      int32(8443),
 	}))
 
 	g.Expect(container.Image).To(Equal("nginx-repo:1.1.1"))