Skip to content

docs(lb): add default values #3050

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

Merged
merged 1 commit into from
Apr 21, 2023
Merged

docs(lb): add default values #3050

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions cmd/scw/testdata/test-all-usage-lb-backend-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ ARGS:
[sticky-sessions-cookie-name] Cookie name for cookie-based sticky sessions
lb-id Load Balancer ID
[health-check.port] Port to use for the backend server health check
[health-check.check-delay] Time to wait between two consecutive health checks
[health-check.check-timeout] Maximum time a backend server has to reply to the health check
[health-check.check-delay=3s] Time to wait between two consecutive health checks
[health-check.check-timeout=1s] Maximum time a backend server has to reply to the health check
[health-check.check-max-retries] Number of consecutive unsuccessful health checks after which the server will be considered dead
[health-check.mysql-config.user] MySQL user to use for the health check
[health-check.pgsql-config.user] PostgreSQL user to use for the health check
Expand All @@ -37,9 +37,9 @@ ARGS:
[baremetal-server-id.{index}] UIID of the baremetal server.
[baremetal-server-tag.{index}] Tag of the baremetal server.
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)
[timeout-server=5m] Maximum allowed time for a backend server to process a request
[timeout-connect=5s] Maximum allowed time for establishing a connection to a backend server
[timeout-tunnel=15m] 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] 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)
[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
Expand Down
6 changes: 3 additions & 3 deletions cmd/scw/testdata/test-all-usage-lb-backend-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ ARGS:
forward-port-algorithm Load balancing algorithm to be used when determining which backend server to forward new traffic to (roundrobin | leastconn | first)
sticky-sessions 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
[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)
[timeout-server=5m] Maximum allowed time for a backend server to process a request
[timeout-connect=5s] Maximum allowed time for establishing a connection to a backend server
[timeout-tunnel=15m] 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] 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)
[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
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-lb-frontend-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
inbound-port Port the frontend should listen on
lb-id Load Balancer ID (ID of the Load Balancer to attach the frontend to)
backend-id Backend ID (ID of the backend the frontend should pass traffic to)
[timeout-client] Maximum allowed inactivity time on the client side
[timeout-client=5m] Maximum allowed inactivity time on the client side
[certificate-ids.{index}] List of SSL/TLS certificate IDs to bind to the frontend
[enable-http3] Defines whether to enable HTTP/3 protocol on the frontend
[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)
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-lb-frontend-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
name Frontend name
inbound-port Port the frontend should listen on
backend-id Backend ID (ID of the backend the frontend should pass traffic to)
[timeout-client] Maximum allowed inactivity time on the client side
[timeout-client=5m] Maximum allowed inactivity time on the client side
[certificate-ids.{index}] List of SSL/TLS certificate IDs to bind to the frontend
[enable-http3] Defines whether to enable HTTP/3 protocol on the frontend
[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)
Expand Down
20 changes: 10 additions & 10 deletions docs/commands/lb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,8 @@ scw lb backend create [arg=value ...]
| sticky-sessions-cookie-name | | Cookie name for cookie-based sticky sessions |
| lb-id | Required | Load Balancer ID |
| health-check.port | | Port to use for the backend server health check |
| health-check.check-delay | | Time to wait between two consecutive health checks |
| health-check.check-timeout | | Maximum time a backend server has to reply to the health check |
| health-check.check-delay | Default: `3s` | Time to wait between two consecutive health checks |
| health-check.check-timeout | Default: `1s` | Maximum time a backend server has to reply to the health check |
| health-check.check-max-retries | | Number of consecutive unsuccessful health checks after which the server will be considered dead |
| health-check.mysql-config.user | | MySQL user to use for the health check |
| health-check.pgsql-config.user | | PostgreSQL user to use for the health check |
Expand All @@ -310,9 +310,9 @@ scw lb backend create [arg=value ...]
| baremetal-server-tag.{index} | | Tag of the baremetal server. |
| server-ip.{index} | Required | List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to |
| ~~send-proxy-v2~~ | Deprecated | Deprecated in favor of proxy_protocol field |
| 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) |
| timeout-server | Default: `5m` | Maximum allowed time for a backend server to process a request |
| timeout-connect | Default: `5s` | Maximum allowed time for establishing a connection to a backend server |
| timeout-tunnel | Default: `15m` | Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout) |
| on-marked-down-action | One of: `on_marked_down_action_none`, `shutdown_sessions` | Action to take when a backend server is marked as down |
| proxy-protocol | One of: `proxy_protocol_unknown`, `proxy_protocol_none`, `proxy_protocol_v1`, `proxy_protocol_v2`, `proxy_protocol_v2_ssl`, `proxy_protocol_v2_ssl_cn` | 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 |
| 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 |
Expand Down Expand Up @@ -481,9 +481,9 @@ scw lb backend update <backend-id ...> [arg=value ...]
| sticky-sessions | Required<br />One of: `none`, `cookie`, `table` | 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 |
| sticky-sessions-cookie-name | | Cookie name for cookie-based sticky sessions |
| ~~send-proxy-v2~~ | Deprecated | Deprecated in favor of proxy_protocol field |
| 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) |
| timeout-server | Default: `5m` | Maximum allowed time for a backend server to process a request |
| timeout-connect | Default: `5s` | Maximum allowed time for establishing a connection to a backend server |
| timeout-tunnel | Default: `15m` | Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout) |
| on-marked-down-action | One of: `on_marked_down_action_none`, `shutdown_sessions` | Action to take when a backend server is marked as down |
| proxy-protocol | One of: `proxy_protocol_unknown`, `proxy_protocol_none`, `proxy_protocol_v1`, `proxy_protocol_v2`, `proxy_protocol_v2_ssl`, `proxy_protocol_v2_ssl_cn` | 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 |
| 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 |
Expand Down Expand Up @@ -669,7 +669,7 @@ scw lb frontend create [arg=value ...]
| inbound-port | Required | Port the frontend should listen on |
| lb-id | Required | Load Balancer ID (ID of the Load Balancer to attach the frontend to) |
| backend-id | Required | Backend ID (ID of the backend the frontend should pass traffic to) |
| timeout-client | | Maximum allowed inactivity time on the client side |
| timeout-client | Default: `5m` | Maximum allowed inactivity time on the client side |
| ~~certificate-id~~ | Deprecated | Certificate ID, deprecated in favor of certificate_ids array |
| certificate-ids.{index} | | List of SSL/TLS certificate IDs to bind to the frontend |
| enable-http3 | | Defines whether to enable HTTP/3 protocol on the frontend |
Expand Down Expand Up @@ -758,7 +758,7 @@ scw lb frontend update <frontend-id ...> [arg=value ...]
| name | Required | Frontend name |
| inbound-port | Required | Port the frontend should listen on |
| backend-id | Required | Backend ID (ID of the backend the frontend should pass traffic to) |
| timeout-client | | Maximum allowed inactivity time on the client side |
| timeout-client | Default: `5m` | Maximum allowed inactivity time on the client side |
| ~~certificate-id~~ | Deprecated | Certificate ID, deprecated in favor of certificate_ids array |
| certificate-ids.{index} | | List of SSL/TLS certificate IDs to bind to the frontend |
| enable-http3 | | Defines whether to enable HTTP/3 protocol on the frontend |
Expand Down
10 changes: 10 additions & 0 deletions internal/namespaces/lb/v1/lb_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,13 +803,15 @@ func lbBackendCreate() *core.Command {
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("3s"),
},
{
Name: "health-check.check-timeout",
Short: `Maximum time a backend server has to reply to the health check`,
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("1s"),
},
{
Name: "health-check.check-max-retries",
Expand Down Expand Up @@ -934,20 +936,23 @@ func lbBackendCreate() *core.Command {
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("5m"),
},
{
Name: "timeout-connect",
Short: `Maximum allowed time for establishing a connection to a backend server`,
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("5s"),
},
{
Name: "timeout-tunnel",
Short: `Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout)`,
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("15m"),
},
{
Name: "on-marked-down-action",
Expand Down Expand Up @@ -1118,20 +1123,23 @@ func lbBackendUpdate() *core.Command {
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("5m"),
},
{
Name: "timeout-connect",
Short: `Maximum allowed time for establishing a connection to a backend server`,
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("5s"),
},
{
Name: "timeout-tunnel",
Short: `Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout)`,
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("15m"),
},
{
Name: "on-marked-down-action",
Expand Down Expand Up @@ -1597,6 +1605,7 @@ func lbFrontendCreate() *core.Command {
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("5m"),
},
{
Name: "certificate-id",
Expand Down Expand Up @@ -1706,6 +1715,7 @@ func lbFrontendUpdate() *core.Command {
Required: false,
Deprecated: false,
Positional: false,
Default: core.DefaultValueSetter("5m"),
},
{
Name: "certificate-id",
Expand Down