From bf4a85bc9526042c2160484d3192896e90529120 Mon Sep 17 00:00:00 2001 From: Venktesh Shivam Patel Date: Fri, 20 Oct 2023 09:34:11 +0100 Subject: [PATCH] update documentation for -ingress-class Signed-off-by: Venktesh Shivam Patel --- .../global-configuration/command-line-arguments.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/content/configuration/global-configuration/command-line-arguments.md b/docs/content/configuration/global-configuration/command-line-arguments.md index 56172fb3a3..4989c2a3dd 100644 --- a/docs/content/configuration/global-configuration/command-line-arguments.md +++ b/docs/content/configuration/global-configuration/command-line-arguments.md @@ -164,12 +164,8 @@ Sets the URI of health status location in the default server. Requires [-health- ### -ingress-class `` -A class of the Ingress Controller. - -A corresponding IngressClass resource with the name equal to the class must be deployed. Otherwise, the Ingress Controller will fail to start. -The Ingress Controller only processes resources that belong to its class - i.e. have the `ingressClassName` field resource equal to the class. - -The Ingress Controller processes all the resources that do not have the `ingressClassName` field. +The `-ingress-class` argument refers to the name of the resource `kind: IngressClass`. An IngressClass resource with a name equal to the class must be deployed. Otherwise, NGINX Ingress Controller will fail to start. +NGINX Ingress Controller will process Ingress resources that belong to its class, that is, those that have the `ingressClassName` field equal to the value of `-ingress-class` and skip the ones without it. It will also process all the VirtualServer/VirtualServerRoute/TransportServer resources that do not have the `ingressClassName` field. Default `nginx`.