Skip to content

Commit d8f9186

Browse files
authored
doc(redis): fixed markdownlint errors in doc (#1330)
1 parent 3f7e1a5 commit d8f9186

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/resources/redis_cluster.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ resource "scaleway_redis_cluster" "main" {
2323
tags = [ "test", "redis" ]
2424
cluster_size = 1
2525
tls_enabled = "true"
26-
26+
2727
acl {
2828
ip = "0.0.0.0/0"
2929
description = "Allow all"
@@ -40,14 +40,16 @@ resource "scaleway_redis_cluster" "main" {
4040
node_type = "MDB-BETA-M"
4141
user_name = "my_initial_user"
4242
password = "thiZ_is_v&ry_s3cret"
43-
43+
4444
settings = {
4545
"maxclients" = "1000"
4646
"tcp-keepalive" = "120"
4747
}
4848
}
4949
```
50+
5051
### With a private network
52+
5153
```hcl
5254
resource "scaleway_vpc_private_network" "pn" {
5355
name = "private-network"
@@ -106,28 +108,32 @@ The following arguments are supported:
106108

107109
- `acl` - (Optional) List of acl rules, this is cluster's authorized IPs.
108110

109-
~> The `acl` block supports:
111+
~> The `acl` block supports:
110112

111-
- `ip` - (Required) The ip range to whitelist in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
112-
- `description` - (Optional) A text describing this rule. Default description: `Allow IP`
113+
- `ip` - (Required) The ip range to whitelist in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
114+
- `description` - (Optional) A text describing this rule. Default description: `Allow IP`
113115

114116
- `settings` - (Optional) Map of settings for redis cluster. Available settings can be found by listing redis versions with scaleway API or CLI
115117

116118
- `private_network` - (Optional) Describes the private network you want to connect to your cluster. If not set, a public network will be provided.
117119

118120
~> The `private_network` block supports :
119-
- `id` - (Required) The UUID of the private network resource.
120-
- `service_ips` - (Required) Endpoint IPv4 addresses in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation). You must provide at least one IP per node.
121+
122+
- `id` - (Required) The UUID of the private network resource.
123+
- `service_ips` - (Required) Endpoint IPv4 addresses in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation). You must provide at least one IP per node.
121124

122125
~> **Important:** The way to use private networks differs whether you are using redis in standalone or cluster mode.
126+
123127
- Standalone mode (`cluster_size` = 1) : you can attach as many private networks as you want (each must be a separate block). If you detach your only private network, your cluster won't be reachable until you define a new private or public network. You can modify your private_network and its specs, you can have both a private and public network side by side.
128+
124129
- Cluster mode (`cluster_size` > 1) : you can define a single private network as you create your cluster, you won't be able to edit or detach it afterwards, unless you create another cluster. Your `service_ips` must be listed as follows:
130+
125131
```hcl
126132
service_ips = [
127-
"10.12.1.10/20",
133+
"10.12.1.10/20",
128134
"10.12.1.11/20",
129135
"10.12.1.12/20",
130-
]
136+
]
131137
```
132138

133139
## Attributes Reference

0 commit comments

Comments
 (0)