|
6 | 6 | scw lb backend create [arg=value ...] |
7 | 7 |
|
8 | 8 | ARGS: |
9 | | - name=<generated> Name for the backend |
10 | | - forward-protocol Protocol to be used by the backend when forwarding traffic to backend servers (tcp | http) |
11 | | - forward-port Port to be used by the backend when forwarding traffic to backend servers |
12 | | - forward-port-algorithm=roundrobin Load balancing algorithm to be used when determining which backend server to forward new traffic to (roundrobin | leastconn | first) |
13 | | - sticky-sessions=none Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server (none | cookie | table) |
14 | | - [sticky-sessions-cookie-name] Cookie name for cookie-based sticky sessions |
15 | | - lb-id Load Balancer ID |
16 | | - [health-check.port] Port to use for the backend server health check |
17 | | - [health-check.check-delay=3s] Time to wait between two consecutive health checks |
18 | | - [health-check.check-timeout=1s] Maximum time a backend server has to reply to the health check |
19 | | - [health-check.check-max-retries] Number of consecutive unsuccessful health checks after which the server will be considered dead |
20 | | - [health-check.mysql-config.user] MySQL user to use for the health check |
21 | | - [health-check.pgsql-config.user] PostgreSQL user to use for the health check |
22 | | - [health-check.http-config.uri] HTTP URI used for the health check |
23 | | - [health-check.http-config.method] HTTP method used for the health check |
24 | | - [health-check.http-config.code] HTTP response code expected for a successful health check |
25 | | - [health-check.http-config.host-header] HTTP host header used for the health check |
26 | | - [health-check.https-config.uri] HTTP URI used for the health check |
27 | | - [health-check.https-config.method] HTTP method used for the health check |
28 | | - [health-check.https-config.code] HTTP response code expected for a successful health check |
29 | | - [health-check.https-config.host-header] HTTP host header used for the health check |
30 | | - [health-check.https-config.sni] SNI used for SSL health checks |
31 | | - [health-check.check-send-proxy] Defines whether proxy protocol should be activated for the health check |
32 | | - [health-check.transient-check-delay.seconds] |
33 | | - [health-check.transient-check-delay.nanos] |
34 | | - [instance-server-id.{index}] UIID of the instance server. |
35 | | - [instance-server-tag.{index}] Tag of the instance server. |
36 | | - [use-instance-server-public-ip] Use public IP address of the instance instead of the private one |
37 | | - [baremetal-server-id.{index}] UIID of the baremetal server. |
38 | | - [baremetal-server-tag.{index}] Tag of the baremetal server. |
39 | | - server-ip.{index} List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to |
40 | | - [timeout-server=5m] Maximum allowed time for a backend server to process a request |
41 | | - [timeout-connect=5s] Maximum allowed time for establishing a connection to a backend server |
42 | | - [timeout-tunnel=15m] Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout) |
43 | | - [on-marked-down-action] Action to take when a backend server is marked as down (on_marked_down_action_none | shutdown_sessions) |
44 | | - [proxy-protocol] Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software (proxy_protocol_unknown | proxy_protocol_none | proxy_protocol_v1 | proxy_protocol_v2 | proxy_protocol_v2_ssl | proxy_protocol_v2_ssl_cn) |
45 | | - [failover-host] Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud |
46 | | - [ssl-bridging] Defines whether to enable SSL bridging between the Load Balancer and backend servers |
47 | | - [ignore-ssl-server-verify] Defines whether the server certificate verification should be ignored |
48 | | - [redispatch-attempt-count] Whether to use another backend server on each attempt |
49 | | - [max-retries] Number of retries when a backend server connection failed |
50 | | - [max-connections] Maximum number of connections allowed per backend server |
51 | | - [timeout-queue.seconds] |
52 | | - [timeout-queue.nanos] |
53 | | - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3) |
| 9 | + name=<generated> Name for the backend |
| 10 | + forward-protocol Protocol to be used by the backend when forwarding traffic to backend servers (tcp | http) |
| 11 | + forward-port Port to be used by the backend when forwarding traffic to backend servers |
| 12 | + forward-port-algorithm=roundrobin Load balancing algorithm to be used when determining which backend server to forward new traffic to (roundrobin | leastconn | first) |
| 13 | + sticky-sessions=none Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server (none | cookie | table) |
| 14 | + [sticky-sessions-cookie-name] Cookie name for cookie-based sticky sessions |
| 15 | + lb-id Load Balancer ID |
| 16 | + [health-check.port] Port to use for the backend server health check |
| 17 | + [health-check.check-delay=3s] Time to wait between two consecutive health checks |
| 18 | + [health-check.check-timeout=1s] Maximum time a backend server has to reply to the health check |
| 19 | + [health-check.check-max-retries] Number of consecutive unsuccessful health checks after which the server will be considered dead |
| 20 | + [health-check.mysql-config.user] MySQL user to use for the health check |
| 21 | + [health-check.pgsql-config.user] PostgreSQL user to use for the health check |
| 22 | + [health-check.http-config.uri] HTTP URI used for the health check |
| 23 | + [health-check.http-config.method] HTTP method used for the health check |
| 24 | + [health-check.http-config.code] HTTP response code expected for a successful health check |
| 25 | + [health-check.http-config.host-header] HTTP host header used for the health check |
| 26 | + [health-check.https-config.uri] HTTP URI used for the health check |
| 27 | + [health-check.https-config.method] HTTP method used for the health check |
| 28 | + [health-check.https-config.code] HTTP response code expected for a successful health check |
| 29 | + [health-check.https-config.host-header] HTTP host header used for the health check |
| 30 | + [health-check.https-config.sni] SNI used for SSL health checks |
| 31 | + [health-check.check-send-proxy] Defines whether proxy protocol should be activated for the health check |
| 32 | + [health-check.transient-check-delay=0.5s] Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN) |
| 33 | + [instance-server-id.{index}] UIID of the instance server. |
| 34 | + [instance-server-tag.{index}] Tag of the instance server. |
| 35 | + [use-instance-server-public-ip] Use public IP address of the instance instead of the private one |
| 36 | + [baremetal-server-id.{index}] UIID of the baremetal server. |
| 37 | + [baremetal-server-tag.{index}] Tag of the baremetal server. |
| 38 | + server-ip.{index} List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to |
| 39 | + [timeout-server=5m] Maximum allowed time for a backend server to process a request |
| 40 | + [timeout-connect=5s] Maximum allowed time for establishing a connection to a backend server |
| 41 | + [timeout-tunnel=15m] Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout) |
| 42 | + [on-marked-down-action] Action to take when a backend server is marked as down (on_marked_down_action_none | shutdown_sessions) |
| 43 | + [proxy-protocol] Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software (proxy_protocol_unknown | proxy_protocol_none | proxy_protocol_v1 | proxy_protocol_v2 | proxy_protocol_v2_ssl | proxy_protocol_v2_ssl_cn) |
| 44 | + [failover-host] Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud |
| 45 | + [ssl-bridging] Defines whether to enable SSL bridging between the Load Balancer and backend servers |
| 46 | + [ignore-ssl-server-verify] Defines whether the server certificate verification should be ignored |
| 47 | + [redispatch-attempt-count] Whether to use another backend server on each attempt |
| 48 | + [max-retries] Number of retries when a backend server connection failed |
| 49 | + [max-connections] Maximum number of connections allowed per backend server |
| 50 | + [timeout-queue] Maximum time for a request to be left pending in queue when `max_connections` is reached |
| 51 | + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3) |
54 | 52 |
|
55 | 53 | DEPRECATED ARGS: |
56 | 54 | [send-proxy-v2] Deprecated in favor of proxy_protocol field |
|
0 commit comments