Merge branch 'docs-update-ingress-provider-examples' into 'master'

Update example values for Google and Amazon Ingress Controllers

See merge request !3263



Merged-by: Jason Plum <jplum@gitlab.com>
Approved-by: Tiger Watson <twatson@gitlab.com>
Approved-by: Jason Plum <jplum@gitlab.com>
Co-authored-by: Mitchell Nielsen <mnielsen@gitlab.com>

examples/aws/ingress.yaml

@@ -9,9 +9,15 @@ nginx-ingress:
 # Option 1: Use built-in AWS Load Balancer Controller IngressClass
 global:
   ingress:
-    class: none
-    annotations:
-      kubernetes.io/ingress.class: alb
+    # Configure `spec.ingressClassName` on Ingress objects.
+    # Supported as of AWS Load Balancer Controller v2.4:
+    #  https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.4/guide/ingress/spec
+    class: alb
+    # Alternatively, the annotation can be used. Note that use of the
+    # annotation is deprecated in favor of `spec.ingressClassName`.
+    # https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/ingress/ingress_class/#deprecated-kubernetesioingressclass-annotation
+    # annotations:
+    #   kubernetes.io/ingress.class: alb
 
 # Option 2: Create a custom IngressClass
 #   1. Create an IngressClass with a given name

examples/gke/ingress.yaml

+# Because the NGINX Ingress Controller is enabled by default, we follow the configuration
+# for a custom ingress controller in GKE:
 # https://cloud.google.com/kubernetes-engine/docs/how-to/custom-ingress-controller#ingress_class
-# If needed, annotations can be provided via `global.ingress.annotations`.
+# This involves setting `spec.ingressClassName` in each Ingress object, and omitting the annotation.
+#
+# If you wish instead to disable NGINX and use GKE's Ingress Controller, follow the
+# documentation and recommended values below.
+# - https://cloud.google.com/kubernetes-engine/docs/concepts/ingress#controller_summary
+# - https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress#create-ingress
 nginx-ingress:
   enabled: false
 global:
   ingress:
-    class: none # or ""
+    # Disable `spec.ingressClassName` field, since GKE's Ingress Controller ignores it.
+    class: none
+    # When `spec.ingressClassName` is not configured, as in this example, the annotation can either be configured
+    # explicitly or not configured at all; either way, GKE's Ingress Controller will manage the Ingress.
+    annotations:
+      kubernetes.io/ingress.class: gce # or gce-internal