Skip to content

Commit b654781

Browse files
committed
chore(lb): document some annotations
1 parent fb18303 commit b654781

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docs/loadbalancer-annotations.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,18 @@ The possible values are `false`, `true` or `*` for all ports or a comma delimite
111111
### `service.beta.kubernetes.io/scw-loadbalancer-type`
112112
This is the annotation to set the load balancer offer type.
113113

114+
### `service.beta.kubernetes.io/scw-loadbalancer-connection-rate-limit`
115+
This is the annotation to set the incoming connection rate limit per second.
116+
Set to 0 to disable the rate limit.
117+
118+
### `service.beta.kubernetes.io/scw-loadbalancer-enable-access-logs`
119+
This is the annotation to enable access logs for the load balancer.
120+
The default value is `false`. The possible values are `false` or `true`.
121+
122+
### `service.beta.kubernetes.io/scw-loadbalancer-enable-http3`
123+
This is the annotation to enable HTTP/3 protocol for the load balancer.
124+
The default value is `false`. The possible values are `false` or `true`.
125+
114126
### `service.beta.kubernetes.io/scw-loadbalancer-timeout-client`
115127
This is the annotation to set the maximum client connection inactivity time.
116128
The default value is `10m`. The duration are go's time.Duration (ex: `1s`, `2m`, `4h`, ...).
@@ -127,6 +139,10 @@ The default value is `10m`. The duration are go's time.Duration (ex: `1s`, `2m`,
127139
This is the annotation to set the maximum tunnel inactivity time.
128140
The default value is `10m`. The duration are go's time.Duration (ex: `1s`, `2m`, `4h`, ...).
129141

142+
### `service.beta.kubernetes.io/scw-loadbalancer-timeout-queue`
143+
This is the annotation to set the maximum time for a request to be left pending in queue when max_connections is reached.
144+
The duration are go's time.Duration (ex: `1s`, `2m`, `4h`, ...).
145+
130146
### `service.beta.kubernetes.io/scw-loadbalancer-on-marked-down-action`
131147
This is the annotation that modifes what occurs when a backend server is marked down.
132148
The default value is `on_marked_down_action_none` and the possible values are `on_marked_down_action_none` and `shutdown_sessions`.
@@ -167,9 +183,15 @@ Expected format: `"Key1=Val1,Key2=Val2"`
167183
This is the annotation to activate redispatch on another backend server in case of failure
168184
The default value is 0, which disable the redispatch. Only a value of 0 or 1 are allowed.
169185

186+
### `service.beta.kubernetes.io/scw-loadbalancer-max-connections`
187+
This is the annotation to configure the number of connections.
188+
170189
### `service.beta.kubernetes.io/scw-loadbalancer-max-retries`
171190
This is the annotation to configure the number of retry on connection failure
172-
The default value is 2.
191+
The default value is 3.
192+
193+
### `service.beta.kubernetes.io/scw-loadbalancer-failover-host`
194+
This is the annotation to specify the Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
173195

174196
### `service.beta.kubernetes.io/scw-loadbalancer-private`
175197
This is the annotation to configure the LB to be private or public

0 commit comments

Comments
 (0)