docs(lb): revamp of the LB API documentation to use anchors (#2982)

scaleway · Apr 3, 2023 · d163031 · d163031
1 parent 4af138b
commit d163031
Show file tree

Hide file tree

Showing 7 changed files with 88 additions and 82 deletions.
diff --git a/cmd/scw/testdata/test-all-usage-lb-backend-create-usage.golden b/cmd/scw/testdata/test-all-usage-lb-backend-create-usage.golden
@@ -12,9 +12,13 @@ ARGS:
   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]               
+  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-max-retries]               Number of consecutive unsuccessful health checks after which the server will be considered dead
-  [health-check.pgsql-config.user]               
+  [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
   [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
@@ -24,13 +28,9 @@ ARGS:
   [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 to wait between two consecutive health checks
   [health-check.check-send-proxy]                Defines whether proxy protocol should be activated for the health check
   [health-check.transient-check-delay.seconds]   
   [health-check.transient-check-delay.nanos]     
-  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
@@ -41,9 +41,9 @@ ARGS:
   [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
+  [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
+  [ssl-bridging]                                 Defines whether to enable SSL bridging between the Load Balancer and backend servers
   [ignore-ssl-server-verify]                     Defines whether the server certificate verification should be ignored
   [redispatch-attempt-count]                     Whether to use another backend server on each attempt
   [max-retries]                                  Number of retries when a backend server connection failed

diff --git a/cmd/scw/testdata/test-all-usage-lb-backend-update-healthcheck-usage.golden b/cmd/scw/testdata/test-all-usage-lb-backend-update-healthcheck-usage.golden
@@ -9,10 +9,11 @@ ARGS:
   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
+  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]               
+  [check-send-proxy]                Defines whether proxy protocol should be activated for the health check
+  [mysql-config.user]               MySQL user to use for the health check
+  [pgsql-config.user]               PostgreSQL user to use for the health check
   [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
@@ -22,7 +23,6 @@ ARGS:
   [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
   [transient-check-delay.seconds]   
   [transient-check-delay.nanos]     
   [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)

diff --git a/cmd/scw/testdata/test-all-usage-lb-backend-update-usage.golden b/cmd/scw/testdata/test-all-usage-lb-backend-update-usage.golden
@@ -16,12 +16,12 @@ ARGS:
   [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 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://)
+  [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
   [ssl-bridging]                  Defines whether to enable SSL bridging between the Load Balancer and backend servers
   [ignore-ssl-server-verify]      Defines whether the server certificate verification should be ignored
-  [redispatch-attempt-count]      Whether to use another backend server on each retries
+  [redispatch-attempt-count]      Whether to use another backend server on each attempt
   [max-retries]                   Number of retries when a backend server connection failed
   [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)
 

diff --git a/cmd/scw/testdata/test-all-usage-lb-private-network-attach-usage.golden b/cmd/scw/testdata/test-all-usage-lb-private-network-attach-usage.golden
@@ -8,7 +8,7 @@ USAGE:
 ARGS:
   lb-id                                Load Balancer ID
   private-network-id                   Private Network ID
-  [static-config.ip-address.{index}]   
+  [static-config.ip-address.{index}]   Array of a local IP address for the Load Balancer on this Private Network
   [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:

diff --git a/cmd/scw/testdata/test-all-usage-lb-route-list-usage.golden b/cmd/scw/testdata/test-all-usage-lb-route-list-usage.golden
@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   [order-by]        Sort order of routes in the response (created_at_asc | created_at_desc)
-  [frontend-id]     
+  [frontend-id]     Frontend ID to filter for, only Routes from this Frontend will be returned
   [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: