Skip to content

Commit e095716

Browse files
authored
doc(lb): update SNI/HTTP host header constraints on Routes (#1972)
* doc(lb): update SNI/HTTP host headers constraints on Routes * fix * lint
1 parent 2444d7a commit e095716

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/resources/lb_route.md

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

66
# scaleway_lb_route
77

8-
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).
9-
It is useful to manage the Service Name Indicator (SNI) for a route between a frontend and a backend.
8+
Creates and manages Scaleway Load-Balancer Routes.
9+
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-route).
1010

1111
## Examples
1212

13-
### With SNI
13+
### With SNI for direction to TCP backends
1414

1515
```hcl
1616
resource "scaleway_lb_ip" "ip01" {}
@@ -41,7 +41,7 @@ resource "scaleway_lb_route" "rt01" {
4141
}
4242
```
4343

44-
### With host-header
44+
### With host-header for direction to HTTP backends
4545

4646
```hcl
4747
resource "scaleway_lb_ip" "ip01" {}
@@ -54,7 +54,7 @@ resource "scaleway_lb" "lb01" {
5454
5555
resource "scaleway_lb_backend" "bkd01" {
5656
lb_id = scaleway_lb.lb01.id
57-
forward_protocol = "tcp"
57+
forward_protocol = "http"
5858
forward_port = 80
5959
proxy_protocol = "none"
6060
}
@@ -78,10 +78,16 @@ The following arguments are supported:
7878

7979
- `backend_id` - (Required) The ID of the backend to which the route is associated.
8080
- `frontend_id` - (Required) The ID of the frontend to which the route is associated.
81-
- `match_sni` - The Server Name Indication TLS extension field from an incoming connection made via an SSL/TLS transport layer.
81+
- `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.
8282
Only one of `match_sni` and `match_host_header` should be specified.
83-
- `match_host_header` - The Host request header specifies the host of the server to which the request is being sent.
83+
84+
~> **Important:** This field should be set for routes on TCP Load Balancers.
85+
86+
- `match_host_header` - The HTTP host header to match. Value to match in the HTTP Host request header from an incoming connection.
8487
Only one of `match_sni` and `match_host_header` should be specified.
88+
89+
~> **Important:** This field should be set for routes on HTTP Load Balancers.
90+
8591
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the load-balancer was created.
8692

8793
## Attributes Reference

0 commit comments

Comments
 (0)