Skip to content

Commit 6b1ba77

Browse files
committed
DOC/MINOR: gateway: add gateway-controller-name to docs
1 parent cb1c052 commit 6b1ba77

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

documentation/controller.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Image can be run with arguments:
2020
| [`--default-ssl-certificate`](#--default-ssl-certificate) | |
2121
| [`--ingress.class`](#--ingressclass) | |
2222
| [`--empty-ingress-class`](#--empty-ingress-class) | `false` |
23+
| [`--gateway-controller-name`](#--gateway-controller-name) :construction:(dev) | |
2324
| [`--namespace-blacklist`](#--namespace-blacklist) | |
2425
| [`--namespace-whitelist`](#--namespace-whitelist) | |
2526
| [`--publish-service`](#--publish-service) | |
@@ -337,6 +338,28 @@ args:
337338

338339
***
339340

341+
### `--gateway-controller-name`
342+
343+
344+
> :construction: this is only available from next version, currently available in dev build
345+
346+
identifier of your controller to know which gatewayclass it will handle
347+
348+
Possible values:
349+
350+
- The name of the controllerName in GatewayClass
351+
352+
Example:
353+
354+
```yaml
355+
args:
356+
- --gateway-controller-name=haproxy.org/gateway-controller
357+
```
358+
359+
<p align='right'><a href='#haproxy-kubernetes-ingress-controller'>:arrow_up_small: back to top</a></p>
360+
361+
***
362+
340363
### `--namespace-blacklist`
341364

342365
Namespaces that the ingress controller should not monitor for changes to pods and services.

documentation/doc.yaml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,17 @@ image_arguments:
187187
helm: |-
188188
helm install haproxy haproxytech/kubernetes-ingress \
189189
--set-string "controller.extraArgs={--empty-ingress-class}"
190+
- argument: --gateway-controller-name
191+
description: identifier of your controller to know which gatewayclass it will handle
192+
values:
193+
- The name of the controllerName in GatewayClass
194+
version_min: "1.10"
195+
example: |-
196+
args:
197+
- --gateway-controller-name=haproxy.org/gateway-controller
198+
helm: |-
199+
helm install intranet haproxytech/kubernetes-ingress \
200+
--set controller.gatewayControllerName=haproxy.org/gateway-controller
190201
- argument: --namespace-blacklist
191202
description: Namespaces that the ingress controller should not monitor for changes to pods and services.
192203
values:
@@ -1126,7 +1137,7 @@ annotations:
11261137
haproxy.org/path-rewrite: (.*) /foo\1 # add the prefix /foo... "/bar?q=1" into "/foo/bar?q=1"
11271138
haproxy.org/path-rewrite: ([^?]*)(\?(.*))? \1/foo\2 # add the suffix /foo ... "/bar?q=1" into "/bar/foo?q=1"
11281139
haproxy.org/path-rewrite: /foo/(.*) /\1 # strip /foo ... "/foo/bar?q=1" into "/bar?q=1"
1129-
1140+
11301141
# strip /foo ... "/foo/bar?q=1" into "/bar?q=1" and replace "/bar/*" with "/baz/*"
11311142
# with multiline (using `|`) annotation
11321143
haproxy.org/path-rewrite: |

0 commit comments

Comments
 (0)