Skip to content

Commit 5a13ed6

Browse files
RoRoJyfodilremyleone
authored
docs(lb): review lb doc (#2616)
* fix(lb): review lb doc * Apply suggestions from code review Co-authored-by: Yacine Fodil <[email protected]> * fix trailing spaces --------- Co-authored-by: Yacine Fodil <[email protected]> Co-authored-by: Rémy Léone <[email protected]> Co-authored-by: Yacine FODIL <[email protected]>
1 parent cbc26ca commit 5a13ed6

File tree

19 files changed

+270
-241
lines changed

19 files changed

+270
-241
lines changed

‎docs/data-sources/lb.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb"
77

88
Gets information about a Load Balancer.
99

10+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/concepts/#load-balancers) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-load-balancer-list-load-balancers).
11+
1012
## Example Usage
1113

1214
```hcl
@@ -23,24 +25,24 @@ data "scaleway_lb" "by_id" {
2325

2426
## Argument Reference
2527

26-
- `name` - (Optional) The load balancer name.
28+
- `name` - (Optional) The Load Balancer name.
2729

28-
- `ip_id` - (Optional) The load balancer IP ID.
30+
- `ip_id` - (Optional) The Load Balancer IP ID.
2931

30-
- `project_id` - (Optional) The ID of the project the LB is associated with.
32+
- `project_id` - (Optional) The ID of the Project the Load Balancer is associated with.
3133

3234
## Attributes Reference
3335

3436
In addition to all arguments above, the following attributes are exported:
3537

36-
- `id` - The ID of the load-balancer.
38+
- `id` - The ID of the Load Balancer.
3739

38-
~> **Important:** Load-Balancers' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
40+
~> **Important:** Load Balancer IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
3941

40-
- `ip_address` - The load-balancer public IP Address.
42+
- `ip_address` - The Load Balancer public IP address.
4143

42-
- `type` - The type of the load-balancer.
44+
- `type` - The Load Balancer type.
4345

44-
- `tags` - The tags associated with the load-balancer.
46+
- `tags` - The tags associated with the Load Balancer.
4547

46-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the LB exists.
48+
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer exists.

‎docs/data-sources/lb_acls.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb_acls"
77

88
Gets information about multiple Load Balancer ACLs.
99

10+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/acls/) or [API reference](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-acls-get-an-acl).
11+
1012
## Example Usage
1113

1214
```hcl
@@ -23,33 +25,33 @@ data "scaleway_lb_acls" "byFrontID_and_name" {
2325

2426
## Argument Reference
2527

26-
- `frontend_id` - (Required) The frontend ID this ACL is attached to. ACLs with a frontend ID like it are listed.
27-
~> **Important:** LB Frontends' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
28+
- `frontend_id` - (Required) The frontend ID this ACL is attached to. ACLs with a matching frontend ID are listed.
29+
~> **Important:** LB frontend IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
2830

29-
- `name` - (Optional) The ACL name used as filter. ACLs with a name like it are listed.
31+
- `name` - (Optional) The ACL name to filter for. ACLs with a matching name are listed.
3032

31-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which ACLs exist.
33+
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the ACLs exist.
3234

3335
## Attributes Reference
3436

3537
In addition to all arguments above, the following attributes are exported:
3638

37-
- `acls` - List of found ACLs
39+
- `acls` - List of retrieved ACLs
3840
- `id` - The associated ACL ID.
3941
~> **Important:** LB ACLs' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
40-
- `created_at` - The date at which the ACL was created (RFC 3339 format).
41-
- `update_at` - The date at which the ACL was last updated (RFC 3339 format).
42-
- `index` - The order between the ACLs.
42+
- `created_at` - The date on which the ACL was created (RFC 3339 format).
43+
- `update_at` - The date on which the ACL was last updated (RFC 3339 format).
44+
- `index` - The priority of this ACL in the ordered list.
4345
- `description` - The description of the ACL resource.
44-
- `action` - The action that has been undertaken when an ACL filter had matched.
46+
- `action` - The action to be undertaken when an ACL filter matches.
4547
- `type` - The action type.
4648
- `redirect` - Redirect parameters when using an ACL with `redirect` action.
4749
- `type` - The redirect type.
48-
- `target` - The URL used in case of a location redirect or the scheme name that replaces the request's original scheme.
49-
- `code` - The HTTP redirect code used.
50+
- `target` - The URL used in case of a location redirect, or the scheme name that replaces the request's original scheme.
51+
- `code` - The HTTP redirect code to use.
5052
- `match` - The ACL match rule.
51-
- `ip_subnet` - A list of matched IPs or CIDR v4/v6 addresses of the client of the session.
52-
- `http_filter` - The matched HTTP filter.
53-
- `http_filter_value` - The possible values matched for a given HTTP filter.
53+
- `ip_subnet` - A list of IPs, or CIDR v4/v6 addresses of the session client, to match.
54+
- `http_filter` - The HTTP filter to match.
55+
- `http_filter_value` - The possible values to match for a given HTTP filter.
5456
- `http_filter_option` - A list of possible values for the HTTP filter based on the HTTP header.
5557
- `invert` - The condition will be of type "unless" if invert is set to `true`

‎docs/data-sources/lb_backend.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_backend"
55

66
# scaleway_lb_backend
77

8-
Get information about Scaleway Load-Balancer Backends.
9-
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends).
8+
Get information about Scaleway Load Balancer backends.
9+
10+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-backends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends).
1011

