From ec5fefe4ee049081bb0f76abf8898fe52c5926c0 Mon Sep 17 00:00:00 2001 From: Eric Ace <24485843+aceeric@users.noreply.github.com> Date: Sun, 27 Jul 2025 16:32:04 -0400 Subject: [PATCH] Exclude large object defaults from helm docs --- charts/external-dns/README.md | 6 +++--- charts/external-dns/values.yaml | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/charts/external-dns/README.md b/charts/external-dns/README.md index 300eac59e..a9c8bbaf8 100644 --- a/charts/external-dns/README.md +++ b/charts/external-dns/README.md @@ -130,11 +130,11 @@ If `namespaced` is set to `true`, please ensure that `sources` my only contains | podSecurityContext | object | See _values.yaml_ | [Pod security context](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core), this supports full customisation. | | policy | string | `"upsert-only"` | How DNS records are synchronized between sources and providers; available values are `create-only`, `sync`, & `upsert-only`. | | priorityClassName | string | `nil` | Priority class name for the `Pod`. | -| provider | object | `{"name":"aws","webhook":{"readTimeout":null,"sidecar":{"args":[],"env":[],"extraVolumeMounts":[],"image":{"pullPolicy":"IfNotPresent","repository":null,"tag":null},"livenessProbe":{"failureThreshold":2,"httpGet":{"path":"/healthz","port":"http-webhook"},"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5},"readinessProbe":{"failureThreshold":6,"httpGet":{"path":"/healthz","port":"http-webhook"},"initialDelaySeconds":5,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5},"resources":{},"securityContext":{},"service":{"port":8080},"serviceMonitor":{"bearerTokenFile":null,"interval":null,"metricRelabelings":[],"relabelings":[],"scheme":null,"scrapeTimeout":null,"tlsConfig":{}}},"url":null,"writeTimeout":null}}` | Provider configuration | +| provider | object | See _values.yaml_ | Provider configuration | | provider.name | string | `"aws"` | _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). | -| provider.webhook | object | `{"readTimeout":null,"sidecar":{"args":[],"env":[],"extraVolumeMounts":[],"image":{"pullPolicy":"IfNotPresent","repository":null,"tag":null},"livenessProbe":{"failureThreshold":2,"httpGet":{"path":"/healthz","port":"http-webhook"},"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5},"readinessProbe":{"failureThreshold":6,"httpGet":{"path":"/healthz","port":"http-webhook"},"initialDelaySeconds":5,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5},"resources":{},"securityContext":{},"service":{"port":8080},"serviceMonitor":{"bearerTokenFile":null,"interval":null,"metricRelabelings":[],"relabelings":[],"scheme":null,"scrapeTimeout":null,"tlsConfig":{}}},"url":null,"writeTimeout":null}` | Webhook configuration | +| provider.webhook | object | See _values.yaml_ | Webhook configuration | | provider.webhook.readTimeout | integer | `nil` | Webhook read timeout | -| provider.webhook.sidecar | object | `{"args":[],"env":[],"extraVolumeMounts":[],"image":{"pullPolicy":"IfNotPresent","repository":null,"tag":null},"livenessProbe":{"failureThreshold":2,"httpGet":{"path":"/healthz","port":"http-webhook"},"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5},"readinessProbe":{"failureThreshold":6,"httpGet":{"path":"/healthz","port":"http-webhook"},"initialDelaySeconds":5,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5},"resources":{},"securityContext":{},"service":{"port":8080},"serviceMonitor":{"bearerTokenFile":null,"interval":null,"metricRelabelings":[],"relabelings":[],"scheme":null,"scrapeTimeout":null,"tlsConfig":{}}}` | Webhook sidecar container configuration | +| provider.webhook.sidecar | object | See _values.yaml_ | Webhook sidecar container configuration | | provider.webhook.sidecar.args | list | `[]` | Extra arguments to provide for the `webhook` container. | | provider.webhook.sidecar.env | list | `[]` | [Environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the `webhook` container. | | provider.webhook.sidecar.extraVolumeMounts | list | `[]` | Extra [volume mounts](https://kubernetes.io/docs/concepts/storage/volumes/) for the `webhook` container. | diff --git a/charts/external-dns/values.yaml b/charts/external-dns/values.yaml index 5add96c9d..75bbb640b 100644 --- a/charts/external-dns/values.yaml +++ b/charts/external-dns/values.yaml @@ -241,10 +241,12 @@ labelFilter: # @schema type: [string,null]; default: null managedRecordTypes: [] # @schema type: [array, null]; item: string; uniqueItems: true # -- (object) Provider configuration +# @default -- See _values.yaml_ provider: # @schema type: [object, string] # -- _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 # @schema type:[string, null] # -- (object) Webhook configuration + # @default -- See _values.yaml_ webhook: # @schema type: [object, null] # -- (string) Webhook URL url: # @schema type:[string, null]; default: null @@ -253,6 +255,7 @@ provider: # @schema type: [object, string] # -- (integer) Webhook write timeout writeTimeout: # @schema type:[integer, null]; default: null # -- (object) Webhook sidecar container configuration + # @default -- See _values.yaml_ sidecar: # @schema type: [object, null]; default: null image: # -- (string) Image repository for the `webhook` container.