feat(deployment)!: move dnsConfig to deployment.dnsConfig

`dnsConfig` was a top-level value although it exclusively configures the pod spec of the Gitea Deployment. With
`affinity` and `env` already moved into the `deployment` dict, keeping `dnsConfig` at the root level leaves the
Deployment configuration split across two places and makes it harder to see which values end up in the rendered
pod spec.

Moving it into the `deployment` dict continues the consolidation of Deployment-scoped values and keeps the
values structure predictable for the remaining pod-level settings.

A deprecation check is added so that existing installations fail fast with an actionable error message. Without
it, a custom DNS configuration would be dropped silently, which typically surfaces much later as unexplained
name resolution failures inside the Gitea pod.

BREAKING CHANGE: `dnsConfig` no longer exists. Use `deployment.dnsConfig` instead. Installations that still set
`dnsConfig` will fail unless `checkDeprecation` is set to `false`.

Co-authored-by: Copilot <copilot@github.com>

README.md

@@ -1128,13 +1128,13 @@ To comply with the Gitea helm chart definition of the digest parameter, a "custo
 | `nodeSelector`                             | NodeSelector for the deployment                                  | `{}`   |
 | `tolerations`                              | Tolerations for the deployment                                   | `[]`   |
 | `topologySpreadConstraints`                | TopologySpreadConstraints for the deployment                     | `[]`   |
-| `dnsConfig`                                | dnsConfig for the deployment                                     | `{}`   |
 | `priorityClassName`                        | priorityClassName for the deployment                             | `""`   |
 | `deployment.enabled`                       | Enable the deployment of Gitea.                                  | `true` |
 | `deployment.annotations`                   | Annotations for the Gitea deployment to be created               | `{}`   |
 | `deployment.labels`                        | Labels for the deployment                                        | `{}`   |
 | `deployment.affinity`                      | Affinity for the deployment.                                     | `{}`   |
 | `deployment.terminationGracePeriodSeconds` | How long to wait until forcefully kill the pod                   | `60`   |
+| `deployment.dnsConfig`                     | dnsConfig of the Gitea deployment.                               | `{}`   |
 | `deployment.gitea.env`                     | Additional environment variables to pass to the Gitea container. | `[]`   |
 
 ### Secret

templates/gitea/deployment.yaml

@@ -439,9 +439,9 @@ spec:
       tolerations:
         {{- toYaml . | nindent 8 }}
     {{- end }}
-    {{- if .Values.dnsConfig }}
+    {{- if .Values.deployment.dnsConfig }}
       dnsConfig:
-        {{- toYaml .Values.dnsConfig | nindent 8 }}
+        {{- toYaml .Values.deployment.dnsConfig | nindent 8 }}
     {{- end }}
       volumes:
         - name: init

templates/gitea/deprecation.yaml

@@ -49,4 +49,9 @@
   {{- if .Values.deployment.env -}}
     {{- fail "`deployment.env` does no longer exist. Please refer to the changelog and configure `deployment.gitea.env` instead." -}}
   {{- end -}}
+
+  {{/* DNS CONFIG */}}
+  {{- if .Values.dnsConfig -}}
+    {{- fail "`dnsConfig` does no longer exist. Please refer to the changelog and configure `deployment.dnsConfig` instead." -}}
+  {{- end -}}
 {{- end -}}

unittests/helm/deployment/basic.yaml

@@ -103,6 +103,29 @@ tests:
                         operator: In
                         values:
                           - linux
+  - it: dnsConfig is undefined
+    template: templates/gitea/deployment.yaml
+    asserts:
+      - notExists:
+          path: spec.template.spec.dnsConfig
+  - it: dnsConfig is defined
+    template: templates/gitea/deployment.yaml
+    set:
+      deployment.dnsConfig:
+        nameservers:
+          - 192.0.2.1
+        options:
+          - name: ndots
+            value: "2"
+    asserts:
+      - equal:
+          path: spec.template.spec.dnsConfig
+          value:
+            nameservers:
+              - 192.0.2.1
+            options:
+              - name: ndots
+                value: "2"
 
   - it: "injects TMP_EXISTING_ENVS_FILE as environment variable to 'init-app-ini' init container"
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/deprecations.yaml

@@ -31,6 +31,14 @@ tests:
     asserts:
       - failedTemplate:
           errorMessage: "`deployment.env` does no longer exist. Please refer to the changelog and configure `deployment.gitea.env` instead."
+  - it: fails when the removed `dnsConfig` value is set
+    set:
+      dnsConfig:
+        nameservers:
+          - 192.0.2.1
+    asserts:
+      - failedTemplate:
+          errorMessage: "`dnsConfig` does no longer exist. Please refer to the changelog and configure `deployment.dnsConfig` instead."
   - it: skips the deprecation checks when `checkDeprecation` is disabled
     set:
       checkDeprecation: false
@@ -39,6 +47,9 @@ tests:
       deployment.env:
         - name: VARIABLE
           value: my-value
+      dnsConfig:
+        nameservers:
+          - 192.0.2.1
     asserts:
       - hasDocuments:
           count: 0

values.yaml

@@ -322,9 +322,6 @@ tolerations: []
 ## @param topologySpreadConstraints TopologySpreadConstraints for the deployment
 topologySpreadConstraints: []
 
-## @param dnsConfig dnsConfig for the deployment
-dnsConfig: {}
-
 ## @param priorityClassName priorityClassName for the deployment
 priorityClassName: ""
 
@@ -357,6 +354,17 @@ deployment:
     #         values:
     #         - amd64
 
+  ## @param deployment.dnsConfig dnsConfig of the Gitea deployment.
+  dnsConfig: {}
+    # nameservers:
+    # - 192.0.2.1 # this is an example
+    # searches:
+    # - ns1.svc.cluster-domain.example
+    # - my.dns.search.suffix
+    # options:
+    # - name: ndots
+    #   value: "2"
+    # - name: edns0
 
   gitea:
     ## @param deployment.gitea.env Additional environment variables to pass to the gitea container.