Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Add a set of servers in a given backend.
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.

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

FLAGS:
Expand Down
62 changes: 31 additions & 31 deletions cmd/scw/testdata/test-all-usage-lb-backend-create-usage.golden
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a backend in a given load balancer.
Create a new backend for a given Load Balancer, specifying its full configuration including protocol, port and forwarding algorithm.

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

ARGS:
name=<generated> Resource name
forward-protocol Backend protocol. TCP or HTTP (tcp | http)
forward-port User sessions will be forwarded to this port of backend servers
forward-port-algorithm=roundrobin Load balancing algorithm (roundrobin | leastconn | first)
sticky-sessions=none Enables cookie-based session persistence (none | cookie | table)
[sticky-sessions-cookie-name] Cookie name for sticky sessions
name=<generated> Name for the backend
forward-protocol Protocol to be used by the backend when forwarding traffic to backend servers (tcp | http)
forward-port Port to be used by the backend when forwarding traffic to backend servers
forward-port-algorithm=roundrobin Load balancing algorithm to be used when determining which backend server to forward new traffic to (roundrobin | leastconn | first)
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)
[sticky-sessions-cookie-name] Cookie name for cookie-based sticky sessions
[health-check.mysql-config.user]
[health-check.check-max-retries] Number of consecutive unsuccessful health checks, after which the server will be considered dead
[health-check.check-max-retries] Number of consecutive unsuccessful health checks after which the server will be considered dead
[health-check.pgsql-config.user]
[health-check.http-config.uri] HTTP uri used with the request
[health-check.http-config.method] HTTP method used with the request
[health-check.http-config.code] HTTP response code so the Healthcheck is considered successfull
[health-check.http-config.host-header] HTTP host header used with the request
[health-check.https-config.uri] HTTP uri used with the request
[health-check.https-config.method] HTTP method used with the request
[health-check.https-config.code] HTTP response code so the Healthcheck is considered successfull
[health-check.https-config.host-header] HTTP host header used with the request
[health-check.https-config.sni] Specifies the SNI to use to do health checks over SSL
[health-check.port] TCP port to use for the backend server health check
[health-check.http-config.uri] HTTP URI used for the health check
[health-check.http-config.method] HTTP method used for the health check
[health-check.http-config.code] HTTP response code expected for a successful health check
[health-check.http-config.host-header] HTTP host header used for the health check
[health-check.https-config.uri] HTTP URI used for the health check
[health-check.https-config.method] HTTP method used for the health check
[health-check.https-config.code] HTTP response code expected for a successful health check
[health-check.https-config.host-header] HTTP host header used for the health check
[health-check.https-config.sni] SNI used for SSL health checks
[health-check.port] Port to use for the backend server health check
[health-check.check-timeout] Maximum time a backend server has to reply to the health check
[health-check.check-delay] Time between two consecutive health checks
[health-check.check-send-proxy] It defines whether the health check should be done considering the proxy protocol
lb-id Load balancer ID
[health-check.check-delay] Time to wait between two consecutive health checks
[health-check.check-send-proxy] Defines whether proxy protocol should be activated for the health check
lb-id Load Balancer ID
[instance-server-id.{index}] UIID of the instance server.
[instance-server-tag.{index}] Tag of the instance server.
[use-instance-server-public-ip] Use public IP address of the instance instead of the private one
[baremetal-server-id.{index}] UIID of the baremetal server.
[baremetal-server-tag.{index}] Tag of the baremetal server.
server-ip.{index} Backend server IP addresses list (IPv4 or IPv6)
[timeout-server] Maximum server connection inactivity time (allowed time the server has to process the request)
[timeout-connect] Maximum initial server connection establishment time
[timeout-tunnel] Maximum tunnel inactivity time after Websocket is established (take precedence over client and server timeout)
[on-marked-down-action] Modify what occurs when a backend server is marked down (on_marked_down_action_none | shutdown_sessions)
[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)
[failover-host] Scaleway S3 bucket website to be served in case all backend servers are down
[ssl-bridging] Enable SSL between load balancer and backend servers
[ignore-ssl-server-verify] Set to true to ignore server certificate verification
server-ip.{index} List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to
[timeout-server] Maximum allowed time for a backend server to process a request
[timeout-connect] Maximum allowed time for establishing a connection to a backend server
[timeout-tunnel] Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout)
[on-marked-down-action] Action to take when a backend server is marked as down (on_marked_down_action_none | shutdown_sessions)
[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)
[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://)
[ssl-bridging] Defines whether to enable SSL between the Load Balancer and backend servers
[ignore-ssl-server-verify] Defines whether the server certificate verification should be ignored
[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)

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

FLAGS:
-h, --help help for create
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a backend in a given load balancer.
Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone.

USAGE:
scw lb backend delete <backend-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a backend in a given load balancer.
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.

USAGE:
scw lb backend get <backend-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List backends in a given load balancer.
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.

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

ARGS:
lb-id Load balancer ID
[name] Use this to search by name
[order-by] Response order (created_at_asc | created_at_desc | name_asc | name_desc)
lb-id Load Balancer ID
[name] Name of the backend to filter for
[order-by] Sort order of backends in the response (created_at_asc | created_at_desc | name_asc | name_desc)
[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)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Remove a set of servers for a given backend.
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.

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

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Define all servers in a given backend.
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.

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

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update an healthcheck for a given backend.
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.

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

ARGS:
port Specify the port used to health check
check-delay Time between two consecutive health checks
port Port to use for the backend server health check
check-delay Time to wait between two consecutive health checks
check-timeout Maximum time a backend server has to reply to the health check
check-max-retries Number of consecutive unsuccessful health checks, after which the server will be considered dead
backend-id Backend ID
[mysql-config.user]
[pgsql-config.user]
[http-config.uri] HTTP uri used with the request
[http-config.method] HTTP method used with the request
[http-config.code] HTTP response code so the Healthcheck is considered successfull
[http-config.host-header] HTTP host header used with the request
[https-config.uri] HTTP uri used with the request
[https-config.method] HTTP method used with the request
[https-config.code] HTTP response code so the Healthcheck is considered successfull
[https-config.host-header] HTTP host header used with the request
[https-config.sni] Specifies the SNI to use to do health checks over SSL
[check-send-proxy] It defines whether the health check should be done considering the proxy protocol
[http-config.uri] HTTP URI used for the health check
[http-config.method] HTTP method used for the health check
[http-config.code] HTTP response code expected for a successful health check
[http-config.host-header] HTTP host header used for the health check
[https-config.uri] HTTP URI used for the health check
[https-config.method] HTTP method used for the health check
[https-config.code] HTTP response code expected for a successful health check
[https-config.host-header] HTTP host header used for the health check
[https-config.sni] SNI used for SSL health checks
[check-send-proxy] Defines whether proxy protocol should be activated for the health check
[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)

FLAGS:
Expand Down
Loading