Skip to content

Commit

Permalink
DOC/MAJOR: update doc to 1.8 version as preparation for the release
Browse files Browse the repository at this point in the history
  • Loading branch information
oktalz committed Jun 1, 2022
1 parent 4452ab4 commit 88a9cb4
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 19 deletions.
2 changes: 1 addition & 1 deletion documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# ![HAProxy](../assets/images/haproxy-weblogo-210x49.png "HAProxy")

## HAProxy kubernetes ingress controller 1.7
## HAProxy kubernetes ingress controller 1.8

### Documentation

Expand Down
7 changes: 2 additions & 5 deletions documentation/annotations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# ![HAProxy](../assets/images/haproxy-weblogo-210x49.png "HAProxy")

## HAProxy kubernetes ingress controller 1.7
## HAProxy kubernetes ingress controller 1.8
This is autogenerated from [doc.yaml](doc.yaml). Description can be found in [generator readme](gen/README.md)

### Available annotations
Expand All @@ -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) :construction:(dev) | [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:|
| [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,9 +1514,6 @@ 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
15 changes: 3 additions & 12 deletions documentation/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +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) :construction:(dev) | |
| [`--configmap-patternfiles`](#--configmap-patternfiles) | |
| [`--default-backend-service`](#--default-backend-service) | |
| [`--default-backend-port`](#--default-backend-port) :construction:(dev) | |
| [`--default-backend-port`](#--default-backend-port) | |
| [`--pprof`](#--pprof) | |
| [`--prometheus`](#--prometheus) :construction:(dev) | |
| [`--prometheus`](#--prometheus) | |
| [`--default-ssl-certificate`](#--default-ssl-certificate) | |
| [`--ingress.class`](#--ingressclass) | |
| [`--empty-ingress-class`](#--empty-ingress-class) | `false` |
Expand Down Expand Up @@ -138,9 +138,6 @@ 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 @@ -225,9 +222,6 @@ 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:
Expand Down Expand Up @@ -266,9 +260,6 @@ args:

### `--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:
Expand Down
2 changes: 1 addition & 1 deletion documentation/doc.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
active_version: 1.7
active_version: 1.8
image_arguments:
- argument: --configmap
description: Sets the ConfigMap object that defines global settings for the ingress controller. An empty ConfigMap is deployed by default and you can see its name by calling <code>kubectl get configmaps</code>. You can either override the default ConfigMap with your own object that uses the same name, or you can set this argument to point to a different ConfigMap. See the ConfigMap Options to learn which values you can store in the ConfigMap.
Expand Down

0 comments on commit 88a9cb4

Please sign in to comment.