Add comments to clarify proxy settings and ingress pathType requirements

Author: emmanuelmathot

helm-chart/eoapi/templates/services/deployment.yaml

@@ -64,8 +64,8 @@ spec:
         command:
           {{- toYaml (index $v "command") | nindent 10 }}
           {{- if (and ($.Values.ingress.className) (or (eq $.Values.ingress.className "nginx") (eq $.Values.ingress.className "traefik"))) }}
-          - "--proxy-headers"
-          - "--forwarded-allow-ips=*"
+          - "--proxy-headers" # Needed when using reverse proxy
+          - "--forwarded-allow-ips=*" # Needed when using reverse proxy
           - "--root-path=/{{ $serviceName }}"
           {{- end }}{{/* needed for proxies and path rewrites on NLB */}}
         livenessProbe:

helm-chart/eoapi/values.yaml

@@ -45,6 +45,8 @@ ingress:
   className: "nginx"
   # Path configuration
   pathType: "Prefix"  # Can be "Prefix" or "ImplementationSpecific" based on controller
+  # NOTE: When using nginx ingress controller with regex in pathSuffix,
+  # you must set pathType to "ImplementationSpecific". See issue #189 for more context.
   pathSuffix: ""      # Add a suffix to service paths (e.g. "(/|$)(.*)" for nginx regex)
   rootPath: ""        # Root path for doc server
   # Host configuration