1112
## Example Usage
1213

@@ -41,14 +42,14 @@ data "scaleway_lb_backend" "byName" {
4142

4243
The following arguments are supported:
4344

44-
- `backend_id` - (Optional) The backend id.
45+
- `backend_id` - (Optional) The backend ID.
4546
- Only one of `name` and `backend_id` should be specified.
4647

4748
- `name` - (Optional) The name of the backend.
48-
- When using the `name` you should specify the `lb-id`
49+
- When using `name` you should specify the `lb-id`
4950

50-
- `lb_id` - (Required) The load-balancer ID this backend is attached to.
51+
- `lb_id` - (Required) Load Balancer ID this backend is attached to.
5152

5253
## Attributes Reference
5354

54-
See the [LB Backend Resource](../resources/lb_backend.md) for details on the returned attributes - they are identical.
55+
See the [Load Balancer backend resource](../resources/lb_backend.md) for details on the returned attributes - they are identical.

‎docs/data-sources/lb_backends.md‎

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb_backends"
77

88
Gets information about multiple Load Balancer Backends.
99

10+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-backends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends).
11+
1012
## Example Usage
1113

1214
```hcl
@@ -23,22 +25,22 @@ data "scaleway_lb_backends" "byLBID_and_name" {
2325

2426
## Argument Reference
2527

26-
- `lb_id` - (Required) The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
28+
- `lb_id` - (Required) The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
2729

28-
- `name` - (Optional) The backend name used as filter. Backends with a name like it are listed.
30+
- `name` - (Optional) The backend name to filter for. Backends with a matching name are listed.
2931

3032
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which backends exist.
3133

3234
## Attributes Reference
3335

3436
In addition to all arguments above, the following attributes are exported:
3537

36-
- `backends` - List of found backends
38+
- `backends` - List of retrieved backends
3739
- `id` - The associated backend ID.
3840
- `forward_protocol` - Backend protocol.
39-
- `created_at` - The date at which the backend was created (RFC 3339 format).
40-
- `update_at` - The date at which the backend was last updated (RFC 3339 format).
41-
- `forward_port` - User sessions will be forwarded to this port of backend servers.
41+
- `created_at` - The date on which the backend was created (RFC 3339 format).
42+
- `update_at` - The date on which the backend was last updated (RFC 3339 format).
43+
- `forward_port` - User sessions will be forwarded to this backend server port.
4244
- `forward_port_algorithm` - Load balancing algorithm.
4345
- `sticky_sessions` - Enables cookie-based session persistence.
4446
- `sticky_sessions_cookie_name` - Cookie name for sticky sessions.
@@ -47,23 +49,23 @@ In addition to all arguments above, the following attributes are exported:
4749
- `timeout_server` - Maximum server connection inactivity time.
4850
- `timeout_connect` - Maximum initial server connection establishment time.
4951
- `timeout_tunnel` - Maximum tunnel inactivity time.
50-
- `failover_host` - Scaleway S3 bucket website to be served in case all backend servers are down.
51-
- `ssl_bridging` - Enables SSL between load balancer and backend servers.
52+
- `failover_host` - Scaleway S3 bucket website to be served if all backend servers are down.
53+
- `ssl_bridging` - Enables SSL between Load Balancer and backend servers.
5254
- `ignore_ssl_server_verify` - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
53-
- `health_check_timeout` - Timeout before we consider a HC request failed.
54-
- `health_check_delay` - Interval between two HC requests.
55-
- `health_check_port` - Port the HC requests will be sent to.
56-
- `health_check_max_retries` - Number of allowed failed HC requests before the backend server is marked down.
57-
- `health_check_tcp` - This block enable TCP health check.
58-
- `health_check_http` - This block enable HTTP health check.
59-
- `uri` - The HTTP endpoint URL to call for HC requests.
60-
- `method` - The HTTP method to use for HC requests.
55+
- `health_check_timeout` - Timeout before a health check request is considered failed.
56+
- `health_check_delay` - Interval between two health check requests.
57+
- `health_check_port` - Port the health check requests will be sent to.
58+
- `health_check_max_retries` - Number of allowed failed health check requests before the backend server is marked as down.
59+
- `health_check_tcp` - This block enables TCP health checks.
60+
- `health_check_http` - This block enables HTTP health checks.
61+
- `uri` - The HTTP endpoint URL to call for health check requests.
62+
- `method` - The HTTP method to use for health check requests.
6163
- `code` - The expected HTTP status code.
62-
- `host_header` - The HTTP host header to use for HC requests.
63-
- `health_check_https` - This block enable HTTPS health check.
64-
- `uri` - The HTTPS endpoint URL to call for HC requests.
65-
- `method` - The HTTP method to use for HC requests.
64+
- `host_header` - The HTTP host header to use for health check requests.
65+
- `health_check_https` - This block enables HTTPS health checks.
66+
- `uri` - The HTTPS endpoint URL to call for health check requests.
67+
- `method` - The HTTP method to use for health check requests.
6668
- `code` - The expected HTTP status code.
67-
- `host_header` - The HTTP host header to use for HC requests.
69+
- `host_header` - The HTTP host header to use for health check requests.
6870
- `sni` - The SNI to use for HC requests over SSL.
6971
- `on_marked_down_action` - Modify what occurs when a backend server is marked down.

‎docs/data-sources/lb_certificate.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ page_title: "Scaleway: scaleway_lb_certificate"
55

66
# scaleway_lb_certificate
77

8-
Get information about Scaleway Load-Balancer Certificates.
8+
Get information about Scaleway Load Balancer certificates.
99

10-
This data source can prove useful when a module accepts an LB Certificate as an input variable and needs to, for example, determine the security of a certificate for your LB Frontend associated with your domain, etc.
10+
This data source can prove useful when a module accepts a Load Balancer certificate as an input variable and needs to, for example, determine the security of a certificate for the frontend associated with your domain.
1111

12-
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-certificate).
12+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/add-certificate/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-certificate).
1313

1414
## Examples
1515

@@ -47,14 +47,14 @@ data "scaleway_lb_certificate" "byName" {
4747

4848
The following arguments are supported:
4949

50-
- `certificate_id` - (Optional) The certificate id.
50+
- `certificate_id` - (Optional) The certificate ID.
5151
- Only one of `name` and `certificate_id` should be specified.
5252

53-
- `name` - (Optional) The name of the certificate backend.
53+
- `name` - (Optional) The name of the Load Balancer certificate.
5454
- When using a certificate `name` you should specify the `lb-id`
5555

56-
- `lb_id` - (Required) The load-balancer ID this certificate is attached to.
56+
- `lb_id` - (Required) The Load Balancer ID this certificate is attached to.
5757

5858
## Attributes Reference
5959

60-
See the [LB Certificate Resource](../resources/lb_certificate.md) for details on the returned attributes - they are identical.
60+
See the [Load Balancer certificate resource](../resources/lb_certificate.md) for details on the returned attributes - they are identical.

‎docs/data-sources/lb_frontend.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontend"
55

66
# scaleway_lb_frontend
77

8-
Get information about Scaleway Load-Balancer Frontends.
9-
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
8+
Get information about Scaleway Load Balancer frontends.
9+
10+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-frontends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
1011

1112
## Example Usage
1213

@@ -43,14 +44,14 @@ data "scaleway_lb_frontend" "byName" {
4344

4445
The following arguments are supported:
4546

46-
- `frontend_id` - (Optional) The frontend id.
47+
- `frontend_id` - (Optional) The frontend ID.
4748
- Only one of `name` and `frontend_id` should be specified.
4849

4950
- `name` - (Optional) The name of the frontend.
5051
- When using the `name` you should specify the `lb-id`
5152

52-
- `lb_id` - (Required) The load-balancer ID this frontend is attached to.
53+
- `lb_id` - (Required) The Load Balancer ID this frontend is attached to.
5354

5455
## Attributes Reference
5556

56-
See the [LB Frontend Resource](../resources/lb_frontend.md) for details on the returned attributes - they are identical.
57+
See the [Load Balancer frontend resource](../resources/lb_frontend.md) for details on the returned attributes - they are identical.

‎docs/data-sources/lb_frontends.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontends"
55

66
# scaleway_lb_frontends
77

8-
Gets information about multiple Load Balancer Frontends.
8+
Gets information about multiple Load Balancer frontends.
9+
10+
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-frontends/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
911

1012
## Example Usage
1113

@@ -23,24 +25,24 @@ data "scaleway_lb_frontends" "byLBID_and_name" {
2325

2426
## Argument Reference
2527

26-
- `lb_id` - (Required) The load-balancer ID this frontend is attached to. frontends with a LB ID like it are listed.
28+
- `lb_id` - (Required) The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
2729

28-
- `name` - (Optional) The frontend name used as filter. Frontends with a name like it are listed.
30+
- `name` - (Optional) The frontend name to filter for. Frontends with a matching name are listed.
2931

30-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which frontends exist.
32+
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the frontends exist.
3133

3234
## Attributes Reference
3335

3436
In addition to all arguments above, the following attributes are exported:
3537

36-
- `frontends` - List of found frontends
37-
- `id` - The associated frontend ID.
38-
~> **Important:** LB frontends' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
39-
- `inbound_port` - TCP port the frontend listen to.
40-
- `created_at` - The date at which the frontend was created (RFC 3339 format).
41-
- `update_at` - The date at which the frontend was last updated (RFC 3339 format).
42-
- `backend_id` - The load-balancer backend ID this frontend is attached to.
43-
~> **Important:** LB backends' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
38+
- `frontends` - List of retrieved frontends
39+
- `id` - The ID of the associated frontend.
40+
~> **Important:** LB frontend IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
41+
- `inbound_port` - TCP port the frontend listens to.
42+
- `created_at` - The date on which the frontend was created (RFC 3339 format).
43+
- `update_at` - The date aont which the frontend was last updated (RFC 3339 format).
44+
- `backend_id` - The Load Balancer backend ID this frontend is attached to.
45+
~> **Important:** Load Balancer backend IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
4446
- `timeout_client` - Maximum inactivity time on the client side.
45-
- `certificate_ids` - List of Certificate IDs that are used by the frontend.
46-
- `enable_http3` - If HTTP/3 protocol is activated.
47+
- `certificate_ids` - List of certificate IDs that are used by the frontend.
48+
- `enable_http3` - Whether HTTP/3 protocol is activated.

0 commit comments

Comments
 (0)