Skip to content

Commit 7a45dfd

Browse files
committed
DOC/MINOR: crds: add job-check-crd flag
1 parent f468a7b commit 7a45dfd

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

documentation/controller.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Image can be run with arguments:
1010
| Argument | Default |
1111
| - |:-:|
1212
| [`--configmap`](#--configmap) | `default/haproxy-configmap` |
13+
| [`--job-check-crd`](#--job-check-crd) | `false` |
1314
| [`--configmap-tcp-services`](#--configmap-tcp-services) | |
1415
| [`--configmap-errorfiles`](#--configmap-errorfiles) | |
1516
| [`--configmap-patternfiles`](#--configmap-patternfiles) | |
@@ -65,6 +66,24 @@ Example:
6566

6667
***
6768

69+
### `--job-check-crd`
70+
71+
Special mode for controller that checks if the CRDs are installed and are on latest version. Note that this will not run ingress controller, it just checks if CRDs are OK and exits
72+
73+
Possible values:
74+
75+
- this is boolean flag
76+
77+
Example:
78+
79+
```yaml
80+
--job-check-crd
81+
```
82+
83+
<p align='right'><a href='#haproxy-kubernetes-ingress-controller'>:arrow_up_small: back to top</a></p>
84+
85+
***
86+
6887
### `--configmap-tcp-services`
6988

7089
Sets the ConfigMap that contains mappings for TCP services to proxy through the ingress controller. This ConfigMap contains mappings like this:

documentation/doc.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ image_arguments:
77
default: default/haproxy-configmap
88
version_min: "1.4"
99
example: --configmap=default/my-configmap
10+
- argument: --job-check-crd
11+
description: Special mode for controller that checks if the CRDs are installed and are on latest version. Note that this will not run ingress controller, it just checks if CRDs are OK and exits
12+
values:
13+
- this is boolean flag
14+
default: false
15+
version_min: "1.9"
16+
example: --job-check-crd
1017
- argument: --configmap-tcp-services
1118
tip:
1219
- Ports of TCP services should be exposed on the controller's Kubernetes service

0 commit comments

Comments
 (0)