Skip to content

Commit 0dbd179

Browse files
authored
chore(doc): add missing annotations descriptions (#146)
1 parent 96f88b2 commit 0dbd179

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/loadbalancer-annotations.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ The default value is `tcp` and the possible values are `tcp`, `http`, `https`, `
4545
It is possible to set the type per port, like `80:http;443,8443:https`.
4646
NB: depending on the type, some other annotations are required, see below.
4747

48+
### `service.beta.kubernetes.io/scw-loadbalancer-zone`
49+
This is the annotation to select the zone to create the load balancer in.
50+
The default is the first zone of the cluster's region.
51+
4852
### `service.beta.kubernetes.io/scw-loadbalancer-health-check-delay`
4953
This is the annotation to set the time between two consecutive health checks.
5054
The default value is `5s`. The duration are go's time.Duration (ex: `1s`, `2m`, `4h`, ...).
@@ -86,6 +90,12 @@ This is the annotation to set the PgSQL user used to check the PgSQL connection
8690
It is possible to set the user per port, like `1234:root;3306,3307:mysql`.
8791
NB: Required when setting service.beta.kubernetes.io/scw-loadbalancer-health-check-type to `pgsql`.
8892

93+
### `service.beta.kubernetes.io/scw-loadbalancer-send-proxy-v2`
94+
**This field is DEPRECATED**, use `service.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v2` instead.
95+
This is the annotation that enables PROXY protocol version 2 (must be supported by backend servers)
96+
The default value is "false" and the possible values are "false" or "true" or a comma delimited list of the service port
97+
on which to apply the proxy protocol (for instance "80,443").
98+
8999
### `service.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v1`
90100
This is the annotation that can enable the PROXY protocol V1.
91101
The possible values are `false`, `true` or `*` for all ports or a comma delimited list of the service port (for instance `80,443`).
@@ -137,6 +147,10 @@ The possible format are:
137147
- `<certificate-id>,<certificate-id>` will use these certificates for all frontends
138148
- `<port1>:<certificate1-id>,<certificate2-id>;<port2>,<port3>:<certificate3-id>` will use certificate 1 and 2 for frontend with port port1 and certificate3 for frotend with port port2 and port3
139149

150+
### `service.beta.kubernetes.io/scw-loadbalancer-target-node-labels`
151+
This is the annotation to target nodes with specific label(s).
152+
Expected format: `"Key1=Val1,Key2=Val2"`
153+
140154
### `service.beta.kubernetes.io/scw-loadbalancer-redispatch-attempt-count`
141155
This is the annotation to activate redispatch on another backend server in case of failure
142156
The default value is 0, which disable the redispatch.

0 commit comments

Comments
 (0)