Skip to content

Commit

Permalink
Fixup docs for the ingress-class flag.
Browse files Browse the repository at this point in the history
According to this issue, there is no way to handle all ingress classes.

#3101
  • Loading branch information
Mason Staugler committed Jun 26, 2020
1 parent d825859 commit a3f2be6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion cmd/nginx/flags.go
Expand Up @@ -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.`)
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/cli-arguments.md
Expand Up @@ -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 |
Expand Down

0 comments on commit a3f2be6

Please sign in to comment.