From 5a13ed6077c5f703a72a1f24610f891fcdbea36a Mon Sep 17 00:00:00 2001 From: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> Date: Mon, 17 Jun 2024 14:52:59 +0200 Subject: [PATCH] docs(lb): review lb doc (#2616) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix(lb): review lb doc * Apply suggestions from code review Co-authored-by: Yacine Fodil <105779815+yfodil@users.noreply.github.com> * fix trailing spaces --------- Co-authored-by: Yacine Fodil <105779815+yfodil@users.noreply.github.com> Co-authored-by: Rémy Léone Co-authored-by: Yacine FODIL --- docs/data-sources/lb.md | 20 +++++---- docs/data-sources/lb_acls.md | 30 +++++++------ docs/data-sources/lb_backend.md | 13 +++--- docs/data-sources/lb_backends.md | 44 ++++++++++--------- docs/data-sources/lb_certificate.md | 14 +++--- docs/data-sources/lb_frontend.md | 11 ++--- docs/data-sources/lb_frontends.md | 30 +++++++------ docs/data-sources/lb_ip.md | 15 ++++--- docs/data-sources/lb_ips.md | 22 +++++----- docs/data-sources/lb_route.md | 9 ++-- docs/data-sources/lb_routes.md | 16 ++++--- docs/data-sources/lbs.md | 44 ++++++++++--------- docs/resources/lb.md | 53 ++++++++++++----------- docs/resources/lb_acl.md | 18 ++++---- docs/resources/lb_backend.md | 67 +++++++++++++++-------------- docs/resources/lb_certificate.md | 31 ++++++------- docs/resources/lb_frontend.md | 36 ++++++++-------- docs/resources/lb_ip.md | 19 ++++---- docs/resources/lb_route.md | 19 ++++---- 19 files changed, 270 insertions(+), 241 deletions(-) diff --git a/docs/data-sources/lb.md b/docs/data-sources/lb.md index 78b4f62d1..4949d02a9 100644 --- a/docs/data-sources/lb.md +++ b/docs/data-sources/lb.md @@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb" Gets information about a Load Balancer. +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). + ## Example Usage ```hcl @@ -23,24 +25,24 @@ data "scaleway_lb" "by_id" { ## Argument Reference -- `name` - (Optional) The load balancer name. +- `name` - (Optional) The Load Balancer name. -- `ip_id` - (Optional) The load balancer IP ID. +- `ip_id` - (Optional) The Load Balancer IP ID. -- `project_id` - (Optional) The ID of the project the LB is associated with. +- `project_id` - (Optional) The ID of the Project the Load Balancer is associated with. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the load-balancer. +- `id` - The ID of the Load Balancer. -~> **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` +~> **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` -- `ip_address` - The load-balancer public IP Address. +- `ip_address` - The Load Balancer public IP address. -- `type` - The type of the load-balancer. +- `type` - The Load Balancer type. -- `tags` - The tags associated with the load-balancer. +- `tags` - The tags associated with the Load Balancer. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the LB exists. \ No newline at end of file +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer exists. \ No newline at end of file diff --git a/docs/data-sources/lb_acls.md b/docs/data-sources/lb_acls.md index a5ed78899..e490eb8a1 100644 --- a/docs/data-sources/lb_acls.md +++ b/docs/data-sources/lb_acls.md @@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb_acls" Gets information about multiple Load Balancer ACLs. +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). + ## Example Usage ```hcl @@ -23,33 +25,33 @@ data "scaleway_lb_acls" "byFrontID_and_name" { ## Argument Reference -- `frontend_id` - (Required) The frontend ID this ACL is attached to. ACLs with a frontend ID like it are listed. - ~> **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` +- `frontend_id` - (Required) The frontend ID this ACL is attached to. ACLs with a matching frontend ID are listed. + ~> **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` -- `name` - (Optional) The ACL name used as filter. ACLs with a name like it are listed. +- `name` - (Optional) The ACL name to filter for. ACLs with a matching name are listed. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which ACLs exist. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the ACLs exist. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `acls` - List of found ACLs +- `acls` - List of retrieved ACLs - `id` - The associated ACL ID. ~> **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` - - `created_at` - The date at which the ACL was created (RFC 3339 format). - - `update_at` - The date at which the ACL was last updated (RFC 3339 format). - - `index` - The order between the ACLs. + - `created_at` - The date on which the ACL was created (RFC 3339 format). + - `update_at` - The date on which the ACL was last updated (RFC 3339 format). + - `index` - The priority of this ACL in the ordered list. - `description` - The description of the ACL resource. - - `action` - The action that has been undertaken when an ACL filter had matched. + - `action` - The action to be undertaken when an ACL filter matches. - `type` - The action type. - `redirect` - Redirect parameters when using an ACL with `redirect` action. - `type` - The redirect type. - - `target` - The URL used in case of a location redirect or the scheme name that replaces the request's original scheme. - - `code` - The HTTP redirect code used. + - `target` - The URL used in case of a location redirect, or the scheme name that replaces the request's original scheme. + - `code` - The HTTP redirect code to use. - `match` - The ACL match rule. - - `ip_subnet` - A list of matched IPs or CIDR v4/v6 addresses of the client of the session. - - `http_filter` - The matched HTTP filter. - - `http_filter_value` - The possible values matched for a given HTTP filter. + - `ip_subnet` - A list of IPs, or CIDR v4/v6 addresses of the session client, to match. + - `http_filter` - The HTTP filter to match. + - `http_filter_value` - The possible values to match for a given HTTP filter. - `http_filter_option` - A list of possible values for the HTTP filter based on the HTTP header. - `invert` - The condition will be of type "unless" if invert is set to `true` \ No newline at end of file diff --git a/docs/data-sources/lb_backend.md b/docs/data-sources/lb_backend.md index a431ec015..cee12f508 100644 --- a/docs/data-sources/lb_backend.md +++ b/docs/data-sources/lb_backend.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_backend" # scaleway_lb_backend -Get information about Scaleway Load-Balancer Backends. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends). +Get information about Scaleway Load Balancer backends. + +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). ## Example Usage @@ -41,14 +42,14 @@ data "scaleway_lb_backend" "byName" { The following arguments are supported: -- `backend_id` - (Optional) The backend id. +- `backend_id` - (Optional) The backend ID. - Only one of `name` and `backend_id` should be specified. - `name` - (Optional) The name of the backend. - - When using the `name` you should specify the `lb-id` + - When using `name` you should specify the `lb-id` -- `lb_id` - (Required) The load-balancer ID this backend is attached to. +- `lb_id` - (Required) Load Balancer ID this backend is attached to. ## Attributes Reference -See the [LB Backend Resource](../resources/lb_backend.md) for details on the returned attributes - they are identical. \ No newline at end of file +See the [Load Balancer backend resource](../resources/lb_backend.md) for details on the returned attributes - they are identical. \ No newline at end of file diff --git a/docs/data-sources/lb_backends.md b/docs/data-sources/lb_backends.md index 421c1328c..8a50de5e6 100644 --- a/docs/data-sources/lb_backends.md +++ b/docs/data-sources/lb_backends.md @@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lb_backends" Gets information about multiple Load Balancer Backends. +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). + ## Example Usage ```hcl @@ -23,9 +25,9 @@ data "scaleway_lb_backends" "byLBID_and_name" { ## Argument Reference -- `lb_id` - (Required) The load-balancer ID this backend is attached to. backends with a LB ID like it are listed. +- `lb_id` - (Required) The Load Balancer ID this backend is attached to. Backends with a matching ID are listed. -- `name` - (Optional) The backend name used as filter. Backends with a name like it are listed. +- `name` - (Optional) The backend name to filter for. Backends with a matching name are listed. - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which backends exist. @@ -33,12 +35,12 @@ data "scaleway_lb_backends" "byLBID_and_name" { In addition to all arguments above, the following attributes are exported: -- `backends` - List of found backends +- `backends` - List of retrieved backends - `id` - The associated backend ID. - `forward_protocol` - Backend protocol. - - `created_at` - The date at which the backend was created (RFC 3339 format). - - `update_at` - The date at which the backend was last updated (RFC 3339 format). - - `forward_port` - User sessions will be forwarded to this port of backend servers. + - `created_at` - The date on which the backend was created (RFC 3339 format). + - `update_at` - The date on which the backend was last updated (RFC 3339 format). + - `forward_port` - User sessions will be forwarded to this backend server port. - `forward_port_algorithm` - Load balancing algorithm. - `sticky_sessions` - Enables cookie-based session persistence. - `sticky_sessions_cookie_name` - Cookie name for sticky sessions. @@ -47,23 +49,23 @@ In addition to all arguments above, the following attributes are exported: - `timeout_server` - Maximum server connection inactivity time. - `timeout_connect` - Maximum initial server connection establishment time. - `timeout_tunnel` - Maximum tunnel inactivity time. - - `failover_host` - Scaleway S3 bucket website to be served in case all backend servers are down. - - `ssl_bridging` - Enables SSL between load balancer and backend servers. + - `failover_host` - Scaleway S3 bucket website to be served if all backend servers are down. + - `ssl_bridging` - Enables SSL between Load Balancer and backend servers. - `ignore_ssl_server_verify` - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection. - - `health_check_timeout` - Timeout before we consider a HC request failed. - - `health_check_delay` - Interval between two HC requests. - - `health_check_port` - Port the HC requests will be sent to. - - `health_check_max_retries` - Number of allowed failed HC requests before the backend server is marked down. - - `health_check_tcp` - This block enable TCP health check. - - `health_check_http` - This block enable HTTP health check. - - `uri` - The HTTP endpoint URL to call for HC requests. - - `method` - The HTTP method to use for HC requests. + - `health_check_timeout` - Timeout before a health check request is considered failed. + - `health_check_delay` - Interval between two health check requests. + - `health_check_port` - Port the health check requests will be sent to. + - `health_check_max_retries` - Number of allowed failed health check requests before the backend server is marked as down. + - `health_check_tcp` - This block enables TCP health checks. + - `health_check_http` - This block enables HTTP health checks. + - `uri` - The HTTP endpoint URL to call for health check requests. + - `method` - The HTTP method to use for health check requests. - `code` - The expected HTTP status code. - - `host_header` - The HTTP host header to use for HC requests. - - `health_check_https` - This block enable HTTPS health check. - - `uri` - The HTTPS endpoint URL to call for HC requests. - - `method` - The HTTP method to use for HC requests. + - `host_header` - The HTTP host header to use for health check requests. + - `health_check_https` - This block enables HTTPS health checks. + - `uri` - The HTTPS endpoint URL to call for health check requests. + - `method` - The HTTP method to use for health check requests. - `code` - The expected HTTP status code. - - `host_header` - The HTTP host header to use for HC requests. + - `host_header` - The HTTP host header to use for health check requests. - `sni` - The SNI to use for HC requests over SSL. - `on_marked_down_action` - Modify what occurs when a backend server is marked down. diff --git a/docs/data-sources/lb_certificate.md b/docs/data-sources/lb_certificate.md index 65865938f..62088326b 100644 --- a/docs/data-sources/lb_certificate.md +++ b/docs/data-sources/lb_certificate.md @@ -5,11 +5,11 @@ page_title: "Scaleway: scaleway_lb_certificate" # scaleway_lb_certificate -Get information about Scaleway Load-Balancer Certificates. +Get information about Scaleway Load Balancer certificates. -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. +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. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-certificate). +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). ## Examples @@ -47,14 +47,14 @@ data "scaleway_lb_certificate" "byName" { The following arguments are supported: -- `certificate_id` - (Optional) The certificate id. +- `certificate_id` - (Optional) The certificate ID. - Only one of `name` and `certificate_id` should be specified. -- `name` - (Optional) The name of the certificate backend. +- `name` - (Optional) The name of the Load Balancer certificate. - When using a certificate `name` you should specify the `lb-id` -- `lb_id` - (Required) The load-balancer ID this certificate is attached to. +- `lb_id` - (Required) The Load Balancer ID this certificate is attached to. ## Attributes Reference -See the [LB Certificate Resource](../resources/lb_certificate.md) for details on the returned attributes - they are identical. \ No newline at end of file +See the [Load Balancer certificate resource](../resources/lb_certificate.md) for details on the returned attributes - they are identical. \ No newline at end of file diff --git a/docs/data-sources/lb_frontend.md b/docs/data-sources/lb_frontend.md index 80291fb16..cfa761060 100644 --- a/docs/data-sources/lb_frontend.md +++ b/docs/data-sources/lb_frontend.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontend" # scaleway_lb_frontend -Get information about Scaleway Load-Balancer Frontends. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends). +Get information about Scaleway Load Balancer frontends. + +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). ## Example Usage @@ -43,14 +44,14 @@ data "scaleway_lb_frontend" "byName" { The following arguments are supported: -- `frontend_id` - (Optional) The frontend id. +- `frontend_id` - (Optional) The frontend ID. - Only one of `name` and `frontend_id` should be specified. - `name` - (Optional) The name of the frontend. - When using the `name` you should specify the `lb-id` -- `lb_id` - (Required) The load-balancer ID this frontend is attached to. +- `lb_id` - (Required) The Load Balancer ID this frontend is attached to. ## Attributes Reference -See the [LB Frontend Resource](../resources/lb_frontend.md) for details on the returned attributes - they are identical. \ No newline at end of file +See the [Load Balancer frontend resource](../resources/lb_frontend.md) for details on the returned attributes - they are identical. \ No newline at end of file diff --git a/docs/data-sources/lb_frontends.md b/docs/data-sources/lb_frontends.md index 02786bbed..2985f54de 100644 --- a/docs/data-sources/lb_frontends.md +++ b/docs/data-sources/lb_frontends.md @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontends" # scaleway_lb_frontends -Gets information about multiple Load Balancer Frontends. +Gets information about multiple Load Balancer frontends. + +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). ## Example Usage @@ -23,24 +25,24 @@ data "scaleway_lb_frontends" "byLBID_and_name" { ## Argument Reference -- `lb_id` - (Required) The load-balancer ID this frontend is attached to. frontends with a LB ID like it are listed. +- `lb_id` - (Required) The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed. -- `name` - (Optional) The frontend name used as filter. Frontends with a name like it are listed. +- `name` - (Optional) The frontend name to filter for. Frontends with a matching name are listed. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which frontends exist. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the frontends exist. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `frontends` - List of found frontends - - `id` - The associated frontend ID. - ~> **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` - - `inbound_port` - TCP port the frontend listen to. - - `created_at` - The date at which the frontend was created (RFC 3339 format). - - `update_at` - The date at which the frontend was last updated (RFC 3339 format). - - `backend_id` - The load-balancer backend ID this frontend is attached to. - ~> **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` +- `frontends` - List of retrieved frontends + - `id` - The ID of the associated frontend. + ~> **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` + - `inbound_port` - TCP port the frontend listens to. + - `created_at` - The date on which the frontend was created (RFC 3339 format). + - `update_at` - The date aont which the frontend was last updated (RFC 3339 format). + - `backend_id` - The Load Balancer backend ID this frontend is attached to. + ~> **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` - `timeout_client` - Maximum inactivity time on the client side. - - `certificate_ids` - List of Certificate IDs that are used by the frontend. - - `enable_http3` - If HTTP/3 protocol is activated. + - `certificate_ids` - List of certificate IDs that are used by the frontend. + - `enable_http3` - Whether HTTP/3 protocol is activated. diff --git a/docs/data-sources/lb_ip.md b/docs/data-sources/lb_ip.md index abe211d28..3f579f098 100644 --- a/docs/data-sources/lb_ip.md +++ b/docs/data-sources/lb_ip.md @@ -5,7 +5,10 @@ page_title: "Scaleway: scaleway_lb_ip" # scaleway_lb_ip -Gets information about a Load Balancer IP. +Gets information about a Load Balancer IP address. + +For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/create-manage-flex-ips/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-ip-addresses-list-ip-addresses). + ## Example Usage @@ -31,9 +34,9 @@ The following arguments are supported: - `ip_id` - (Optional) The IP ID. Only one of `ip_address` and `ip_id` should be specified. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the IP should be reserved. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the IP was reserved. -- `project_id` - (Optional) The ID of the project the LB IP associated with. +- `project_id` - (Optional) The ID of the Project the Load Balancer IP is associated with. ## Attributes Reference @@ -41,10 +44,10 @@ In addition to all above arguments, the following attributes are exported: - `id` - The ID of the IP. -~> **Important:** Load-balancers IPs' 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` +~> **Important:** Load Balancers IP 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` - `reverse` - The reverse domain associated with this IP. -- `lb_id` - The associated load-balancer ID if any +- `lb_id` - The ID of the associated Load Balancer, if any -- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the LB IP is associated with. +- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the Organization the Load Balancer IP is associated with. diff --git a/docs/data-sources/lb_ips.md b/docs/data-sources/lb_ips.md index 02fc3874c..b3a2ca3d8 100644 --- a/docs/data-sources/lb_ips.md +++ b/docs/data-sources/lb_ips.md @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_ips" # scaleway_lb_ips -Gets information about multiple Load Balancer IPs. +Gets information about multiple Load Balancer IP addresses. + +For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/create-manage-flex-ips/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-ip-addresses-list-ip-addresses). ## Example Usage @@ -23,19 +25,19 @@ data "scaleway_lb_ips" "my_key" { ## Argument Reference -- `ip_cidr_range` - (Optional) The IP CIDR range used as a filter. IPs within a CIDR block like it are listed. +- `ip_cidr_range` - (Optional) The IP CIDR range to filter for. IPs within a matching CIDR block are listed. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which IPs exist. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the IPs exist. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `ips` - List of found IPs - - `id` - The associated IP ID. - - `lb_id` - The associated load-balancer ID if any - - `ip_address` - The IP Address - - `zone` - The [zone](../guides/regions_and_zones.md#zones) in which the load-balancer is. +- `ips` - List of retrieved IPs + - `id` - The ID of the associated IP. + - `lb_id` - The ID of the associated Load BalancerD, if any + - `ip_address` - The IP address + - `zone` - The [zone](../guides/regions_and_zones.md#zones) of the Load Balancer. - `reverse` - The reverse domain associated with this IP. - - `organization_id` - The organization ID the load-balancer is associated with. - - `project_id` - The ID of the project the load-balancer is associated with. \ No newline at end of file + - `organization_id` - The ID of the Organization the Load Balancer is associated with. + - `project_id` - The ID of the Project the Load Balancer is associated with. \ No newline at end of file diff --git a/docs/data-sources/lb_route.md b/docs/data-sources/lb_route.md index 92fb35345..f9dea5756 100644 --- a/docs/data-sources/lb_route.md +++ b/docs/data-sources/lb_route.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_route" # scaleway_lb_route -Get information about Scaleway Load-Balancer Routes. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-route). +Get information about Scaleway Load Balancer routes. + +For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/create-manage-routes/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-route). ## Example Usage @@ -43,8 +44,8 @@ data "scaleway_lb_route" "byID" { The following argument is supported: -- `route_id` - (Required) The route id. +- `route_id` - (Required) The route ID. ## Attributes Reference -See the [LB Route Resource](../resources/lb_route.md) for details on the returned attributes - they are identical. \ No newline at end of file +See the [Load Balancer route resource](../resources/lb_route.md) for details on the returned attributes - they are identical. \ No newline at end of file diff --git a/docs/data-sources/lb_routes.md b/docs/data-sources/lb_routes.md index 609a62d4e..fea7a4288 100644 --- a/docs/data-sources/lb_routes.md +++ b/docs/data-sources/lb_routes.md @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_routes" # scaleway_lb_routes -Gets information about multiple Load Balancer Routes. +Gets information about multiple Load Balancer routes. + +For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/create-manage-routes/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-route). ## Example Usage @@ -23,18 +25,18 @@ data "scaleway_lb_routes" "my_key" { ## Argument Reference -- `frontend_id` - (Optional) The frontend ID origin of redirection used as a filter. routes with a frontend ID like it are listed. +- `frontend_id` - (Optional) The frontend ID (the origin of the redirection), to filter for. Routes with a matching frontend ID are listed. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which routes exist. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the routes exist. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `routes` - List of found routes +- `routes` - List of retrieved routes - `id` - The associated route ID. - - `backend_id` - The backend ID destination of redirection - - `created_at` - The date at which the route was created (RFC 3339 format). - - `update_at` - The date at which the route was last updated (RFC 3339 format). + - `backend_id` - The backend ID to redirect to + - `created_at` - The date on which the route was created (RFC 3339 format). + - `update_at` - The date on which the route was last updated (RFC 3339 format). - `match_sni` - Server Name Indication TLS extension field from an incoming connection made via an SSL/TLS transport layer. - `match_host_header` - Specifies the host of the server to which the request is being sent. \ No newline at end of file diff --git a/docs/data-sources/lbs.md b/docs/data-sources/lbs.md index ea08de97e..0071674be 100644 --- a/docs/data-sources/lbs.md +++ b/docs/data-sources/lbs.md @@ -7,6 +7,8 @@ page_title: "Scaleway: scaleway_lbs" Gets information about multiple Load Balancers. +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). + ## Example Usage ```hcl @@ -29,33 +31,33 @@ data "scaleway_lbs" "lbs_by_tags" { ## Argument Reference -- `name` - (Optional) The load balancer name used as a filter. LBs with a name like it are listed. +- `name` - (Optional) The Load Balancer name to filter for. Load Balancers with a matching name are listed. -- `tags` - (Optional) List of tags used as filter. LBs with these exact tags are listed. +- `tags` - (Optional) List of tags to filter for. Load Balancers with these exact tags are listed. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which LBs exist. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancers exist. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `lbs` - List of found LBs - - `id` - The ID of the load-balancer. - - `tags` - The tags associated with the load-balancer. - - `description` - The description of the load-balancer. - - `status` - The state of the LB's instance. Possible values are: `unknown`, `ready`, `pending`, `stopped`, `error`, `locked` and `migrating`. - - `zone` - The [zone](../guides/regions_and_zones.md#zones) in which the load-balancer is. - - `name` - The name of the load-balancer. - - `type` - The offer type of the load-balancer. - - `instances` - List of underlying instances. - - `ips` - List of IPs attached to the Load balancer. - - `frontend_count` - Number of frontends the Load balancer has. - - `backend_count` - Number of backends the Load balancer has. - - `private_network_count` - Number of private networks attached to the Load balancer. +- `lbs` - List of retrieved Load Balancers + - `id` - The ID of the Load Balancer. + - `tags` - The tags associated with the Load Balancer. + - `description` - The description of the Load Balancer. + - `status` - The state of the Load Balancer Instance. Possible values are: `unknown`, `ready`, `pending`, `stopped`, `error`, `locked` and `migrating`. + - `zone` - The [zone](../guides/regions_and_zones.md#zones) of the Load Balancer. + - `name` - The name of the Load Balancer. + - `type` - The offer type of the Load Balancer. + - `instances` - List of underlying Instances. + - `ips` - List of IPs attached to the Load Balancer. + - `frontend_count` - Number of frontends the Load Balancer has. + - `backend_count` - Number of backends the Load Balancer has. + - `private_network_count` - Number of Private Networks attached to the Load balancer. - `route_count` - Number of routes the Load balancer has. - `subscriber` - The subscriber information. - - `ssl_compatibility_level` - Determines the minimal SSL version which needs to be supported on client side. - - `created_at` - Date at which the Load balancer was created. - - `updated_at` - Date at which the Load balancer was updated. - - `organization_id` - The organization ID the load-balancer is associated with. - - `project_id` - The ID of the project the load-balancer is associated with. + - `ssl_compatibility_level` - Determines the minimal SSL version which needs to be supported on the client side. + - `created_at` - Date on which the Load Balancer was created. + - `updated_at` - Date on which the Load Balancer was updated. + - `organization_id` - The ID of the Organization the Load Balancer is associated with. + - `project_id` - The ID of the Project the Load Balancer is associated with. diff --git a/docs/resources/lb.md b/docs/resources/lb.md index ad910df6c..23970decd 100644 --- a/docs/resources/lb.md +++ b/docs/resources/lb.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb" # Resource: scaleway_lb -Creates and manages Scaleway Load-Balancers. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api). +Creates and manages Scaleway Load Balancers. + +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). ## Example Usage @@ -124,56 +125,56 @@ The following arguments are supported: - `ip_ids` - (Optional) The List of IP IDs to attach to the Load Balancer. -- `ip_id` - (Deprecated) The ID of the associated LB IP. See below. +- `ip_id` - (Deprecated) The ID of the associated Load Balancer IP. See below. -~> **Important:** Updates to `ip_id` will recreate the load-balancer. +~> **Important:** Updates to `ip_id` will recreate the Load Balancer. -- `type` - (Required) The type of the load-balancer. Please check the [migration section](#migration) to upgrade the type. +- `type` - (Required) The type of the Load Balancer. Please check the [migration section](#migration) to upgrade the type. -- `assign_flexible_ip` - (Optional) Defines whether to automatically assign a flexible public IP to the load-balancer. +- `assign_flexible_ip` - (Optional) Defines whether to automatically assign a flexible public IPv4 to the Load Balancer. -- `assign_flexible_ipv6` - (Optional) Defines whether to automatically assign a flexible public IPv6 to the load-balancer. +- `assign_flexible_ipv6` - (Optional) Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. -- `name` - (Optional) The name of the load-balancer. +- `name` - (Optional) The name of the Load Balancer. -- `description` - (Optional) The description of the load-balancer. +- `description` - (Optional) The description of the Load Balancer. -- `tags` - (Optional) The tags associated with the load-balancers. +- `tags` - (Optional) The tags associated with the Load Balancer. -- `release_ip` - (Defaults to false) The release_ip allow release the ip address associated with the load-balancers. +- `release_ip` - (Defaults to false) The `release_ip` allow the release of the IP address associated with the Load Balancer. - `ssl_compatibility_level` - (Optional) Enforces minimal SSL version (in SSL/TLS offloading context). Please check [possible values](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-load-balancer-create-a-load-balancer). -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the load-balancer. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the Load Balancer. -- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the load-balancer is associated with. +- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Load Balancer is associated with. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the load-balancer. +- `id` - The ID of the Load Balancer. -~> **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` +~> **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` -- `ip_address` - The load-balancer public IPv4 Address. -- `ipv6_address` - The load-balancer public IPv6 Address. -- `organization_id` - The organization ID the load-balancer is associated with. +- `ip_address` - The Load Balancer public IPv4 address. +- `ipv6_address` - The Load Balancer public IPv6 address. +- `organization_id` - The ID of the Organization ID the Load Balancer is associated with. -~> **Important:** `release_ip` will not be supported. This prevents the destruction of the IP from releasing a LBs. +~> **Important:** `release_ip` will not be supported. This prevents the destruction of the IP from releasing a Load Balancer. The `resource_lb_ip` will be the only resource that handles those IPs. ## Migration -In order to migrate to other types you can check the migration up or down via our CLI `scw lb lb-types list`. -this change will not recreate your Load Balancer. +In order to migrate to other Load Balancer types, you can check upwards or downwards migration via our CLI `scw lb lb-types list`. +This change will not recreate your Load Balancer. Please check our [documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-load-balancer-migrate-a-load-balancer) for further details ## IP ID Since v1.15.0, `ip_id` is a required field. This means that now a separate `scaleway_lb_ip` is required. -When importing, the IP needs to be imported as well as the LB. +When importing, the IP needs to be imported as well as the Load Balancer. When upgrading to v1.15.0, you will need to create a new `scaleway_lb_ip` resource and import it. For instance, if you had the following: @@ -201,22 +202,22 @@ resource "scaleway_lb" "main" { ## Attributes Reference -- `private_network_id` - (Required) The ID of the Private Network to associate. +- `private_network_id` - (Required) The ID of the Private Network to attach to. - ~> **Important:** Updates to `private_network` will recreate the attachment. - `static_config` - (Deprecated) Please use `dhcp_config`. Define a local ip address of your choice for the load balancer instance. -- `dhcp_config` - (Optional) Set to true if you want to let DHCP assign IP addresses. See below. +- `dhcp_config` - (Optional) Set to `true` if you want to let DHCP assign IP addresses. See below. ~> **Important:** Only dhcp_config may be set. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the private network was created. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Private Network was created. ## Import -Load-Balancer can be imported using the `{zone}/{id}`, e.g. +Load Balancers can be imported using `{zone}/{id}`, e.g. ```bash $ terraform import scaleway_lb.main fr-par-1/11111111-1111-1111-1111-111111111111 diff --git a/docs/resources/lb_acl.md b/docs/resources/lb_acl.md index 17ed08e0c..fe6b49410 100644 --- a/docs/resources/lb_acl.md +++ b/docs/resources/lb_acl.md @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_acl" # Resource: scaleway_lb_acl -Creates and manages Scaleway Load-Balancer ACLs. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-acls). +Creates and manages Scaleway Load Balancer ACLs. + +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). ## Example Usage @@ -31,13 +33,13 @@ resource "scaleway_lb_acl" "acl01" { The following arguments are supported: -- `frontend_id` - (Required) The load-balancer Frontend ID to attach the ACL to. +- `frontend_id` - (Required) The ID of the Load Balancer frontend to attach the ACL to. - `name` - (Optional) The ACL name. If not provided it will be randomly generated. - `description` - (Optional) The ACL description. -- `index` - (Required) The Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). +- `index` - (Required) The priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). - `action` - (Required) Action to undertake when an ACL filter matches. @@ -53,14 +55,14 @@ The following arguments are supported: - `match` - (Required) The ACL match rule. At least `ip_subnet` or `http_filter` and `http_filter_value` are required. - - `ip_subnet` - (Optional) A list of IPs or CIDR v4/v6 addresses of the client of the session to match. + - `ip_subnet` - (Optional) A list of IPs, or CIDR v4/v6 addresses of the session client, to match. - `http_filter` - (Optional) The HTTP filter to match. This filter is supported only if your backend protocol has an HTTP forward protocol. It extracts the request's URL path, which starts at the first slash and ends before the question mark (without the host part). Possible values are: `acl_http_filter_none`, `path_begin`, `path_end`, `http_header_match` or `regex`. - `http_filter_value` - (Optional) A list of possible values to match for the given HTTP filter. - Keep in mind that in the case of `http_header_match` the HTTP header field name is case-insensitive. + Keep in mind that in the case of `http_header_match` the HTTP header field name is case insensitive. - `http_filter_option` - (Optional) If you have `http_filter` at `http_header_match`, you can use this field to filter on the HTTP header's value. @@ -70,14 +72,14 @@ The following arguments are supported: In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the load-balancer ACL. +- `id` - The ID of the Load Balancer ACL. -~> **Important:** Load-Balancers 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` +~> **Important:** Load-Balancer ACL 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` ## Import -Load-Balancer ACL can be imported using the `{zone}/{id}`, e.g. +Load Balancer ACLs can be imported using `{zone}/{id}`, e.g. ```bash $ terraform import scaleway_lb_acl.acl01 fr-par-1/11111111-1111-1111-1111-111111111111 diff --git a/docs/resources/lb_backend.md b/docs/resources/lb_backend.md index f84df2acb..439c0ab89 100644 --- a/docs/resources/lb_backend.md +++ b/docs/resources/lb_backend.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_backend" # Resource: scaleway_lb_backend -Creates and manages Scaleway Load-Balancer Backends. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-backends). +Creates and manages Scaleway Load Balancer backends. + +or 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). ## Example Usage @@ -42,53 +43,53 @@ The following arguments are supported: ### Basic arguments -- `lb_id` - (Required) The load-balancer ID this backend is attached to. +- `lb_id` - (Required) The ID of the Load Balancer this backend is attached to. ~> **Important:** Updates to `lb_id` will recreate the backend. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the load-balancer was created. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer was created. - `forward_protocol` - (Required) Backend protocol. Possible values are: `tcp` or `http`. -- `name` - (Optional) The name of the load-balancer backend. +- `name` - (Optional) The name of the Load Balancer backend. - `forward_port` - (Required) User sessions will be forwarded to this port of backend servers. - `forward_port_algorithm` - (Default: `roundrobin`) Load balancing algorithm. Possible values are: `roundrobin`, `leastconn` and `first`. -- `sticky_sessions` - (Default: `none`) The type of sticky sessions. The only current possible values are: `none`, `cookie` and `table`. -- `sticky_sessions_cookie_name` - (Optional) Cookie name for sticky sessions. Only applicable when sticky_sessions is set to `cookie`. +- `sticky_sessions` - (Default: `none`) The type of sticky session. Possible values are: `none`, `cookie` and `table`. +- `sticky_sessions_cookie_name` - (Optional) Cookie name for sticky sessions. Only applicable when `sticky_sessions` is set to `cookie`. - `server_ips` - (Optional) List of backend server IP addresses. Addresses can be either IPv4 or IPv6. - `send_proxy_v2` - DEPRECATED please use `proxy_protocol` instead - (Default: `false`) Enables PROXY protocol version 2. -- `proxy_protocol` - (Default: `none`) Choose the type of PROXY protocol to enable (`none`, `v1`, `v2`, `v2_ssl`, `v2_ssl_cn`) -- `timeout_server` - (Optional) Maximum server connection inactivity time. (e.g.: `1s`) -- `timeout_connect` - (Optional) Maximum initial server connection establishment time. (e.g.: `1s`) -- `timeout_tunnel` - (Optional) Maximum tunnel inactivity time. (e.g.: `1s`) -- `failover_host` - (Optional) Scaleway S3 bucket website to be served in case all backend servers are down. +- `proxy_protocol` - (Default: `none`) The type of PROXY protocol to enable (`none`, `v1`, `v2`, `v2_ssl`, `v2_ssl_cn`) +- `timeout_server` - (Optional) Maximum server connection inactivity time. (e.g. `1s`) +- `timeout_connect` - (Optional) Maximum initial server connection establishment time. (e.g. `1s`) +- `timeout_tunnel` - (Optional) Maximum tunnel inactivity time. (e.g. `1s`) +- `failover_host` - (Optional) Scaleway S3 bucket website to be served if all backend servers are down. ~> **Note:** Only the host part of the Scaleway S3 bucket website is expected: e.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'. -- `ssl_bridging` - (Default: `false`) Enables SSL between load balancer and backend servers. +- `ssl_bridging` - (Default: `false`) Enables SSL between the Load Balancer and its backend servers. - `ignore_ssl_server_verify` - (Default: `false`) Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection. - `max_connections` - (Optional) Maximum number of connections allowed per backend server. - `timeout_queue` - (Optional) Maximum time for a request to be left pending in queue when `max_connections` is reached. (e.g.: `1s`) - `redispatch_attempt_count` - (Optional) Whether to use another backend server on each attempt. -- `max_retries` - (Optional) Number of retries when a backend server connection failed. +- `max_retries` - (Optional) Number of retries when a backend server connection fails. ### Health Check arguments -Backends use Health Check to test if a backend server is ready to receive requests. +Backends use health checks to test if a backend server is ready to receive requests. You may use one of the following health check types: `TCP`, `HTTP` or `HTTPS`. (Default: `TCP`) -- `health_check_timeout` - (Default: `30s`) Timeout before we consider a HC request failed. -- `health_check_delay` - (Default: `60s`) Interval between two HC requests. -- `health_check_port` - (Default: `forward_port`) Port the HC requests will be send to. -- `health_check_max_retries` - (Default: `2`) Number of allowed failed HC requests before the backend server is marked down. -- `health_check_tcp` - (Optional) This block enable TCP health check. Only one of `health_check_tcp`, `health_check_http` and `health_check_https` should be specified. -- `health_check_http` - (Optional) This block enable HTTP health check. Only one of `health_check_tcp`, `health_check_http` and `health_check_https` should be specified. - - `uri` - (Required) The HTTP endpoint URL to call for HC requests. - - `method` - (Default: `GET`) The HTTP method to use for HC requests. +- `health_check_timeout` - (Default: `30s`) Timeout before we consider a health check request failed. +- `health_check_delay` - (Default: `60s`) Interval between two health check requests. +- `health_check_port` - (Default: `forward_port`) Port the health check requests will be sent to. +- `health_check_max_retries` - (Default: `2`) Number of allowed failed health check requests before the backend server is marked as down. +- `health_check_tcp` - (Optional) This block enables TCP health checks. Only one of `health_check_tcp`, `health_check_http` and `health_check_https` should be specified. +- `health_check_http` - (Optional) This block enables HTTP health checks. Only one of `health_check_tcp`, `health_check_http` and `health_check_https` should be specified. + - `uri` - (Required) The HTTP endpoint URL to call for health check requests. + - `method` - (Default: `GET`) The HTTP method to use for health check requests. - `code` - (Default: `200`) The expected HTTP status code. - - `host_header` - (Optional) The HTTP host header to use for HC requests. -- `health_check_https` - (Optional) This block enable HTTPS health check. Only one of `health_check_tcp`, `health_check_http` and `health_check_https` should be specified. - - `uri` - (Required) The HTTPS endpoint URL to call for HC requests. - - `method` - (Default: `GET`) The HTTP method to use for HC requests. + - `host_header` - (Optional) The HTTP host header to use for health check requests. +- `health_check_https` - (Optional) This block enable HTTPS health checks. Only one of `health_check_tcp`, `health_check_http` and `health_check_https` should be specified. + - `uri` - (Required) The HTTPS endpoint URL to call for health check requests. + - `method` - (Default: `GET`) The HTTP method to use for health check requests. - `code` - (Default: `200`) The expected HTTP status code. - - `host_header` - (Optional) The HTTP host header to use for HC requests. - - `sni` - (Optional) The SNI to use for HC requests over SSL. -- `on_marked_down_action` - (Default: `none`) Modify what occurs when a backend server is marked down. Possible values are: `none` and `shutdown_sessions`. + - `host_header` - (Optional) The HTTP host header to use for health check requests. + - `sni` - (Optional) The SNI to use for health check requests over SSL. +- `on_marked_down_action` - (Default: `none`) Specify what action to take when a backend server is marked down. Possible values are: `none` and `shutdown_sessions`. - `health_check_transient_delay` - (Default: `0.5s`) The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). - `health_check_send_proxy` - (Default: `false`) Defines whether proxy protocol should be activated for the health check. @@ -96,13 +97,13 @@ You may use one of the following health check types: `TCP`, `HTTP` or `HTTPS`. ( In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the loadbalancer backend. +- `id` - The ID of the Load Balancer backend. -~> **Important:** Load-Balancers 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` +~> **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` ## Import -Load-Balancer backend can be imported using the `{zone}/{id}`, e.g. +Load Balancer backends can be imported using `{zone}/{id}`, e.g. ```bash $ terraform import scaleway_lb_backend.backend01 fr-par-1/11111111-1111-1111-1111-111111111111 diff --git a/docs/resources/lb_certificate.md b/docs/resources/lb_certificate.md index d869f7a72..c774aba68 100644 --- a/docs/resources/lb_certificate.md +++ b/docs/resources/lb_certificate.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_certificate" # Resource: scaleway_lb_certificate -Creates and manages Scaleway Load-Balancer Certificates. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-certificate). +Creates and manages Scaleway Load Balancer certificates. + +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). ## Example Usage @@ -51,25 +52,25 @@ The following arguments are supported: ### Basic arguments -- `lb_id` - (Required) The load-balancer ID this certificate is attached to. +- `lb_id` - (Required) The ID of the Load Balancer this certificate is attached to. -~> **Important:** Updates to `lb_id` will recreate the load-balancer certificate. +~> **Important:** Updates to `lb_id` will recreate the Load Balancer certificate. - `name` - (Optional) The name of the certificate backend. -- `letsencrypt` - (Optional) Configuration block for Let's Encrypt configuration. Only one of `letsencrypt` and `custom_certificate` should be specified. +- `letsencrypt` - (Optional) Block for Let's Encrypt configuration. Only one of `letsencrypt` and `custom_certificate` should be specified. - `common_name` - (Required) Main domain of the certificate. A new certificate will be created if this field is changed. - - `subject_alternative_name` - (Optional) Array of alternative domain names. A new certificate will be created if this field is changed. + - `subject_alternative_name` - (Optional) Array of alternative domain names. A new certificate will be created if this field is changed. -~> **Important:** Updates to `letsencrypt` will recreate the load-balancer certificate. +~> **Important:** Updates to `letsencrypt` will recreate the Load Balancer certificate. -- `custom_certificate` - (Optional) Configuration block for custom certificate chain. Only one of `letsencrypt` and `custom_certificate` should be specified. +- `custom_certificate` - (Optional) Block for custom certificate chain configuration. Only one of `letsencrypt` and `custom_certificate` should be specified. - `certificate_chain` - (Required) Full PEM-formatted certificate chain. -~> **Important:** Updates to `custom_certificate` will recreate the load-balancer certificate. +~> **Important:** Updates to `custom_certificate` will recreate the Load Balancer certificate. - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the certificate. @@ -77,7 +78,7 @@ The following arguments are supported: In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the load-balancer certificate. +- `id` - The ID of the Load Balancer certificate. ~> **Important:** Load-Balancers certificates' 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` @@ -90,9 +91,9 @@ In addition to all arguments above, the following attributes are exported: ## Additional notes -* Ensure that all domain names used in configuration are pointing to the load balancer IP. - You can achieve this by creating a DNS record through terraform pointing to `ip_address` property of `lb_beta` entity. -* In case there are any issues with the certificate, you will receive a `400` error from the `apply` operation. - Use `export TF_LOG=DEBUG` to view exact problem returned by the api. -* Wildcards are not supported with Let's Encrypt yet. +* Ensure that all domain names used in the configuration are pointing to the Load Balancer IP. + You can achieve this by creating a DNS record through Terraform pointing to the `ip_address` property of the `lb_beta` entity. +* If there are any issues with the certificate, you will receive a `400` error from the `apply` operation. + Use `export TF_LOG=DEBUG` to view the exact problem returned by the API. +* Wildcards are not yet supported with Let's Encrypt. * Use `lifecycle` instruction with `create_before_destroy = true` to permit correct certificate replacement and prevent a `400` error from the `apply` operation. diff --git a/docs/resources/lb_frontend.md b/docs/resources/lb_frontend.md index 42fc97414..83d993e9a 100644 --- a/docs/resources/lb_frontend.md +++ b/docs/resources/lb_frontend.md @@ -5,7 +5,9 @@ page_title: "Scaleway: scaleway_lb_frontend" # Resource: scaleway_lb_frontend -Creates and manages Scaleway Load-Balancer Frontends. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends). +Creates and manages Scaleway Load Balancer frontends. + +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). ## Example Usage @@ -149,27 +151,27 @@ resource "scaleway_lb_frontend" "frontend01" { The following arguments are supported: -- `lb_id` - (Required) The load-balancer ID this frontend is attached to. +- `lb_id` - (Required) The ID of the Load Balancer this frontend is attached to. -- `backend_id` - (Required) The load-balancer backend ID this frontend is attached to. +- `backend_id` - (Required) The ID of the Load Balancer backend this frontend is attached to. ~> **Important:** Updates to `lb_id` or `backend_id` will recreate the frontend. -- `inbound_port` - (Required) TCP port to listen on the front side. +- `inbound_port` - (Required) TCP port to listen to on the front side. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the load-balancer was created. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer was created. -- `name` - (Optional) The name of the load-balancer frontend. +- `name` - (Optional) The name of the Load Balancer frontend. -- `timeout_client` - (Optional) Maximum inactivity time on the client side. (e.g.: `1s`) +- `timeout_client` - (Optional) Maximum inactivity time on the client side. (e.g. `1s`) -- `certificate_ids` - (Optional) List of Certificate IDs that should be used by the frontend. +- `certificate_ids` - (Optional) List of certificate IDs that should be used by the frontend. ~> **Important:** Certificates are not allowed on port 80. - `enable_http3` - (Default: `false`) Activates HTTP/3 protocol. -- `acl` - (Optional) A list of ACL rules to apply to the load-balancer frontend. Defined below. +- `acl` - (Optional) A list of ACL rules to apply to the Load Balancer frontend. Defined below. ## acl @@ -183,42 +185,42 @@ The following arguments are supported: - `type` - (Optional) The redirect type. Possible values are: `location` or `scheme`. - - `target` - (Optional) An URL can be used in case of a location redirect (e.g. `https://scaleway.com` will redirect to this same URL). A scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. + - `target` - (Optional) A URL can be used in case of a location redirect (e.g. `https://scaleway.com` will redirect to this same URL). A scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. - `code` - (Optional) The HTTP redirect code to use. Valid values are `301`, `302`, `303`, `307` and `308`. - `match` - (Required) The ACL match rule. At least `ip_subnet` or `http_filter` and `http_filter_value` are required. - - `ip_subnet` - (Optional) A list of IPs or CIDR v4/v6 addresses of the client of the session to match. + - `ip_subnet` - (Optional) A list of IPs, or CIDR v4/v6 addresses of the session client, to match. - `http_filter` - (Optional) The HTTP filter to match. This filter is supported only if your backend protocol has an HTTP forward protocol. It extracts the request's URL path, which starts at the first slash and ends before the question mark (without the host part). Possible values are: `acl_http_filter_none`, `path_begin`, `path_end`, `http_header_match` or `regex`. - `http_filter_value` - (Optional) A list of possible values to match for the given HTTP filter. - Keep in mind that in the case of `http_header_match` the HTTP header field name is case-insensitive. + Keep in mind that in the case of `http_header_match` the HTTP header field name is case insensitive. - `http_filter_option` - (Optional) If you have `http_filter` at `http_header_match`, you can use this field to filter on the HTTP header's value. - `invert` - (Optional) If set to `true`, the condition will be of type "unless". - `external_acls` - (Defaults to `false`) A boolean to specify whether to use [lb_acl](../resources/lb_acl.md). - If `external_acls` is set to `true`, `acl` can not be set directly in the lb frontend. + If `external_acls` is set to `true`, `acl` can not be set directly in the Load Balancer frontend. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the load-balancer frontend. +- `id` - The ID of the Load Balancer frontend. -~> **Important:** Load-Balancers 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` +~> **Important:** Load Balancer 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` -- `certificate_id` - (Deprecated) first certificate ID used by the frontend. +- `certificate_id` - (Deprecated) First certificate ID used by the frontend. ## Import -Load-Balancer frontend can be imported using the `{zone}/{id}`, e.g. +Load Balancer frontends can be imported using `{zone}/{id}`, e.g. ```bash $ terraform import scaleway_lb_frontend.frontend01 fr-par-1/11111111-1111-1111-1111-111111111111 diff --git a/docs/resources/lb_ip.md b/docs/resources/lb_ip.md index 686a2bed1..24e2e4a61 100644 --- a/docs/resources/lb_ip.md +++ b/docs/resources/lb_ip.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_ip" # Resource: scaleway_lb_ip -Creates and manages Scaleway Load-Balancers IPs. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-ip-addresses). +Creates and manages Scaleway Load Balancer IP addresses. + +For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/create-manage-flex-ips/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-ip-addresses-list-ip-addresses). ## Example Usage @@ -31,24 +32,24 @@ resource "scaleway_lb_ip" "ipv6" { The following arguments are supported: - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the IP should be reserved. -- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the IP is associated with. +- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the IP is associated with. - `reverse` - (Optional) The reverse domain associated with this IP. -- `is_ipv6` - (Optional) If true, creates a Flexible IP with an IPv6 address. +- `is_ipv6` - (Optional) If true, creates a flexible IP with an IPv6 address. ## Attributes Reference In addition to all arguments above, the following attributes are exported: -- `id` - The ID of the IP +- `id` - The ID of the IP address -~> **Important:** Load-Balancers IPs' 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` +~> **Important:** Load-Balancer IP 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` -- `lb_id` - The associated load-balance ID if any -- `ip_address` - The IP Address +- `lb_id` - The associated Load Balancer ID if any +- `ip_address` - The IP address ## Import -IPs can be imported using the `{zone}/{id}`, e.g. +IPs can be imported using `{zone}/{id}`, e.g. ```bash $ terraform import scaleway_lb_ip.ip01 fr-par-1/11111111-1111-1111-1111-111111111111 diff --git a/docs/resources/lb_route.md b/docs/resources/lb_route.md index aad37ec3a..38409c9d5 100644 --- a/docs/resources/lb_route.md +++ b/docs/resources/lb_route.md @@ -5,8 +5,9 @@ page_title: "Scaleway: scaleway_lb_route" # Resource: scaleway_lb_route -Creates and manages Scaleway Load-Balancer Routes. -For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-route). +Creates and manages Scaleway Load Balancer routes. + +For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/how-to/create-manage-routes/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-route). ## Example Usage @@ -76,8 +77,8 @@ resource "scaleway_lb_route" "rt01" { The following arguments are supported: -- `backend_id` - (Required) The ID of the backend to which the route is associated. -- `frontend_id` - (Required) The ID of the frontend to which the route is associated. +- `backend_id` - (Required) The ID of the backend the route is associated with. +- `frontend_id` - (Required) The ID of the frontend the route is associated with. - `match_sni` - The Server Name Indication (SNI) value to match. Value to match in the Server Name Indication TLS extension (SNI) field from an incoming connection made via an SSL/TLS transport layer. Only one of `match_sni` and `match_host_header` should be specified. @@ -88,7 +89,7 @@ The following arguments are supported: ~> **Important:** This field should be set for routes on HTTP Load Balancers. -- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the load-balancer was created. +- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer was created. ## Attributes Reference @@ -96,14 +97,14 @@ In addition to all arguments above, the following attributes are exported: - `id` - The ID of the route -~> **Important:** Load-balancers routes' 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` +~> **Important:** Load balancer route 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` -- `created_at` - The date at which the route was created. -- `updated_at` - The date at which the route was last updated. +- `created_at` - The date on which the route was created. +- `updated_at` - The date on which the route was last updated. ## Import -Load-Balancer frontend can be imported using the `{zone}/{id}`, e.g. +Load Balancer frontends can be imported using `{zone}/{id}`, e.g. ```bash $ terraform import scaleway_lb_route.main fr-par-1/11111111-1111-1111-1111-111111111111