feat: support specify node port for gateway service by nic-6443 · Pull Request #256 · api7/api7-helm-chart

nic-6443 · 2026-02-12T03:05:54Z

No description provided.

Signed-off-by: Nic <qianyong@api7.ai>

Copilot

Pull request overview

This PR adds Helm chart support for explicitly setting Kubernetes nodePort values on the Gateway Service ports (HTTP/TLS, additional ports, and stream TCP map entries), and bumps the chart version accordingly.

Changes:

Add gateway.http.nodePort / gateway.tls.nodePort values (plus examples) to values.yaml.
Render nodePort on the Gateway Service for HTTP/TLS ports and additional container ports when gateway.type=NodePort.
Update chart docs and bump chart version to 0.2.52.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

File	Description
charts/gateway/values.yaml	Introduces `nodePort` values and examples for gateway HTTP/TLS and stream TCP.
charts/gateway/templates/service-gateway.yaml	Adds conditional `nodePort` fields to rendered Service ports.
charts/gateway/README.md	Documents the new `nodePort` settings.
charts/gateway/Chart.yaml	Bumps chart version.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T03:10:00Z

charts/gateway/templates/service-gateway.yaml

  {{- range .Values.gateway.http.additionalContainerPorts }}
  - name: apisix-gateway-{{ .port | toString }}
    port: {{ .port }}
    targetPort: {{ .port }}
+    {{- if (and (eq .Values.gateway.type "NodePort") (not (empty .nodePort))) }}
+    nodePort: {{ .nodePort }}
+    {{- end }}


Inside the range .Values.gateway.http.additionalContainerPorts, . becomes the per-port map, so .Values.gateway.type is out of scope and will cause template rendering errors when additionalContainerPorts is non-empty. Use the root context instead (e.g. $.Values.gateway.type or the already-defined $global.Values.gateway.type).

Copilot · 2026-02-12T03:10:00Z

charts/gateway/values.yaml

    ip: 0.0.0.0
    servicePort: 80
    containerPort: 9080
+    # -- The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes.


The comment says this is used when service.type is NodePort, but this chart’s Service type is configured via gateway.type (as used in the templates). Consider updating the wording to avoid confusion for chart users.

Suggested change

# -- The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes.

# -- The nodePort of kubernetes service, only used if gateway.type is NodePort. If not set, a random port will be assigned by Kubernetes.

Copilot · 2026-02-12T03:10:00Z

charts/gateway/values.yaml

+    # -- The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes.
+    nodePort:


The comment says this is used when service.type is NodePort, but the chart uses gateway.type to control the Service type. Adjust the wording so users know which value actually gates nodePort usage.

Copilot · 2026-02-12T03:10:00Z

charts/gateway/values.yaml

      # - ip: 127.0.0.3           # Specific IP, If not set, the default value is `0.0.0.0`.
      #   port: 9445
      #   hostPort: 9445
+      #   nodePort: 9445


The example nodePort: 9445 is outside Kubernetes’ default NodePort range (30000-32767). Consider using a value in the default range (or documenting that clusters may customize the range) to avoid misleading examples.

Suggested change

# nodePort: 9445

# nodePort: 30445

Copilot · 2026-02-12T03:10:01Z

charts/gateway/values.yaml

+      # - addr: 3302
+      #   nodePort: 3302


The stream example nodePort: 3302 is outside Kubernetes’ default NodePort range (30000-32767). Consider updating the example (or clarifying the NodePort range requirement) so it reflects typical Kubernetes defaults.

Suggested change

# - addr: 3302

# nodePort: 3302

# - addr: 30302

# nodePort: 30302

Copilot · 2026-02-12T03:10:01Z

charts/gateway/templates/service-gateway.yaml

  {{- range .Values.gateway.tls.additionalContainerPorts }}
  - name: apisix-gateway-tls-{{ .port | toString }}
    port: {{ .port }}
    targetPort: {{ .port }}
+    {{- if (and (eq .Values.gateway.type "NodePort") (not (empty .nodePort))) }}
+    nodePort: {{ .nodePort }}
+    {{- end }}


Inside the range .Values.gateway.tls.additionalContainerPorts, . is the per-port map, so .Values.gateway.type is not available and will break rendering when additionalContainerPorts is set. Reference the root context (e.g. $.Values.gateway.type / $global.Values.gateway.type) in this condition.

Copilot · 2026-02-12T03:10:01Z

charts/gateway/values.yaml

      # - port: 9081
      #   hostPort: 9081
+      #   nodePort: 9081


The example nodePort: 9081 is outside Kubernetes’ default NodePort range (30000-32767). Unless you specifically want to document custom cluster ranges, consider using an example within the default range (or mention the required range) to prevent copy/paste failures.

Copilot · 2026-02-12T03:10:01Z

charts/gateway/README.md

