fix(docs): Fix NGINX YAML examples and Update recommended ingress to NGINX. (#34708)

**Description** Updates the recommended reverse proxy tool to NGINX. In addition, fixes the example YAML in the NGINX examples. I will add a task, but I could not get the examples to work with the ingressClassByName: true option. **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?** Used markdown preview in VS Code. **📃 Notes:** Wasn't sure if the customise misspelling was a locale thing. I can easily reverse it. **✔️ Checklist:** - [x] ⚖️ My code follows the style guidelines of this project - [x] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [x] 📄 I have made changes to the documentation - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png`
2025-04-24 00:05:18 -07:00
parent 047f53bd67
commit 22b633822d
2 changed files with 97 additions and 98 deletions
@@ -9,7 +9,7 @@ Simply put, they specify reverse proxy configuration for a special reverse proxy

 ## Requirements

-Before setting up ingress, we advise you to have an ingress controller already set-up. Our recommended ingress controller is [Traefik](https://github.com/traefik/traefik).
+Before setting up ingress, we advise you to have an ingress controller already set-up. Our recommended ingress controller is [Nginx](https://kubernetes.github.io/ingress-nginx/).

 ## How to Setup

@@ -4,7 +4,7 @@ title: NGINX

 ## Setup

-For NGINX we will setup 2 ingress controllers: Internal and External.
+For NGINX we will deploy two ingress controllers: Internal and External.
 Where External is either forwarded by your router or, for example, a cloudflare tunnel.
 Internal, however, is not routed anywhere and is used as a safe default to just have charts reached from your internal network only.

@@ -16,105 +16,103 @@ Please note the IP variables that need to be set to your specific configuration
 #### Internal

 ```yaml
-    controller:
-      replicaCount: 2
-      service:
-        externalTrafficPolicy: Local
-        annotations:
-          metallb.io/ip-allocated-from-pool: main
-          metallb.io/loadBalancerIPs: ${NGINX_INTERNAL_IP}
-      ingressClassByName: true
-      watchIngressWithoutClass: true
-      ingressClassResource:
-        name: internal
-        default: true
-        controllerValue: k8s.io/internal
-      config:
-        allow-snippet-annotations: true
-        annotations-risk-level: Critical
-        client-body-buffer-size: 100M
-        client-body-timeout: 120
-        client-header-timeout: 120
-        enable-brotli: "true"
-        enable-ocsp: "true"
-        enable-real-ip: "true"
-        force-ssl-redirect: "true"
-        hide-headers: Server,X-Powered-By
-        hsts-max-age: "31449600"
-        keep-alive-requests: 10000
-        keep-alive: 120
-        proxy-body-size: 0
-        proxy-buffer-size: 16k
-        ssl-protocols: TLSv1.3 TLSv1.2
-        use-forwarded-headers: "true"
-      metrics:
-        enabled: true
-      extraArgs:
-        default-ssl-certificate: "clusterissuer/certificate-issuer-general-wildcard"
-        publish-status-address: ${NGINX_INTERNAL_IP}
-      terminationGracePeriodSeconds: 120
-      publishService:
-        enabled: false
-      resources:
-        requests:
-          cpu: 100m
-        limits:
-          memory: 500Mi
-    defaultBackend:
-      enabled: false
+controller:
+  replicaCount: 2
+  service:
+    externalTrafficPolicy: Local
+    annotations:
+      metallb.io/ip-allocated-from-pool: main
+      metallb.io/loadBalancerIPs: ${NGINX_INTERNAL_IP}
+  ingressClassByName: true
+  watchIngressWithoutClass: true
+  ingressClassResource:
+    name: internal
+    default: true
+    controllerValue: k8s.io/internal
+  config:
+    allow-snippet-annotations: true
+    annotations-risk-level: Critical
+    client-body-buffer-size: 100M
+    client-body-timeout: 120
+    client-header-timeout: 120
+    enable-brotli: "true"
+    enable-ocsp: "true"
+    enable-real-ip: "true"
+    force-ssl-redirect: "true"
+    hide-headers: Server,X-Powered-By
+    hsts-max-age: "31449600"
+    keep-alive-requests: 10000
+    keep-alive: 120
+    proxy-body-size: 0
+    proxy-buffer-size: 16k
+    ssl-protocols: TLSv1.3 TLSv1.2
+    use-forwarded-headers: "true"
+  metrics:
+    enabled: true
+  extraArgs:
+    default-ssl-certificate: "clusterissuer/certificate-issuer-general-wildcard"
+    publish-status-address: ${NGINX_INTERNAL_IP}
+  terminationGracePeriodSeconds: 120
+  publishService:
+    enabled: false
+  resources:
+    requests:
+      cpu: 100m
+    limits:
+      memory: 500Mi
+defaultBackend:
+  enabled: false
 ```

 #### External

 ```yaml
-
-  values:
-    controller:
-      replicaCount: 2
-      service:
-        externalTrafficPolicy: Local
-        annotations:
-          metallb.io/ip-allocated-from-pool: main
-          metallb.io/loadBalancerIPs: ${NGINX_EXTERNAL_IP}
-      ingressClassByName: true
-      watchIngressWithoutClass: false
-      ingressClassResource:
-        name: external
-        default: false
-        controllerValue: k8s.io/external
-      config:
-        allow-snippet-annotations: true
-        annotations-risk-level: Critical
-        client-body-buffer-size: 100M
-        client-body-timeout: 120
-        client-header-timeout: 120
-        enable-brotli: "true"
-        enable-ocsp: "true"
-        enable-real-ip: "true"
-        force-ssl-redirect: "true"
-        hide-headers: Server,X-Powered-By
-        hsts-max-age: "31449600"
-        keep-alive-requests: 10000
-        keep-alive: 120
-        proxy-body-size: 0
-        proxy-buffer-size: 16k
-        ssl-protocols: TLSv1.3 TLSv1.2
-        use-forwarded-headers: "true"
-      metrics:
-        enabled: true
-      extraArgs:
-        default-ssl-certificate: "clusterissuer/certificate-issuer-general-wildcard"
-        publish-status-address: ${NGINX_EXTERNAL_IP}
-      terminationGracePeriodSeconds: 120
-      publishService:
-        enabled: false
-      resources:
-        requests:
-          cpu: 100m
-        limits:
-          memory: 500Mi
-    defaultBackend:
-      enabled: false
+controller:
+  replicaCount: 2
+  service:
+    externalTrafficPolicy: Local
+    annotations:
+      metallb.io/ip-allocated-from-pool: main
+      metallb.io/loadBalancerIPs: ${NGINX_EXTERNAL_IP}
+  ingressClassByName: true
+  watchIngressWithoutClass: false
+  ingressClassResource:
+    name: external
+    default: false
+    controllerValue: k8s.io/external
+  config:
+    allow-snippet-annotations: true
+    annotations-risk-level: Critical
+    client-body-buffer-size: 100M
+    client-body-timeout: 120
+    client-header-timeout: 120
+    enable-brotli: "true"
+    enable-ocsp: "true"
+    enable-real-ip: "true"
+    force-ssl-redirect: "true"
+    hide-headers: Server,X-Powered-By
+    hsts-max-age: "31449600"
+    keep-alive-requests: 10000
+    keep-alive: 120
+    proxy-body-size: 0
+    proxy-buffer-size: 16k
+    ssl-protocols: TLSv1.3 TLSv1.2
+    use-forwarded-headers: "true"
+  metrics:
+    enabled: true
+  extraArgs:
+    default-ssl-certificate: "clusterissuer/certificate-issuer-general-wildcard"
+    publish-status-address: ${NGINX_EXTERNAL_IP}
+  terminationGracePeriodSeconds: 120
+  publishService:
+    enabled: false
+  resources:
+    requests:
+      cpu: 100m
+    limits:
+      memory: 500Mi
+defaultBackend:
+  enabled: false
 ```

 ### Using the IngressClasses
@@ -126,7 +124,7 @@ or

 ## Annotations Examples

-Here we will showcase some annotations you can use to customise your NGINX ingress behavior
+Here we will showcase some annotations you can use to customize your NGINX ingress behavior

 ### Redirect to Https

@@ -159,7 +157,8 @@ annotations:
 ```

 For domain-level forward auth, you must configure the embedded outpost first (please refer to
-[Authentik's docs](https://truecharts.org/charts/stable/authentik/how_to/)). The basic steps are to create a provider and application, then enable the embedded outpost for your newly created application.
+[Authentik's docs](https://truecharts.org/charts/stable/authentik/how_to/)). The basic steps are
+to create a provider and application, then enable the embedded outpost for your newly created application.

 Once that has been done, configure each service you wish to place behind Authentik as follows: