Skip to content

Commit df949f0

Browse files
authored
chore(docs): use smallest type for each example (#723)
1 parent 0e2330e commit df949f0

15 files changed

+202
-198
lines changed

docs/resources/baremetal_server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ data "scaleway_account_ssh_key" "main" {
1919
2020
resource "scaleway_baremetal_server" "base" {
2121
zone = "fr-par-2"
22-
offer = "GP-BM1-M"
22+
offer = "GP-BM1-S"
2323
os = "d17d6872-0412-45d9-a198-af82c34d3c5c"
2424
ssh_key_ids = [data.scaleway_account_ssh_key.main]
2525
}

docs/resources/instance_ip_reverse_dns.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Manages Scaleway Compute Instance IPs Reverse DNS.
1212

1313
```hcl
1414
resource "scaleway_instance_ip" "server_ip" {}
15+
1516
resource "scaleway_instance_ip_reverse_dns" "reverse" {
16-
ip_id = scaleway_instance_ip.server_ip.id
17+
ip_id = scaleway_instance_ip.server_ip.id
1718
reverse = "www.scaleway.com"
1819
}
1920
```

docs/resources/instance_security_group.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ resource "scaleway_instance_security_group" "allow_all" {
1818
1919
resource "scaleway_instance_security_group" "web" {
2020
inbound_default_policy = "drop" # By default we drop incoming traffic that do not match any inbound_rule
21-
21+
2222
inbound_rule {
2323
action = "accept"
24-
port = 22
25-
ip = "212.47.225.64"
24+
port = 22
25+
ip = "212.47.225.64"
2626
}
27-
27+
2828
inbound_rule {
2929
action = "accept"
30-
port = 80
30+
port = 80
3131
}
32-
32+
3333
inbound_rule {
34-
action = "accept"
35-
protocol = "UDP"
34+
action = "accept"
35+
protocol = "UDP"
3636
port_range = "22-23"
3737
}
3838
}
@@ -42,28 +42,28 @@ resource "scaleway_instance_security_group" "web" {
4242

4343
```hcl
4444
resource "scaleway_instance_security_group" "web" {
45-
inbound_default_policy = "drop" # By default we drop incoming traffic that do not match any inbound_rule.
45+
inbound_default_policy = "drop" # By default we drop incoming traffic that do not match any inbound_rule.
4646
outbound_default_policy = "drop" # By default we drop outgoing traffic that do not match any outbound_rule.
47-
47+
4848
inbound_rule {
4949
action = "drop"
50-
ip = "1.1.1.1" # Banned IP
50+
ip = "1.1.1.1" # Banned IP
5151
}
52-
52+
5353
inbound_rule {
5454
action = "accept"
55-
port = 22
56-
ip = "212.47.225.64"
55+
port = 22
56+
ip = "212.47.225.64"
5757
}
58-
58+
5959
inbound_rule {
6060
action = "accept"
61-
port = 443
61+
port = 443
6262
}
63-
63+
6464
outbound_rule {
6565
action = "accept"
66-
ip = "8.8.8.8" # Only allow outgoing connection to this IP.
66+
ip = "8.8.8.8" # Only allow outgoing connection to this IP.
6767
}
6868
}
6969
```

docs/resources/instance_security_group_rules.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ This resource can be used to externalize rules from a `scaleway_instance_securit
1717
### Basic
1818

1919
```hcl
20-
resource scaleway_instance_security_group sg01 {
21-
external_rules = true
20+
resource "scaleway_instance_security_group" "sg01" {
21+
external_rules = true
2222
}
2323
24-
resource scaleway_instance_security_group_rules sgrs01 {
25-
security_group_id = scaleway_instance_security_group.sg01.id
26-
inbound_rule {
27-
action = "accept"
28-
port = 80
29-
ip_range = "0.0.0.0/0"
30-
}
24+
resource "scaleway_instance_security_group_rules" "sgrs01" {
25+
security_group_id = scaleway_instance_security_group.sg01.id
26+
inbound_rule {
27+
action = "accept"
28+
port = 80
29+
ip_range = "0.0.0.0/0"
30+
}
3131
}
3232
```
3333

docs/resources/instance_server.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ resource "scaleway_instance_volume" "data" {
3131
}
3232
3333
resource "scaleway_instance_server" "web" {
34-
type = "DEV1-L"
34+
type = "DEV1-S"
3535
image = "ubuntu_focal"
3636
3737
tags = [ "hello", "public" ]
@@ -50,7 +50,7 @@ resource "scaleway_instance_server" "web" {
5050
resource "scaleway_instance_ip" "ip" {}
5151
5252
resource "scaleway_instance_server" "web" {
53-
type = "DEV1-L"
53+
type = "DEV1-S"
5454
image = "f974feac-abae-4365-b988-8ec7d1cec10d"
5555
5656
tags = [ "hello", "public" ]
@@ -100,7 +100,7 @@ resource "scaleway_instance_server" "web" {
100100

101101
```hcl
102102
resource "scaleway_instance_server" "web" {
103-
type = "DEV1-L"
103+
type = "DEV1-S"
104104
image = "ubuntu_focal"
105105
106106
tags = [ "web", "public" ]

docs/resources/k8s_cluster.md

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -14,91 +14,92 @@ Creates and manages Scaleway Kubernetes clusters. For more information, see [the
1414

1515
```hcl
1616
resource "scaleway_k8s_cluster" "jack" {
17-
name = "jack"
18-
version = "1.18.0"
19-
cni = "cilium"
17+
name = "jack"
18+
version = "1.19.4"
19+
cni = "cilium"
2020
}
2121
2222
resource "scaleway_k8s_pool" "john" {
2323
cluster_id = scaleway_k8s_cluster.jack.id
24-
name = "john"
25-
node_type = "GP1-XS"
26-
size = 3
24+
name = "john"
25+
node_type = "DEV1-M"
26+
size = 1
2727
}
2828
```
2929

3030
### With additional configuration
3131

3232
```hcl
3333
resource "scaleway_k8s_cluster" "john" {
34-
name = "john"
35-
description = "my awesome cluster"
36-
version = "1.18.0"
37-
cni = "calico"
34+
name = "john"
35+
description = "my awesome cluster"
36+
version = "1.18.0"
37+
cni = "calico"
3838
enable_dashboard = true
39-
ingress = "traefik"
40-
tags = ["i'm an awsome tag", "yay"]
39+
ingress = "traefik"
40+
tags = ["i'm an awsome tag", "yay"]
4141
4242
autoscaler_config {
43-
disable_scale_down = false
44-
scale_down_delay_after_add = "5m"
45-
estimator = "binpacking"
46-
expander = "random"
47-
ignore_daemonsets_utilization = true
48-
balance_similar_node_groups = true
43+
disable_scale_down = false
44+
scale_down_delay_after_add = "5m"
45+
estimator = "binpacking"
46+
expander = "random"
47+
ignore_daemonsets_utilization = true
48+
balance_similar_node_groups = true
4949
expendable_pods_priority_cutoff = -5
5050
}
5151
}
5252
5353
resource "scaleway_k8s_pool" "john" {
54-
cluster_id = scaleway_k8s_cluster.john.id
55-
name = "john"
56-
node_type = "GP1-XS"
57-
size = 3
54+
cluster_id = scaleway_k8s_cluster.john.id
55+
name = "john"
56+
node_type = "DEV1-M"
57+
size = 3
5858
autoscaling = true
5959
autohealing = true
60-
min_size = 1
61-
max_size = 5
60+
min_size = 1
61+
max_size = 5
6262
}
6363
```
6464

6565
### With the kubernetes provider
6666

6767
```hcl
6868
resource "scaleway_k8s_cluster" "joy" {
69-
name = "joy"
69+
name = "joy"
7070
version = "1.18.0"
71-
cni = "flannel"
71+
cni = "flannel"
7272
}
7373
7474
resource "scaleway_k8s_pool" "john" {
7575
cluster_id = scaleway_k8s_cluster.joy.id
76-
name = "john"
77-
node_type = "GP1-XS"
78-
size = 3
76+
name = "john"
77+
node_type = "DEV1-M"
78+
size = 1
7979
}
8080
8181
resource "null_resource" "kubeconfig" {
82-
depends_on = [scaleway_k8s_pool.john] # at least one pool here
83-
triggers = {
84-
host = scaleway_k8s_cluster.joy.kubeconfig[0].host
85-
token = scaleway_k8s_cluster.joy.kubeconfig[0].token
86-
cluster_ca_certificate = scaleway_k8s_cluster.joy.kubeconfig[0].cluster_ca_certificate
87-
}
82+
depends_on = [scaleway_k8s_pool.john] # at least one pool here
83+
triggers = {
84+
host = scaleway_k8s_cluster.joy.kubeconfig[0].host
85+
token = scaleway_k8s_cluster.joy.kubeconfig[0].token
86+
cluster_ca_certificate = scaleway_k8s_cluster.joy.kubeconfig[0].cluster_ca_certificate
87+
}
8888
}
8989
9090
provider "kubernetes" {
9191
load_config_file = "false"
9292
93-
host = null_resource.kubeconfig.triggers.host
94-
token = null_resource.kubeconfig.triggers.token
93+
host = null_resource.kubeconfig.triggers.host
94+
token = null_resource.kubeconfig.triggers.token
9595
cluster_ca_certificate = base64decode(
96-
null_resource.kubeconfig.triggers.cluster_ca_certificate
96+
null_resource.kubeconfig.triggers.cluster_ca_certificate
9797
)
9898
}
9999
```
100100

101-
Th `null_resource` is needed because when the cluter is created, it's status is `pool_required`, but the kubeconfig can already be downloaded. It leads the `kubernetes` provider to start creating its objects, but the DNS entry for the Kubernetes master is not yet ready, that's why it's needed to wait for at least a pool.
101+
The `null_resource` is needed because when the cluster is created, it's status is `pool_required`, but the kubeconfig can already be downloaded.
102+
It leads the `kubernetes` provider to start creating its objects, but the DNS entry for the Kubernetes master is not yet ready, that's why it's needed to wait for at least a pool.
102103

103104
## Arguments Reference
104105

@@ -194,12 +195,13 @@ Before:
194195

195196
```hcl
196197
resource "scaleway_k8s_cluster" "jack" {
197-
name = "jack"
198+
name = "jack"
198199
version = "1.18.0"
199-
cni = "cilium"
200+
cni = "cilium"
201+
200202
default_pool {
201-
node_type = "GP1-XS"
202-
size = 3
203+
node_type = "DEV1-M"
204+
size = 1
203205
}
204206
}
205207
```
@@ -208,16 +210,16 @@ After:
208210

209211
```hcl
210212
resource "scaleway_k8s_cluster" "jack" {
211-
name = "jack"
213+
name = "jack"
212214
version = "1.18.0"
213-
cni = "cilium"
215+
cni = "cilium"
214216
}
215217
216218
resource "scaleway_k8s_pool" "default" {
217219
cluster_id = scaleway_k8s_cluster.jack.id
218-
name = "default"
219-
node_type = "GP1-XS"
220-
size = 3
220+
name = "default"
221+
node_type = "DEV1-M"
222+
size = 1
221223
}
222224
```
223225

docs/resources/k8s_pool.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ Creates and manages Scaleway Kubernetes cluster pools. For more information, see
1414

1515
```hcl
1616
resource "scaleway_k8s_cluster" "jack" {
17-
name = "jack"
18-
version = "1.18.0"
19-
cni = "cilium"
17+
name = "jack"
18+
version = "1.19.4"
19+
cni = "cilium"
2020
}
2121
2222
resource "scaleway_k8s_pool" "bill" {
23-
cluster_id = scaleway_k8s_cluster.jack.id
24-
name = "bill"
25-
node_type = "GP1-S"
26-
size = 3
27-
min_size = 0
28-
max_size = 10
29-
autoscaling = true
30-
autohealing = true
31-
container_runtime = "docker"
23+
cluster_id = scaleway_k8s_cluster.jack.id
24+
name = "bill"
25+
node_type = "DEV1-M"
26+
size = 3
27+
min_size = 0
28+
max_size = 10
29+
autoscaling = true
30+
autohealing = true
31+
container_runtime = "docker"
3232
placement_group_id = "1267e3fd-a51c-49ed-ad12-857092ee3a3d"
3333
}
3434
```

docs/resources/lb.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ resource "scaleway_lb_ip" "ip" {
1919
}
2020
2121
resource "scaleway_lb" "base" {
22-
ip_id = scaleway_lb_ip.ip.id
23-
region = "fr-par"
24-
type = "LB-S"
22+
ip_id = scaleway_lb_ip.ip.id
23+
region = "fr-par"
24+
type = "LB-S"
2525
}
2626
```
2727

@@ -64,8 +64,8 @@ For instance, if you had the following:
6464

6565
```hcl
6666
resource "scaleway_lb" "base" {
67-
region = "fr-par"
68-
type = "LB-S"
67+
region = "fr-par"
68+
type = "LB-S"
6969
}
7070
```
7171

@@ -76,9 +76,9 @@ resource "scaleway_lb_ip" "ip" {
7676
}
7777
7878
resource "scaleway_lb" "base" {
79-
ip_id = scaleway_lb_ip.ip.id
80-
region = "fr-par"
81-
type = "LB-S"
79+
ip_id = scaleway_lb_ip.ip.id
80+
region = "fr-par"
81+
type = "LB-S"
8282
}
8383
```
8484

0 commit comments

Comments
 (0)