diff --git a/documentation/controller.md b/documentation/controller.md index bae52cde..4a7ae55d 100644 --- a/documentation/controller.md +++ b/documentation/controller.md @@ -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) | | @@ -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 +``` + +

:arrow_up_small: back to top

+ +*** + ### `--configmap-tcp-services` Sets the ConfigMap that contains mappings for TCP services to proxy through the ingress controller. This ConfigMap contains mappings like this: diff --git a/documentation/doc.yaml b/documentation/doc.yaml index 2b060c45..d4dbe9c2 100644 --- a/documentation/doc.yaml +++ b/documentation/doc.yaml @@ -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