Skip to content

Commit 012b6b4

Browse files
committed
DOC: Add IngressClass description
1 parent e1f12b5 commit 012b6b4

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

documentation/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -800,13 +800,12 @@ ssl-redirect-port: 8443
800800

801801
##### `ingress.class`
802802

803-
Targets an ingress controller by class name for this ingress to use.
803+
Identifies the ingress controller to be used. If this value is the same as the [--ingress.class](./controller.md#--ingressclass) controller arg, the ingress resource will be processed.
804+
Starting from kubernetes 1.18, a new `ingressClassName` field has been added to the Ingress spec resource. This fields should reference an `IngressClass` and HAProxy Ingress controller will process the Ingress resource if the controller value of the referenced `IngressClass` is `haproxy.org/ingress-controller`. More About how IngressClass mechanism can be found in official kubernetes [documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class).
804805

805806
Available on: `ingress`
806807

807-
:information_source: Any ingress object which have class specified and its different from one defined in [image arguments](controller.md) will be ignored
808-
809-
:information_source: default: "" - all ingress objects are monitored
808+
:information_source: In case both `ingress.class` annotation and `ingressClassName` are used, `ingress.class` will have precedence.
810809

811810
Possible values:
812811

documentation/controller.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,8 @@ args:
238238

239239
A name to assign to the ingress controller so that Ingress objects can target it apart from other running ingress controllers.
240240

241+
:information_source: Starting from kubernetes 1.18, a new `ingressClass` resource can be referenced by Ingress objects to target an Ingress Controller. HAProxy Ingress Controller will handle IngressClasses with controller value equal to `haproxy.org/ingress-controller`. More About how IngressClass mechanism can be found in official kubernetes [documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class).
242+
241243
Possible values:
242244

243245
- The name of the ingress class

documentation/doc.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ image_arguments:
137137
- --default-ssl-certificate=default/my-tls
138138
- argument: --ingress.class
139139
description: A name to assign to the ingress controller so that Ingress objects can target it apart from other running ingress controllers.
140+
tip:
141+
- Starting from kubernetes 1.18, a new `ingressClass` resource can be referenced by Ingress objects to target an Ingress Controller. HAProxy Ingress Controller will handle IngressClasses with controller value equal to `haproxy.org/ingress-controller`. More About how IngressClass mechanism can be found in official kubernetes [documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class).
140142
values:
141143
- The name of the ingress class
142144
version_min: "1.4"
@@ -893,11 +895,10 @@ annotations:
893895
dependencies: ""
894896
default: ""
895897
description:
896-
- Targets an ingress controller by class name for this ingress to use.
898+
- Identifies the ingress controller to be used. If this value is the same as the [--ingress.class](./controller.md#--ingressclass) controller arg, the ingress resource will be processed.
899+
- Starting from kubernetes 1.18, a new `ingressClassName` field has been added to the Ingress spec resource. This fields should reference an `IngressClass` and HAProxy Ingress controller will process the Ingress resource if the controller value of the referenced `IngressClass` is `haproxy.org/ingress-controller`. More About how IngressClass mechanism can be found in official kubernetes [documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class).
897900
tip:
898-
- Any ingress object which have class specified and its different from one defined
899-
in [image arguments](controller.md) will be ignored
900-
- 'default: "" - all ingress objects are monitored'
901+
- In case both `ingress.class` annotation and `ingressClassName` are used, `ingress.class` will have precedence.
901902
values:
902903
- The ingress class name
903904
applies_to:

0 commit comments

Comments
 (0)