Add custom error pages example file (#8060)

* Add custom error pages example file * Update docs/examples/customization/custom-errors/README.md Co-authored-by: Jintao Zhang <tao12345666333@163.com> Co-authored-by: Jintao Zhang <tao12345666333@163.com>
kubernetes · Jan 12, 2022 · a9495ec · a9495ec
1 parent d8c9a6c
commit a9495ec
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 0 deletions.
diff --git a/docs/examples/customization/custom-errors/README.md b/docs/examples/customization/custom-errors/README.md
@@ -2,6 +2,8 @@
 
 This example demonstrates how to use a custom backend to render custom error pages.
 
+If you are using Helm Chart, look at [example values](https://github.com/kubernetes/ingress-nginx/blob/main/docs/examples/customization/custom-errors/custom-default-backend.helm.values.yaml) and don't forget to add [configMap](https://github.com/kubernetes/ingress-nginx/blob/main/docs/examples/customization/custom-errors/custom-default-backend-error_pages.configMap.yaml) to your deployment, otherwise continue with [Customized default backend](#customized-default-backend) manual deployment.
+
 ## Customized default backend
 
 First, create the custom `default-backend`. It will be used by the Ingress controller later on.  

diff --git a/docs/examples/customization/custom-errors/custom-default-backend-error_pages.configMap.yaml b/docs/examples/customization/custom-errors/custom-default-backend-error_pages.configMap.yaml
@@ -0,0 +1,19 @@
+# Custom error page configMap
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: custom_error_pages
+data:
+  404: |
+    <!DOCTYPE html>
+    <html>
+      <head><title>PAGE NOT FOUND</title></head>
+      <body>PAGE NOT FOUND</body>
+    </html>
+  503: |
+    <!DOCTYPE html>
+    <html>
+      <head><title>CUSTOM SERVICE UNAVAILABLE</title></head>
+      <body>CUSTOM SERVICE UNAVAILABLE</body>
+    </html>
diff --git a/docs/examples/customization/custom-errors/custom-default-backend.helm.values.yaml b/docs/examples/customization/custom-errors/custom-default-backend.helm.values.yaml
@@ -0,0 +1,20 @@
+controller:
+  custom-http-errors: "404,503"
+defaultBackend:
+  enabled: true
+  image:
+    registry: k8s.gcr.io
+    image: ingress-nginx/nginx-errors
+    tag: "0.48.1"
+  extraVolumes:
+  - name: custom_error_pages
+    configMap:
+      name: custom_error_pages
+      items:
+      - key: "404"
+        path: "404.html"
+      - key: "503"
+        path: "503.html"
+  extraVolumeMounts:
+  - name: custom_error_pages
+    mountPath: /www
diff --git a/docs/examples/customization/custom-errors/custom-default-backend.yaml b/docs/examples/customization/custom-errors/custom-default-backend.yaml
@@ -44,3 +44,19 @@ spec:
         # env:
         # - name: DEBUG
         #   value: "true"
+
+        # Mounting custom error page from configMap
+        # volumeMounts:
+        # - name: custom_error_pages
+        #   mountPath: /www
+
+      # Mounting custom error page from configMap
+      # volumes:
+      # - name: custom_error_pages
+      #   configMap:
+      #     name: custom_error_pages
+      #     items:
+      #     - key: "404"
+      #       path: "404.html"
+      #     - key: "503"
+      #       path: "503.html"