Skip to content

Commit e1cce41

Browse files
authored
docs(lb): clean up doc (#2814)
* docs(lb): clean up doc * lint * fix dead links
1 parent 6f6860e commit e1cce41

File tree

3 files changed

+20
-132
lines changed

3 files changed

+20
-132
lines changed

docs/resources/container_namespace.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ page_title: "Scaleway: scaleway_container_namespace"
88
The `scaleway_container_namespace` resource allows you to
99
for Scaleway [Serverless Containers](https://www.scaleway.com/en/docs/serverless/containers/).
1010

11-
Refer to the Containers namespace [documentation](https://www.scaleway.com/en/docs/serverless/containers/how-to/create-a-containers-namespace/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#path-namespaces-list-all-your-namespaces) for more information.
11+
Refer to the Containers namespace [documentation](https://www.scaleway.com/en/docs/serverless/containers/how-to/create-manage-delete-containers-namespace/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#path-namespaces-list-all-your-namespaces) for more information.
1212

1313
## Example Usage
1414

docs/resources/function_namespace.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ page_title: "Scaleway: scaleway_function_namespace"
88
The `scaleway_function_namespace` resource allows you to
99
for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
1010

11-
Refer to the Functions namespace [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/create-a-functions-namespace/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-namespaces-list-all-your-namespaces) for more information.
11+
Refer to the Functions namespace [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/create-manage-delete-functions-namespace/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-namespaces-list-all-your-namespaces) for more information.
1212

1313
## Example Usage
1414

docs/resources/lb.md

+18-130
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ resource "scaleway_lb_ip" "main" {
1919
}
2020
2121
resource "scaleway_lb" "base" {
22-
ip_ids = [scaleway_lb_ip.main.id]
23-
zone = scaleway_lb_ip.main.zone
24-
type = "LB-S"
22+
ip_ids = [scaleway_lb_ip.main.id]
23+
zone = scaleway_lb_ip.main.zone
24+
type = "LB-S"
2525
}
2626
```
2727

@@ -44,7 +44,7 @@ resource "scaleway_lb_ip" "v4" {
4444
resource "scaleway_lb_ip" "v6" {
4545
is_ipv6 = true
4646
}
47-
resource scaleway_lb main {
47+
resource "scaleway_lb" "main" {
4848
ip_ids = [scaleway_lb_ip.v4.id, scaleway_lb_ip.v6.id]
4949
name = "ipv6-lb"
5050
type = "LB-S"
@@ -75,86 +75,18 @@ resource "scaleway_ipam_ip" "ip01" {
7575
resource "scaleway_lb_ip" "v4" {
7676
}
7777
78-
resource scaleway_lb main {
78+
resource "scaleway_lb" "lb01" {
7979
ip_ids = [scaleway_lb_ip.v4.id]
8080
name = "my-lb"
8181
type = "LB-S"
8282
8383
private_network {
8484
private_network_id = scaleway_vpc_private_network.pn01.id
85-
ipam_ids = [scaleway_ipam_ip.ip01.id]
85+
ipam_ids = [scaleway_ipam_ip.ip01.id]
8686
}
8787
}
8888
```
8989

90-
### Multiple configurations
91-
92-
```terraform
93-
### IP for Public Gateway
94-
resource "scaleway_vpc_public_gateway_ip" "main" {
95-
}
96-
97-
### Scaleway Private Network
98-
resource scaleway_vpc_private_network main {
99-
}
100-
101-
### VPC Public Gateway Network
102-
resource "scaleway_vpc_public_gateway" "main" {
103-
name = "tf-test-public-gw"
104-
type = "VPC-GW-S"
105-
ip_id = scaleway_vpc_public_gateway_ip.main.id
106-
}
107-
108-
### VPC Public Gateway Network DHCP config
109-
resource "scaleway_vpc_public_gateway_dhcp" "main" {
110-
subnet = "10.0.0.0/24"
111-
}
112-
113-
### VPC Gateway Network
114-
resource "scaleway_vpc_gateway_network" "main" {
115-
gateway_id = scaleway_vpc_public_gateway.main.id
116-
private_network_id = scaleway_vpc_private_network.main.id
117-
dhcp_id = scaleway_vpc_public_gateway_dhcp.main.id
118-
cleanup_dhcp = true
119-
enable_masquerade = true
120-
}
121-
122-
### Scaleway Instance
123-
resource "scaleway_instance_server" "main" {
124-
name = "Scaleway Terraform Provider"
125-
type = "DEV1-S"
126-
image = "debian_bullseye"
127-
enable_ipv6 = false
128-
129-
private_network {
130-
pn_id = scaleway_vpc_private_network.main.id
131-
}
132-
}
133-
134-
### IP for LB IP
135-
resource scaleway_lb_ip main {
136-
}
137-
138-
### Scaleway Private Network
139-
resource scaleway_vpc_private_network "main" {
140-
name = "private network with DHCP config"
141-
}
142-
143-
### Scaleway Load Balancer
144-
resource scaleway_lb main {
145-
ip_id = scaleway_lb_ip.main.id
146-
name = "MyTest"
147-
type = "LB-S"
148-
149-
private_network {
150-
private_network_id = scaleway_vpc_private_network.main.id
151-
dhcp_config = true
152-
}
153-
154-
depends_on = [scaleway_vpc_public_gateway.main]
155-
}
156-
```
157-
15890
## Argument Reference
15991

16092
The following arguments are supported:
@@ -163,29 +95,26 @@ The following arguments are supported:
16395

16496
~> **Important:** Make sure to use a [`scaleway_lb_ip`](./lb_ip.md) resource to create the IPs.
16597

166-
- `ip_id` - (Deprecated) The ID of the associated Load Balancer IP. See below.
98+
- `ip_id` - (Deprecated) Please use `ip_ids`. The ID of the associated Load Balancer IP. See below.
16799

168100
~> **Important:** Updates to `ip_id` will recreate the Load Balancer.
169101

170102
- `type` - (Required) The type of the Load Balancer. Please check the [migration section](#migration) to upgrade the type.
171-
172103
- `assign_flexible_ip` - (Optional) Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
173-
174104
- `assign_flexible_ipv6` - (Optional) Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
175-
176105
- `name` - (Optional) The name of the Load Balancer.
177-
178106
- `description` - (Optional) The description of the Load Balancer.
179-
180107
- `tags` - (Optional) The tags associated with the Load Balancer.
181-
182-
- `release_ip` - (Defaults to false) The `release_ip` allow the release of the IP address associated with the Load Balancer.
183-
108+
- `private_network` - (Optional) List of private network to connect with your load balancer.
109+
- `private_network_id` - (Required) The ID of the Private Network to attach to.
110+
- ~> **Important:** Updates to `private_network` will recreate the attachment.
111+
- `ipam_ids` - (Optional) IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
112+
- `dhcp_config` - (Deprecated) Please use `ipam_ids`. Set to `true` if you want to let DHCP assign IP addresses.
113+
- `static_config` - (Deprecated) Please use `ipam_ids`. Define a local ip address of your choice for the load balancer instance.
184114
- `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).
185-
186115
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the Load Balancer.
187-
188116
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Load Balancer is associated with.
117+
- `release_ip` - (Deprecated) The `release_ip` allow the release of the IP address associated with the Load Balancer.
189118

190119
## Attributes Reference
191120

@@ -197,6 +126,9 @@ In addition to all arguments above, the following attributes are exported:
197126

198127
- `ip_address` - The Load Balancer public IPv4 address.
199128
- `ipv6_address` - The Load Balancer public IPv6 address.
129+
- `private_network` - List of private networks connected to your load balancer.
130+
- `status` - The status of the private network connection.
131+
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the private network was created.
200132
- `organization_id` - The ID of the Organization ID the Load Balancer is associated with.
201133

202134
~> **Important:** `release_ip` will not be supported. This prevents the destruction of the IP from releasing a Load Balancer.
@@ -207,51 +139,7 @@ The `resource_lb_ip` will be the only resource that handles those IPs.
207139
In order to migrate to other Load Balancer types, you can check upwards or downwards migration via our CLI `scw lb lb-types list`.
208140
This change will not recreate your Load Balancer.
209141

210-
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
211-
212-
## IP ID
213-
214-
Since v1.15.0, `ip_id` is a required field. This means that now a separate `scaleway_lb_ip` is required.
215-
When importing, the IP needs to be imported as well as the Load Balancer.
216-
When upgrading to v1.15.0, you will need to create a new `scaleway_lb_ip` resource and import it.
217-
218-
For instance, if you had the following:
219-
220-
```terraform
221-
resource "scaleway_lb" "main" {
222-
zone = "fr-par-1"
223-
type = "LB-S"
224-
}
225-
```
226-
227-
You will need to update it to:
228-
229-
```terraform
230-
resource "scaleway_lb_ip" "main" {
231-
}
232-
233-
resource "scaleway_lb" "main" {
234-
ip_id = scaleway_lb_ip.main.id
235-
zone = "fr-par-1"
236-
type = "LB-S"
237-
release_ip = false
238-
}
239-
```
240-
241-
## Attributes Reference
242-
243-
- `private_network_id` - (Required) The ID of the Private Network to attach to.
244-
245-
- ~> **Important:** Updates to `private_network` will recreate the attachment.
246-
247-
- `ipam_ids` - (Optional) IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
248-
249-
- `dhcp_config` - (Deprecated) Please use `ipam_ids`. Set to `true` if you want to let DHCP assign IP addresses. See below.
250-
251-
- `static_config` - (Deprecated) Please use `ipam_ids`. Define a local ip address of your choice for the load balancer instance.
252-
253-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Private Network was created.
254-
142+
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.
255143

256144
## Import
257145

0 commit comments

Comments
 (0)