[Bug]: ipFamilies list may not be rendered correctly in Service template

[bj0rn]

Version

edge

What Kubernetes platforms are you running on?

Kind

Steps to reproduce

ipFamilies is defined as a list in the values file, but it appears that the Helm chart currently only supports rendering a single value. It is defined here https://github.com/nginx/kubernetes-ingress/blob/main/charts/nginx-ingress/values.yaml#L502 and used here https://github.com/nginx/kubernetes-ingress/blob/main/charts/nginx-ingress/templates/controller-service.yaml#L42C3-L42C58.

In the Service template, ipFamilies seems to be rendered as a scalar rather than a list, which may prevent proper support for multiple IP families.

I would have expected ipFamilies to be rendered as a list, for example:

ipFamilies:
{{- range $ipFamily := .Values.controller.service.ipFamilies }}
  - {{ $ipFamily }}
{{- end }}

[github-actions]

Hi @bj0rn thanks for reporting!

Be sure to check out the docs and the Contributing Guidelines while you wait for a human to take a look at this 🙂

Cheers!

[javorszky]

Hi @bj0rn!

I tried to reproduce this issue, but couldn't. Or rather my testing resulted in the expected output. I think I figured out what the issue is. Here's what I did on current main (26e208b):

1. adjusted the values.yaml file to have the following ipFamilies entry:

   ...
   
    ## List of IP families assigned to this service.
    ## Valid values: IPv4, IPv6
    ipFamilies:
      - IPv6
      - IPv4
   
    httpPort:
    ...

2. in the charts directory I ran the following helm command (I'm using version 4.0.2):

   $ helm template nginx-ingress --values nginx-ingress/values.yaml --show-only templates/controller-service.yaml
   ```shell
   
   This renders only the `controller-service.yaml` template using values from the `values.yaml` file
   

3. I got the following output:

   level=INFO msg="found symbolic link in path. Contents of linked file included and used" path=/Users/g.javorszky/Projects/NIC/kubernetes-ingress/charts/nginx-ingress/crds resolved=/Users/g.javorszky/Projects/NIC/kubernetes-ingress/config/crd/bases
   ---
   # Source: nginx-ingress/templates/controller-service.yaml
   apiVersion: v1
   kind: Service
   metadata:
     name: release-name-nginx-ingress-controller
     namespace: default
     labels:
       helm.sh/chart: nginx-ingress-2.5.0 # this version is due to main already preparing for next minor release
       app.kubernetes.io/name: nginx-ingress
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/version: "5.4.0" # this version is due to main already preparing for next minor release
       app.kubernetes.io/managed-by: Helm
   spec:
     externalTrafficPolicy: Local
     type: LoadBalancer
     ipFamilies: [IPv6 IPv4] # <- this would be the expected array value if it had a , (comma) between them, but it does not...
     ports:
     - port: 80
       targetPort: 80
       protocol: TCP
       name: http
       nodePort:
     - port: 443
       targetPort: 443
       protocol: TCP
       name: https
       nodePort:
     selector:
       app.kubernetes.io/name: nginx-ingress
       app.kubernetes.io/instance: release-name

Can you double check whether you get the same output?

We'll add this to our backlog as well soon.

UPDATE: confirmed using yq, the value of the ipFamilies is a single string that is IPv4 IPv6...

[vepatel]

@bj0rn fix is available in 5.3.1 👍🏼