Skip to content

Commit 15d4efa

Browse files
fabianonunesoktalz
authored andcommitted
DOC/MEDIUM: add http-connection-mode and deprecate http-server-close and http-keep-alive
1 parent 0217c3e commit 15d4efa

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

documentation/annotations.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This is autogenerated from [doc.yaml](doc.yaml). Description can be found in [ge
3838
| [src-ip-header](#src-ip-header) | string | "null" | |:large_blue_circle:|:large_blue_circle:|:white_circle:|
3939
| [forwarded-for](#x-forwarded-for) | [bool](#bool) | "true" | |:large_blue_circle:|:large_blue_circle:|:large_blue_circle:|
4040
| [hard-stop-after](#hard-stop-after) | [time](#time) | "1h" | |:large_blue_circle:|:white_circle:|:white_circle:|
41+
| [http-connection-mode](#http-options) | string | "http-keep-alive" | |:large_blue_circle:|:white_circle:|:white_circle:|
4142
| [http-keep-alive](#http-options) | [bool](#bool) | "true" | |:large_blue_circle:|:white_circle:|:white_circle:|
4243
| [http-server-close](#http-options) | [bool](#bool) | "false" | |:large_blue_circle:|:white_circle:|:white_circle:|
4344
| [ingress.class](#ingress-class) | string | | |:white_circle:|:large_blue_circle:|:white_circle:|
@@ -682,8 +683,27 @@ hard-stop-after: 30s
682683

683684
#### Http Options
684685

686+
##### `http-connection-mode`
687+
688+
Sets HAProxy connection mode
689+
690+
Available on: `configmap`
691+
692+
Possible values:
693+
694+
- http-keep-alive `default` - Enables HTTP Keep-Alive both from the client to HAProxy and from HAProxy to the backend.
695+
- http-server-close - Disables HTTP Keep-Alive between HAProxy and the backend, while allowing it to stay enabled from the client to HAProxy.
696+
- httpclose - HAProxy will close connections with the server and the client as soon as the request and the response are received
697+
698+
Example:
699+
700+
```yaml
701+
http-connection-mode: "http-server-close"
702+
```
703+
685704
##### `http-keep-alive`
686705

706+
**Deprecated**, use `http-connection-mode` instead.
687707
Enables HTTP Keep-Alive both from the client to HAProxy and from HAProxy to the backend.
688708

689709
Available on: `configmap`
@@ -701,6 +721,7 @@ http-keep-alive: "true"
701721

702722
##### `http-server-close`
703723

724+
**Deprecated**, use `http-connection-mode` instead.
704725
Disables HTTP Keep-Alive between HAProxy and the backend, while allowing it to stay enabled from the client to HAProxy.
705726

706727
Available on: `configmap`

documentation/doc.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,12 +929,31 @@ annotations:
929929
- configmap
930930
version_min: "1.4"
931931
example: ["hard-stop-after: 30s"]
932+
- title: http-connection-mode
933+
type: string
934+
group: http-options
935+
dependencies: ""
936+
default: http-keep-alive
937+
description:
938+
- Sets HAProxy connection mode
939+
values:
940+
- http-keep-alive `default` - Enables HTTP Keep-Alive both from the client to HAProxy and
941+
from HAProxy to the backend.
942+
- http-server-close - Disables HTTP Keep-Alive between HAProxy and the backend,
943+
while allowing it to stay enabled from the client to HAProxy.
944+
- httpclose - HAProxy will close connections with the server and the client as
945+
soon as the request and the response are received
946+
applies_to:
947+
- configmap
948+
version_min: "1.8"
949+
example: ['http-connection-mode: "http-server-close"']
932950
- title: http-keep-alive
933951
type: bool
934952
group: http-options
935953
dependencies: ""
936954
default: "true"
937955
description:
956+
- '**Deprecated**, use `http-connection-mode` instead.'
938957
- Enables HTTP Keep-Alive both from the client to HAProxy and from HAProxy to the
939958
backend.
940959
tip: []
@@ -951,6 +970,7 @@ annotations:
951970
dependencies: ""
952971
default: "false"
953972
description:
973+
- '**Deprecated**, use `http-connection-mode` instead.'
954974
- Disables HTTP Keep-Alive between HAProxy and the backend, while allowing it to
955975
stay enabled from the client to HAProxy.
956976
tip: []

0 commit comments

Comments
 (0)