Skip to content

Commit 64be9ca

Browse files
scaleway-botscaleway-bot
authored
docs(lb): corrected and improved LB doc wording (#2863)
1 parent 714a49a commit 64be9ca

59 files changed

Lines changed: 800 additions & 798 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎cmd/scw/testdata/test-all-usage-lb-backend-add-servers-usage.golden‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Add a set of servers in a given backend.
3+
For a given backend specified by its backend ID, add a set of backend servers (identified by their IP addresses) it should forward traffic to. These will be appended to any existing set of backend servers for this backend.
44

55
USAGE:
66
scw lb backend add-servers <backend-id ...> [arg=value ...]
@@ -12,7 +12,7 @@ ARGS:
1212
[use-instance-server-public-ip] Use public IP address of the instance instead of the private one
1313
[baremetal-server-id.{index}] UIID of the baremetal server.
1414
[baremetal-server-tag.{index}] Tag of the baremetal server.
15-
server-ip.{index} Set all IPs to add on your backend
15+
server-ip.{index} List of IP addresses to add to backend servers
1616
[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 | pl-waw-1 | pl-waw-2)
1717

1818
FLAGS:

‎cmd/scw/testdata/test-all-usage-lb-backend-create-usage.golden‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a backend in a given load balancer.
3+
Create a new backend for a given Load Balancer, specifying its full configuration including protocol, port and forwarding algorithm.
44

55
USAGE:
66
scw lb backend create [arg=value ...]
77

88
ARGS:
9-
name=<generated> Resource name
10-
forward-protocol Backend protocol. TCP or HTTP (tcp | http)
11-
forward-port User sessions will be forwarded to this port of backend servers
12-
forward-port-algorithm=roundrobin Load balancing algorithm (roundrobin | leastconn | first)
13-
sticky-sessions=none Enables cookie-based session persistence (none | cookie | table)
14-
[sticky-sessions-cookie-name] Cookie name for sticky sessions
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
1515
[health-check.mysql-config.user]
16-
[health-check.check-max-retries] Number of consecutive unsuccessful health checks, after which the server will be considered dead
16+
[health-check.check-max-retries] Number of consecutive unsuccessful health checks after which the server will be considered dead
1717
[health-check.pgsql-config.user]
18-
[health-check.http-config.uri] HTTP uri used with the request
19-
[health-check.http-config.method] HTTP method used with the request
20-
[health-check.http-config.code] HTTP response code so the Healthcheck is considered successfull
21-
[health-check.http-config.host-header] HTTP host header used with the request
22-
[health-check.https-config.uri] HTTP uri used with the request
23-
[health-check.https-config.method] HTTP method used with the request
24-
[health-check.https-config.code] HTTP response code so the Healthcheck is considered successfull
25-
[health-check.https-config.host-header] HTTP host header used with the request
26-
[health-check.https-config.sni] Specifies the SNI to use to do health checks over SSL
27-
[health-check.port] TCP port to use for the backend server health check
18+
[health-check.http-config.uri] HTTP URI used for the health check
19+
[health-check.http-config.method] HTTP method used for the health check
20+
[health-check.http-config.code] HTTP response code expected for a successful health check
21+
[health-check.http-config.host-header] HTTP host header used for the health check
22+
[health-check.https-config.uri] HTTP URI used for the health check
23+
[health-check.https-config.method] HTTP method used for the health check
24+
[health-check.https-config.code] HTTP response code expected for a successful health check
25+
[health-check.https-config.host-header] HTTP host header used for the health check
26+
[health-check.https-config.sni] SNI used for SSL health checks
27+
[health-check.port] Port to use for the backend server health check
2828
[health-check.check-timeout] Maximum time a backend server has to reply to the health check
29-
[health-check.check-delay] Time between two consecutive health checks
30-
[health-check.check-send-proxy] It defines whether the health check should be done considering the proxy protocol
31-
lb-id Load balancer ID
29+
[health-check.check-delay] Time to wait between two consecutive health checks
30+
[health-check.check-send-proxy] Defines whether proxy protocol should be activated for the health check
31+
lb-id Load Balancer ID
3232
[instance-server-id.{index}] UIID of the instance server.
3333
[instance-server-tag.{index}] Tag of the instance server.
3434
[use-instance-server-public-ip] Use public IP address of the instance instead of the private one
3535
[baremetal-server-id.{index}] UIID of the baremetal server.
3636
[baremetal-server-tag.{index}] Tag of the baremetal server.
37-
server-ip.{index} Backend server IP addresses list (IPv4 or IPv6)
38-
[timeout-server] Maximum server connection inactivity time (allowed time the server has to process the request)
39-
[timeout-connect] Maximum initial server connection establishment time
40-
[timeout-tunnel] Maximum tunnel inactivity time after Websocket is established (take precedence over client and server timeout)
41-
[on-marked-down-action] Modify what occurs when a backend server is marked down (on_marked_down_action_none | shutdown_sessions)
42-
[proxy-protocol] PROXY protocol, forward client's address (must be supported by backend servers software) (proxy_protocol_unknown | proxy_protocol_none | proxy_protocol_v1 | proxy_protocol_v2 | proxy_protocol_v2_ssl | proxy_protocol_v2_ssl_cn)
43-
[failover-host] Scaleway S3 bucket website to be served in case all backend servers are down
44-
[ssl-bridging] Enable SSL between load balancer and backend servers
45-
[ignore-ssl-server-verify] Set to true to ignore server certificate verification
37+
server-ip.{index} List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to
38+
[timeout-server] Maximum allowed time for a backend server to process a request
39+
[timeout-connect] Maximum allowed time for establishing a connection to a backend server
40+
[timeout-tunnel] Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout)
41+
[on-marked-down-action] Action to take when a backend server is marked as down (on_marked_down_action_none | shutdown_sessions)
42+
[proxy-protocol] PROXY protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. 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)
43+
[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. Do not include the scheme (eg https://)
44+
[ssl-bridging] Defines whether to enable SSL between the Load Balancer and backend servers
45+
[ignore-ssl-server-verify] Defines whether the server certificate verification should be ignored
4646
[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 | pl-waw-1 | pl-waw-2)
4747

4848
DEPRECATED ARGS:
49-
[send-proxy-v2] Deprecated in favor of proxy_protocol field !
49+
[send-proxy-v2] Deprecated in favor of proxy_protocol field
5050

5151
FLAGS:
5252
-h, --help help for create

‎cmd/scw/testdata/test-all-usage-lb-backend-delete-usage.golden‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a backend in a given load balancer.
3+
Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone.
44

55
USAGE:
66
scw lb backend delete <backend-id ...> [arg=value ...]

‎cmd/scw/testdata/test-all-usage-lb-backend-get-usage.golden‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get a backend in a given load balancer.
3+
Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm.
44

55
USAGE:
66
scw lb backend get <backend-id ...> [arg=value ...]

‎cmd/scw/testdata/test-all-usage-lb-backend-list-usage.golden‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List backends in a given load balancer.
3+
List all the backends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each backend. The response is an array of backend objects, containing full details of each one including their configuration parameters such as protocol, port and forwarding algorithm.
44

55
USAGE:
66
scw lb backend list [arg=value ...]
77

88
ARGS:
9-
lb-id Load balancer ID
10-
[name] Use this to search by name
11-
[order-by] Response order (created_at_asc | created_at_desc | name_asc | name_desc)
9+
lb-id Load Balancer ID
10+
[name] Name of the backend to filter for
11+
[order-by] Sort order of backends in the response (created_at_asc | created_at_desc | name_asc | name_desc)
1212
[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 | pl-waw-1 | pl-waw-2 | all)
1313

1414
FLAGS:

‎cmd/scw/testdata/test-all-usage-lb-backend-remove-servers-usage.golden‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Remove a set of servers for a given backend.
3+
For a given backend specified by its backend ID, remove the specified backend servers (identified by their IP addresses) so that it no longer forwards traffic to them.
44

55
USAGE:
66
scw lb backend remove-servers <backend-id ...> [arg=value ...]
@@ -12,7 +12,7 @@ ARGS:
1212
[use-instance-server-public-ip] Use public IP address of the instance instead of the private one
1313
[baremetal-server-id.{index}] UIID of the baremetal server.
1414
[baremetal-server-tag.{index}] Tag of the baremetal server.
15-
server-ip.{index} Set all IPs to remove of your backend
15+
server-ip.{index} List of IP addresses to remove from backend servers
1616
[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 | pl-waw-1 | pl-waw-2)
1717

1818
FLAGS:

‎cmd/scw/testdata/test-all-usage-lb-backend-set-servers-usage.golden‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Define all servers in a given backend.
3+
For a given backend specified by its backend ID, define the set of backend servers (identified by their IP addresses) that it should forward traffic to. Any existing backend servers configured for this backend will be removed.
44

55
USAGE:
66
scw lb backend set-servers <backend-id ...> [arg=value ...]
@@ -12,7 +12,7 @@ ARGS:
1212
[use-instance-server-public-ip] Use public IP address of the instance instead of the private one
1313
[baremetal-server-id.{index}] UIID of the baremetal server.
1414
[baremetal-server-tag.{index}] Tag of the baremetal server.
15-
server-ip.{index} Set all IPs to add on your backend and remove all other
15+
server-ip.{index} List of IP addresses for backend servers. Any other existing backend servers will be removed
1616
[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 | pl-waw-1 | pl-waw-2)
1717

1818
FLAGS:

‎cmd/scw/testdata/test-all-usage-lb-backend-update-healthcheck-usage.golden‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update an healthcheck for a given backend.
3+
Update the configuration of the health check performed by a given backend to verify the health of its backend servers, identified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.
44

55
USAGE:
66
scw lb backend update-healthcheck [arg=value ...]
77

88
ARGS:
9-
port Specify the port used to health check
10-
check-delay Time between two consecutive health checks
9+
port Port to use for the backend server health check
10+
check-delay Time to wait between two consecutive health checks
1111
check-timeout Maximum time a backend server has to reply to the health check
1212
check-max-retries Number of consecutive unsuccessful health checks, after which the server will be considered dead
1313
backend-id Backend ID
1414
[mysql-config.user]
1515
[pgsql-config.user]
16-
[http-config.uri] HTTP uri used with the request
17-
[http-config.method] HTTP method used with the request
18-
[http-config.code] HTTP response code so the Healthcheck is considered successfull
19-
[http-config.host-header] HTTP host header used with the request
20-
[https-config.uri] HTTP uri used with the request
21-
[https-config.method] HTTP method used with the request
22-
[https-config.code] HTTP response code so the Healthcheck is considered successfull
23-
[https-config.host-header] HTTP host header used with the request
24-
[https-config.sni] Specifies the SNI to use to do health checks over SSL
25-
[check-send-proxy] It defines whether the health check should be done considering the proxy protocol
16+
[http-config.uri] HTTP URI used for the health check
17+
[http-config.method] HTTP method used for the health check
18+
[http-config.code] HTTP response code expected for a successful health check
19+
[http-config.host-header] HTTP host header used for the health check
20+
[https-config.uri] HTTP URI used for the health check
21+
[https-config.method] HTTP method used for the health check
22+
[https-config.code] HTTP response code expected for a successful health check
23+
[https-config.host-header] HTTP host header used for the health check
24+
[https-config.sni] SNI used for SSL health checks
25+
[check-send-proxy] Defines whether proxy protocol should be activated for the health check
2626
[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 | pl-waw-1 | pl-waw-2)
2727

2828
FLAGS:

0 commit comments

Comments
 (0)