Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(doc): add missing annotations descriptions #146

Merged
merged 1 commit into from
Nov 27, 2023
Merged

chore(doc): add missing annotations descriptions #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/loadbalancer-annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ The default value is `tcp` and the possible values are `tcp`, `http`, `https`, `
It is possible to set the type per port, like `80:http;443,8443:https`.
NB: depending on the type, some other annotations are required, see below.

### `service.beta.kubernetes.io/scw-loadbalancer-zone`
This is the annotation to select the zone to create the load balancer in.
The default is the first zone of the cluster's region.

### `service.beta.kubernetes.io/scw-loadbalancer-health-check-delay`
This is the annotation to set the time between two consecutive health checks.
The default value is `5s`. The duration are go's time.Duration (ex: `1s`, `2m`, `4h`, ...).
Expand Down Expand Up @@ -86,6 +90,12 @@ This is the annotation to set the PgSQL user used to check the PgSQL connection
It is possible to set the user per port, like `1234:root;3306,3307:mysql`.
NB: Required when setting service.beta.kubernetes.io/scw-loadbalancer-health-check-type to `pgsql`.

### `service.beta.kubernetes.io/scw-loadbalancer-send-proxy-v2`
**This field is DEPRECATED**, use `service.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v2` instead.
This is the annotation that enables PROXY protocol version 2 (must be supported by backend servers)
The default value is "false" and the possible values are "false" or "true" or a comma delimited list of the service port
on which to apply the proxy protocol (for instance "80,443").

### `service.beta.kubernetes.io/scw-loadbalancer-proxy-protocol-v1`
This is the annotation that can enable the PROXY protocol V1.
The possible values are `false`, `true` or `*` for all ports or a comma delimited list of the service port (for instance `80,443`).
Expand Down Expand Up @@ -137,6 +147,10 @@ The possible format are:
- `<certificate-id>,<certificate-id>` will use these certificates for all frontends
- `<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

### `service.beta.kubernetes.io/scw-loadbalancer-target-node-labels`
This is the annotation to target nodes with specific label(s).
Expected format: `"Key1=Val1,Key2=Val2"`

### `service.beta.kubernetes.io/scw-loadbalancer-redispatch-attempt-count`
This is the annotation to activate redispatch on another backend server in case of failure
The default value is 0, which disable the redispatch.
Expand Down
Loading