add helm docs

kubernetes-sigs · Sep 5, 2024 · dd6e45a · dd6e45a
1 parent 1c7ec86
commit dd6e45a
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/charts/external-dns/CHANGELOG.md b/charts/external-dns/CHANGELOG.md
@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed `provider.webhook.resources` behavior to correctly leverage resource limits ([#4560](https://github.com/kubernetes-sigs/external-dns/pull/4560))
 - Fixed `provider.webhook.imagePullPolicy` behavior to correctly leverage pull policy ([#4643](https://github.com/kubernetes-sigs/external-dns/pull/4643)) _@kimsondrup_
 - Add correct webhook metric port to `Service` and `ServiceMonitor` ([#4643](https://github.com/kubernetes-sigs/external-dns/pull/4643)) _@kimsondrup_
+- Added support for `ignore-nodeports` argument @jpiper
 
 ## [v1.14.5] - 2023-06-10
 

diff --git a/charts/external-dns/README.md b/charts/external-dns/README.md
@@ -58,6 +58,8 @@ For set up for a specific provider using the Helm chart, see the following links
 external-dns supports running on a namespaced only scope, too.
 If `namespaced=true` is defined, the helm chart will setup `Roles` and `RoleBindings` instead `ClusterRoles` and `ClusterRoleBindings`.
 
+Note that you might also need to set `ignoreNodePorts=true` if you do not have access to the `Node` resource in the cluster and you are using the `Pod` or `Service` source.
+
 ### Limited Supported
 
 Not all sources are supported in namespaced scope, since some sources depends on cluster-wide resources.
@@ -82,9 +84,9 @@ If `namespaced` is set to `true`, please ensure that `sources` my only contains
 | `skipper-routegroup`   | ✅         |                        |
 | `gloo-proxy`           | ✅         |                        |
 | `contour-httpproxy`    | ✅         |                        |
+| `pod`                  | ✅         |                        |
 | `service`              | ⚠️️         | NodePort not supported |
 | `node`                 | ❌         |                        |
-| `pod`                  | ❌         |                        |
 
 ## Values
 
@@ -105,6 +107,7 @@ If `namespaced` is set to `true`, please ensure that `sources` my only contains
 | extraVolumeMounts | list | `[]` | Extra [volume mounts](https://kubernetes.io/docs/concepts/storage/volumes/) for the `external-dns` container. |
 | extraVolumes | list | `[]` | Extra [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) for the `Pod`. |
 | fullnameOverride | string | `nil` | Override the full name of the chart. |
+| ignoreNodePorts | bool | `false` |  |
 | image.pullPolicy | string | `"IfNotPresent"` | Image pull policy for the `external-dns` container. |
 | image.repository | string | `"registry.k8s.io/external-dns/external-dns"` | Image repository for the `external-dns` container. |
 | image.tag | string | `nil` | Image tag for the `external-dns` container, this will default to `.Chart.AppVersion` if not set. |

diff --git a/charts/external-dns/README.md.gotmpl b/charts/external-dns/README.md.gotmpl
@@ -53,6 +53,8 @@ For set up for a specific provider using the Helm chart, see the following links
 external-dns supports running on a namespaced only scope, too.
 If `namespaced=true` is defined, the helm chart will setup `Roles` and `RoleBindings` instead `ClusterRoles` and `ClusterRoleBindings`.
 
+Note that you might also need to set `ignoreNodePorts=true` if you do not have access to the `Node` resource in the cluster and you are using the `Pod` or `Service` source.
+
 ### Limited Supported
 
 Not all sources are supported in namespaced scope, since some sources depends on cluster-wide resources.
@@ -77,9 +79,9 @@ If `namespaced` is set to `true`, please ensure that `sources` my only contains
 | `skipper-routegroup`   | ✅         |                        |
 | `gloo-proxy`           | ✅         |                        |
 | `contour-httpproxy`    | ✅         |                        |
+| `pod`                  | ✅         |                        |
 | `service`              | ⚠️️         | NodePort not supported |
 | `node`                 | ❌         |                        |
-| `pod`                  | ❌         |                        |
 
 
 {{ template "chart.requirementsSection" . }}

diff --git a/charts/external-dns/templates/deployment.yaml b/charts/external-dns/templates/deployment.yaml
@@ -108,6 +108,9 @@ spec:
             {{- if .Values.namespaced }}
             - --namespace={{ .Release.Namespace }}
             {{- end }}
+            {{- if .Values.ignoreNodePorts }}
+            - --ignore-nodeports=true
+            {{- end }}
             {{- range .Values.domainFilters }}
             - --domain-filter={{ . }}
             {{- end }}

diff --git a/charts/external-dns/values.yaml b/charts/external-dns/values.yaml
@@ -225,6 +225,9 @@ domainFilters: []
 ## -- Intentionally exclude domains from being managed.
 excludeDomains: []
 
+## -- Disable nodePort support (for environments where access to Node resources is forbidden)
+ignoreNodePorts: false
+
 provider:
   # -- _ExternalDNS_ provider name; for the available providers and how to configure them see [README](https://github.com/kubernetes-sigs/external-dns/blob/master/charts/external-dns/README.md#providers).
   name: aws