From a3f2be6b904c88e9a174e82f3a9308df86318956 Mon Sep 17 00:00:00 2001 From: Mason Staugler Date: Fri, 26 Jun 2020 12:01:55 -0400 Subject: [PATCH] Fixup docs for the ingress-class flag. According to this issue, there is no way to handle all ingress classes. https://github.com/kubernetes/ingress-nginx/issues/3101 --- cmd/nginx/flags.go | 2 +- docs/user-guide/cli-arguments.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/nginx/flags.go b/cmd/nginx/flags.go index a43b1dd6b..88d5b9397 100644 --- a/cmd/nginx/flags.go +++ b/cmd/nginx/flags.go @@ -60,7 +60,7 @@ requests to the first port of this Service.`) ingressClass = flags.String("ingress-class", "", `Name of the ingress class this controller satisfies. The class of an Ingress object is set using the field IngressClassName in Kubernetes clusters version v1.18.0 or higher or the annotation "kubernetes.io/ingress.class" (deprecated). -All ingress classes are satisfied if this parameter is not set.`) +If this parameter is not set it will handle ingresses with either an empty or "nginx" class name.`) configMap = flags.String("configmap", "", `Name of the ConfigMap containing custom global configurations for the controller.`) diff --git a/docs/user-guide/cli-arguments.md b/docs/user-guide/cli-arguments.md index 051ff50b7..4ba81208b 100644 --- a/docs/user-guide/cli-arguments.md +++ b/docs/user-guide/cli-arguments.md @@ -25,7 +25,7 @@ They are set in the container spec of the `nginx-ingress-controller` Deployment | `--healthz-port` | Port to use for the healthz endpoint. (default 10254) | | `--http-port` | Port to use for servicing HTTP traffic. (default 80) | | `--https-port` | Port to use for servicing HTTPS traffic. (default 443) | -| `--ingress-class` | Name of the ingress class this controller satisfies. The class of an Ingress object is set using the field IngressClassName in Kubernetes clusters version v1.18.0 or higher or the annotation "kubernetes.io/ingress.class" (deprecated). All ingress classes are satisfied if this parameter is not set. | +| `--ingress-class` | Name of the ingress class this controller satisfies. The class of an Ingress object is set using the field IngressClassName in Kubernetes clusters version v1.18.0 or higher or the annotation "kubernetes.io/ingress.class" (deprecated). If this parameter is not set it will handle ingresses with either an empty or "nginx" class name. | | `--kubeconfig` | Path to a kubeconfig file containing authorization and API server information. | | `--log_backtrace_at` | when logging hits line file:N, emit a stack trace (default :0) | | `--log_dir` | If non-empty, write log files in this directory |