+| gateway.http | object | `{"additionalContainerPorts":[],"containerPort":9080,"enabled":true,"ip":"0.0.0.0","nodePort":null,"servicePort":80}` | API7 Gateway service settings for http |
 | gateway.http.additionalContainerPorts | list | `[]` | Support multiple http ports, See [Configuration](https://github.com/apache/apisix/blob/0bc65ea9acd726f79f80ae0abd8f50b7eb172e3d/conf/config-default.yaml#L24) |
 | gateway.http.ip | string | `"0.0.0.0"` | which ip to listen on for API7 Gateway http service. |
+| gateway.http.nodePort | string | `nil` | The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes. |


gateway.http.nodePort is documented as a string, but Kubernetes ServicePort.nodePort is an integer. Consider changing the documented type to int (and keep the description aligned with gateway.type, not service.type) to reduce configuration mistakes.

Copilot · 2026-02-12T03:10:02Z

charts/gateway/README.md

 | gateway.tls.existingCASecret | string | `""` | Specifies the name of Secret contains trusted CA certificates in the PEM format used to verify the certificate when APISIX needs to do SSL/TLS handshaking with external services (e.g. etcd) |
 | gateway.tls.fallbackSNI | string | `""` | If set this, when the client doesn't send SNI during handshake, the fallback SNI will be used instead |
 | gateway.tls.ip | string | `"0.0.0.0"` | which ip to listen on for API7 Gateway https service. |
+| gateway.tls.nodePort | string | `nil` | The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes. |


gateway.tls.nodePort is documented as a string, but Kubernetes ServicePort.nodePort is an integer. Consider documenting this as int and referencing gateway.type (the chart value that controls the Service type) instead of service.type.

Suggested change

| gateway.tls.nodePort | string | `nil` | The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes. |

| gateway.tls.nodePort | int | `nil` | The nodePort of kubernetes service, only used if gateway.type is NodePort. If not set, a random port will be assigned by Kubernetes. |

Signed-off-by: Nic <qianyong@api7.ai>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T03:32:14Z

charts/gateway/values.yaml

    # -- Support multiple http ports, See [Configuration](https://github.com/apache/apisix/blob/0bc65ea9acd726f79f80ae0abd8f50b7eb172e3d/conf/config-default.yaml#L24)
    additionalContainerPorts: []
      # - port: 9081
      #   hostPort: 9081
+      #   nodePort: 9081


gateway.*.additionalContainerPorts is rendered directly into the APISIX config.yaml via toYaml (see templates/configmap.yaml), so adding nodePort to those items will also appear under apisix.node_listen / ssl.listen. Since nodePort is a Kubernetes Service-only concept, consider filtering it out when rendering the ConfigMap (e.g., render only known APISIX listen keys or omit the service-only keys) or introduce a separate values list dedicated to Service ports.

Copilot · 2026-02-12T03:32:14Z

charts/gateway/values.yaml

      # - port: 9081
      #   hostPort: 9081
+      #   nodePort: 9081
      #   enable_http2: true          # If not set, the default value is `false`.


The commented examples set nodePort to values like 9081/9445, but Kubernetes NodePort defaults to the 30000–32767 range unless the cluster is reconfigured. Consider updating the examples (or note the valid range requirement) to avoid chart installs failing on default clusters.

Copilot · 2026-02-12T03:32:14Z

charts/gateway/values.yaml

+      #   nodePort: 3302
    udp: []
+      # - addr: 192.168.31.10:53
+      # - addr: 5353
+      #   nodePort: 5353


The stream nodePort examples use 3302/5353, which are outside Kubernetes’ default NodePort range (30000–32767). Unless this chart assumes a custom cluster NodePort range, these example values should be updated (or explicitly documented) to prevent invalid Service manifests by default.

Suggested change

# nodePort: 3302

udp: []

# - addr: 192.168.31.10:53

# - addr: 5353

# nodePort: 5353

# nodePort: 30302

udp: []

# - addr: 192.168.31.10:53

# - addr: 5353

# nodePort: 30553

Copilot · 2026-02-12T03:32:14Z

charts/gateway/templates/configmap.yaml

        {{- if gt (len .Values.gateway.stream.udp) 0 }}
        udp:                        # UDP proxy port list
          {{- if gt (len .Values.gateway.stream.udp) 0}}
          {{- range .Values.gateway.stream.udp }}
+          {{- if kindIs "map" . }}


The gateway.stream.udp rendering now supports map entries, but the nested if gt (len ...udp) 0 inside the outer if gt (len ...udp) 0 is redundant, and the inner else default (- 9200) is unreachable. Consider simplifying the conditionals or adjusting them so the documented default is actually rendered when the list is empty.

Signed-off-by: Nic <qianyong@api7.ai>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

feat: support specify node port for gateway service

c51ef0f

Signed-off-by: Nic <qianyong@api7.ai>

Copilot AI review requested due to automatic review settings February 12, 2026 03:05

Copilot started reviewing on behalf of nic-6443 February 12, 2026 03:06 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

udp

cbee2b8

Signed-off-by: Nic <qianyong@api7.ai>

ronething approved these changes Feb 12, 2026

View reviewed changes

nic-6443 added 2 commits February 12, 2026 11:19

f

35e1591

Signed-off-by: Nic <qianyong@api7.ai>

f

9713a1a

Signed-off-by: Nic <qianyong@api7.ai>

nic-6443 requested a review from Copilot February 12, 2026 03:26

Copilot started reviewing on behalf of nic-6443 February 12, 2026 03:26 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

f

ecf1a39

Signed-off-by: Nic <qianyong@api7.ai>

nic-6443 requested a review from Copilot February 12, 2026 03:48

Copilot started reviewing on behalf of nic-6443 February 12, 2026 03:49 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

nic-6443 merged commit 5efa735 into main Feb 12, 2026
8 checks passed

nic-6443 deleted the nic/node-port branch February 12, 2026 03:55

	# -- The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes.
	# -- The nodePort of kubernetes service, only used if gateway.type is NodePort. If not set, a random port will be assigned by Kubernetes.

		# -- The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes.
		nodePort:

	\| gateway.tls.nodePort \| string \| `nil` \| The nodePort of kubernetes service, only used if service.type is NodePort. If not set, a random port will be assigned by Kubernetes. \|
	\| gateway.tls.nodePort \| int \| `nil` \| The nodePort of kubernetes service, only used if gateway.type is NodePort. If not set, a random port will be assigned by Kubernetes. \|

Conversation

nic-6443 commented Feb 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants