Skip to content

Commit

Permalink
DOC/MINOR: crds: add job-check-crd flag
Browse files Browse the repository at this point in the history
  • Loading branch information
oktalz committed Jun 10, 2024
1 parent f468a7b commit 7a45dfd
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
19 changes: 19 additions & 0 deletions documentation/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Image can be run with arguments:
| Argument | Default |
| - |:-:|
| [`--configmap`](#--configmap) | `default/haproxy-configmap` |
| [`--job-check-crd`](#--job-check-crd) | `false` |
| [`--configmap-tcp-services`](#--configmap-tcp-services) | |
| [`--configmap-errorfiles`](#--configmap-errorfiles) | |
| [`--configmap-patternfiles`](#--configmap-patternfiles) | |
Expand Down Expand Up @@ -65,6 +66,24 @@ Example:

***

### `--job-check-crd`

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

Possible values:

- this is boolean flag

Example:

```yaml
--job-check-crd
```

<p align='right'><a href='#haproxy-kubernetes-ingress-controller'>:arrow_up_small: back to top</a></p>

***

### `--configmap-tcp-services`

Sets the ConfigMap that contains mappings for TCP services to proxy through the ingress controller. This ConfigMap contains mappings like this:
Expand Down
7 changes: 7 additions & 0 deletions documentation/doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ image_arguments:
default: default/haproxy-configmap
version_min: "1.4"
example: --configmap=default/my-configmap
- argument: --job-check-crd
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
values:
- this is boolean flag
default: false
version_min: "1.9"
example: --job-check-crd
- argument: --configmap-tcp-services
tip:
- Ports of TCP services should be exposed on the controller's Kubernetes service
Expand Down

0 comments on commit 7a45dfd

Please # to comment.