From 6013a0e0b3ca598ae40b91e964e3f324fb434c88 Mon Sep 17 00:00:00 2001 From: Aurelien GASTON Date: Mon, 27 Nov 2023 09:54:35 +0100 Subject: [PATCH] chore(doc): add missing annotations descriptions --- docs/loadbalancer-annotations.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/loadbalancer-annotations.md b/docs/loadbalancer-annotations.md index 2379f62..d14e721 100644 --- a/docs/loadbalancer-annotations.md +++ b/docs/loadbalancer-annotations.md @@ -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`, ...). @@ -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`). @@ -137,6 +147,10 @@ The possible format are: - `,` will use these certificates for all frontends - `:,;,:` 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.