Skip to content

Commit

Permalink
DOC: metrics: add default-backend-port, prometheus, pprof to the list…
Browse files Browse the repository at this point in the history
… of available arguments
  • Loading branch information
oktalz committed Jun 1, 2022
1 parent 5659ba0 commit 0a7d61e
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 4 deletions.
5 changes: 4 additions & 1 deletion documentation/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This is autogenerated from [doc.yaml](doc.yaml). Description can be found in [ge
| [clean-certs](#clean-certs) | [bool](#bool) | "true" | |:large_blue_circle:|:white_circle:|:white_circle:|
| [client-ca](#authentication) | string | | ssl-offloading |:large_blue_circle:|:white_circle:|:white_circle:|
| [client-crt-optional](#authentication) | [bool](#bool) | "false" | client-ca |:large_blue_circle:|:white_circle:|:white_circle:|
| [client-strict-sni](#ssl-offloading) | [bool](#bool) | "false" | client-ca |:large_blue_circle:|:white_circle:|:white_circle:|
| [client-strict-sni](#ssl-offloading) :construction:(dev) | [bool](#bool) | "false" | client-ca |:large_blue_circle:|:white_circle:|:white_circle:|
| [cors-enable](#CORS) | [bool](#bool) | "false" | |:large_blue_circle:|:large_blue_circle:|:white_circle:|
| [cors-allow-origin](#CORS) | string | "*" | cors-enable |:large_blue_circle:|:large_blue_circle:|:white_circle:|
| [cors-allow-methods](#CORS) | string | "*" | cors-enable |:large_blue_circle:|:large_blue_circle:|:white_circle:|
Expand Down Expand Up @@ -1514,6 +1514,9 @@ src-ip-header: "True-Client-IP"

##### `client-strict-sni`


> :construction: this is only available from next version, currently available in dev build

If enabled, HAProxy will only accept TLS client connections where the provided SNI matchs an existing certificate.
If disabled HAProxy will service the default certificate when the provided SNI does not match.

Expand Down
71 changes: 70 additions & 1 deletion documentation/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ Image can be run with arguments:
| [`--configmap`](#--configmap) | `default/haproxy-configmap` |
| [`--configmap-tcp-services`](#--configmap-tcp-services) | |
| [`--configmap-errorfiles`](#--configmap-errorfiles) | |
| [`--configmap-patternfiles`](#--configmap-patternfiles) | |
| [`--configmap-patternfiles`](#--configmap-patternfiles) :construction:(dev) | |
| [`--default-backend-service`](#--default-backend-service) | |
| [`--default-backend-port`](#--default-backend-port) :construction:(dev) | |
| [`--pprof`](#--pprof) | |
| [`--prometheus`](#--prometheus) :construction:(dev) | |
| [`--default-ssl-certificate`](#--default-ssl-certificate) | |
| [`--ingress.class`](#--ingressclass) | |
| [`--empty-ingress-class`](#--empty-ingress-class) | `false` |
Expand Down Expand Up @@ -135,6 +138,9 @@ args:

### `--configmap-patternfiles`


> :construction: this is only available from next version, currently available in dev build

Sets the ConfigMap object that defines pattern files to be used in HAProxy configuration.
Controller will create corresponding files and update them when ConfigMap is updated.
Pattern files are particularly useful for [HAProxy ACLs](https://cbonte.github.io/haproxy-dconv/2.3/configuration.html#7.1) where we can load patterns from file.
Expand Down Expand Up @@ -217,6 +223,69 @@ args:

***

### `--default-backend-port`


> :construction: this is only available from next version, currently available in dev build

if default-backend-service is not used with this you can set default port used for same purpose

Possible values:

- port that will be used for default service within controller pod

Example:

```yaml
args:
- --default-backend-port=6060
```

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

***

### `--pprof`

enable pprof endpoint, if default-backend-port is not used 6060 will be used

Possible values:

- this is boolean flag

Example:

```yaml
args:
- --pprof
```

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

***

### `--prometheus`


> :construction: this is only available from next version, currently available in dev build

enable prometheus endpoint, if default-backend-port is not used 6060 will be used

Possible values:

- this is boolean flag

Example:

```yaml
args:
- --prometheus
```

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

***

### `--default-ssl-certificate`

The name of a TLS Secret that contains the certificate to use for SSL/TLS traffic. This can be overridden with the <code>ssl-certificate</code> setting.
Expand Down
28 changes: 26 additions & 2 deletions documentation/doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ image_arguments:
- In order to use pattern files, the target file **should be prefixed with "patterns/"**
values:
- The name of the ConfigMap in format NS/ConfigMapName
version_min: "1.6"
version_min: "1.8"
example: |-
args:
- --configmap-patternfiles=default/acl-patterns
Expand All @@ -127,6 +127,30 @@ image_arguments:
example: |-
args:
- --default-backend-service=default/my-default-service
- argument: --default-backend-port
description: if default-backend-service is not used with this you can set default port used for same purpose
values:
- port that will be used for default service within controller pod
version_min: "1.8"
example: |-
args:
- --default-backend-port=6060
- argument: --pprof
description: enable pprof endpoint, if default-backend-port is not used 6060 will be used
values:
- this is boolean flag
version_min: "1.4"
example: |-
args:
- --pprof
- argument: --prometheus
description: enable prometheus endpoint, if default-backend-port is not used 6060 will be used
values:
- this is boolean flag
version_min: "1.8"
example: |-
args:
- --prometheus
- argument: --default-ssl-certificate
description: The name of a TLS Secret that contains the certificate to use for SSL/TLS traffic. This can be overridden with the <code>ssl-certificate</code> setting.
values:
Expand Down Expand Up @@ -639,7 +663,7 @@ annotations:
- "false"
applies_to:
- configmap
version_min: "1.7"
version_min: "1.8"
example:
- "client-strict-sni: true"
- title: cors-enable
Expand Down

0 comments on commit 0a7d61e

Please sign in to comment.