Skip to content

Commit

Permalink
update documentation for -ingress-class (#4542)
Browse files Browse the repository at this point in the history
  • Loading branch information
vepatel authored Oct 19, 2023
1 parent 728a2f6 commit 093f92d
Showing 1 changed file with 2 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -164,12 +164,8 @@ Sets the URI of health status location in the default server. Requires [-health-

### -ingress-class `<string>`

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`.
&nbsp;
Expand Down

0 comments on commit 093f92d

Please sign in to comment.