feat(Traefik): ✨ support Gateway API statusAddress

traefik · Oct 29, 2024 · 967f7cd · 967f7cd
1 parent 74abfee
commit 967f7cd
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 2 deletions.
diff --git a/traefik/VALUES.md b/traefik/VALUES.md
@@ -258,6 +258,9 @@ Kubernetes: `>=1.22.0-0`
 | providers.kubernetesGateway.experimentalChannel | bool | `false` | Toggles support for the Experimental Channel resources (Gateway API release channels documentation). This option currently enables support for TCPRoute and TLSRoute. |
 | providers.kubernetesGateway.labelselector | string | `""` | A label selector can be defined to filter on specific GatewayClass objects only. |
 | providers.kubernetesGateway.namespaces | list | `[]` | Array of namespaces to watch. If left empty, Traefik watches all namespaces. |
+| providers.kubernetesGateway.statusAddress.hostname | string | `""` | This Hostname will get copied to the Gateway status.addresses. |
+| providers.kubernetesGateway.statusAddress.ip | string | `""` | This IP will get copied to the Gateway status.addresses, and currently only supports one IP value (IPv4 or IPv6). |
+| providers.kubernetesGateway.statusAddress.service | object | `{"name":"{{ (include \"traefik.fullname\" .) }}","namespace":"{{ .Release.Namespace }}"}` | The Kubernetes service to copy status addresses from. When using third parties tools like External-DNS, this option can be used to copy the service loadbalancer.status (containing the service's endpoints IPs) to the gateways. Default to Service of this Chart. |
 | providers.kubernetesIngress.allowEmptyServices | bool | `true` | Allows to return 503 when there is no endpoints available |
 | providers.kubernetesIngress.allowExternalNameServices | bool | `false` | Allows to reference ExternalName services in Ingress |
 | providers.kubernetesIngress.enabled | bool | `true` | Load Kubernetes Ingress provider |

diff --git a/traefik/templates/_podtemplate.tpl b/traefik/templates/_podtemplate.tpl
@@ -514,6 +514,18 @@
           {{- with .Values.providers.kubernetesGateway }}
            {{- if .enabled }}
           - "--providers.kubernetesgateway"
+            {{- with .statusAddress }}
+             {{- with .ip }}
+          - "--providers.kubernetesgateway.statusaddress.ip={{ . }}"
+             {{- end }}
+             {{- with .hostname }}
+          - "--providers.kubernetesgateway.statusaddress.hostname={{ . }}"
+             {{- end }}
+             {{- with .service }}
+          - "--providers.kubernetesgateway.statusaddress.service.name={{ tpl .name $ }}"
+          - "--providers.kubernetesgateway.statusaddress.service.namespace={{ tpl .namespace $ }}"
+             {{- end }}
+            {{- end }}
             {{- if or .namespaces (and $.Values.rbac.enabled $.Values.rbac.namespaced) }}
           - "--providers.kubernetesgateway.namespaces={{ template "providers.kubernetesGateway.namespaces" $ }}"
             {{- end }}

diff --git a/traefik/tests/pod-config_test.yaml b/traefik/tests/pod-config_test.yaml
@@ -293,7 +293,7 @@ tests:
           content:
             key: "RSA"
             operator: "Destructor"
-  - it: should have all k8s provider enabled when gateway provider is enabled
+  - it: When gateway provider is enabled, k8s providers & default statusAddress should be set
     set:
       providers:
         kubernetesGateway:
@@ -308,6 +308,12 @@ tests:
       - contains:
           path: spec.template.spec.containers[0].args
           content: "--providers.kubernetesgateway"
+      - contains:
+          path: spec.template.spec.containers[0].args
+          content: "--providers.kubernetesgateway.statusaddress.service.name=RELEASE-NAME-traefik"
+      - contains:
+          path: spec.template.spec.containers[0].args
+          content: "--providers.kubernetesgateway.statusaddress.service.namespace=NAMESPACE"
   - it: should have experimental flag when set
     set:
       experimental:

diff --git a/traefik/tests/traefik-config_test.yaml b/traefik/tests/traefik-config_test.yaml
@@ -101,7 +101,30 @@ tests:
       - contains:
           path: spec.template.spec.containers[0].args
           content: "--providers.kubernetesingress.ingressendpoint.publishedservice=foo/bar"
-
+  - it: should be possible to set statusAddress fields
+    set:
+      providers:
+        kubernetesGateway:
+          enabled: true
+          statusAddress:
+            ip: 1.2.3.4
+            hostname: example.net
+            service:
+              name: foo
+              namespace: default
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].args
+          content: "--providers.kubernetesgateway.statusaddress.ip=1.2.3.4"
+      - contains:
+          path: spec.template.spec.containers[0].args
+          content: "--providers.kubernetesgateway.statusaddress.hostname=example.net"
+      - contains:
+          path: spec.template.spec.containers[0].args
+          content: "--providers.kubernetesgateway.statusaddress.service.name=foo"
+      - contains:
+          path: spec.template.spec.containers[0].args
+          content: "--providers.kubernetesgateway.statusaddress.service.namespace=default"
   - it: should allow cross namespace services when specified in configuration
     set:
       providers:

diff --git a/traefik/values.schema.json b/traefik/values.schema.json
@@ -1353,6 +1353,28 @@
                         },
                         "namespaces": {
                             "type": "array"
+                        },
+                        "statusAddress": {
+                            "properties": {
+                                "hostname": {
+                                    "type": "string"
+                                },
+                                "ip": {
+                                    "type": "string"
+                                },
+                                "service": {
+                                    "properties": {
+                                        "name": {
+                                            "type": "string"
+                                        },
+                                        "namespace": {
+                                            "type": "string"
+                                        }
+                                    },
+                                    "type": "object"
+                                }
+                            },
+                            "type": "object"
                         }
                     },
                     "type": "object"

diff --git a/traefik/values.yaml b/traefik/values.yaml
@@ -303,6 +303,15 @@ providers:  # @schema additionalProperties: false
     namespaces: []
     # -- A label selector can be defined to filter on specific GatewayClass objects only.
     labelselector: ""
+    statusAddress:
+      # -- This IP will get copied to the Gateway status.addresses, and currently only supports one IP value (IPv4 or IPv6).
+      ip: ""
+      # -- This Hostname will get copied to the Gateway status.addresses.
+      hostname: ""
+      # -- The Kubernetes service to copy status addresses from. When using third parties tools like External-DNS, this option can be used to copy the service loadbalancer.status (containing the service's endpoints IPs) to the gateways. Default to Service of this Chart.
+      service:
+        name: "{{ (include \"traefik.fullname\" .) }}"
+        namespace: "{{ .Release.Namespace }}"
 
   file:
     # -- Create a file provider