Skip to content

doc: add documentation on dynamic and for_each loop #750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 11, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/resources/instance_security_group_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,75 @@ resource "scaleway_instance_security_group_rules" "sgrs01" {
}
```

### Simplify your rules using dynamic block and `for_each` loop

You can use [`for_each` syntax](https://www.terraform.io/docs/configuration/meta-arguments/for_each.html) to simplify the definition of your rules.
Let's suppose that your inbound default policy is to drop, but you want to build a list of exceptions to accept.
Create a local containing your exceptions (`locals.trusted`) and use the `for_each` syntax in a [dynamic block](https://www.terraform.io/docs/configuration/expressions/dynamic-blocks.html):

```hcl
resource "scaleway_instance_security_group" "main" {
description = "test"
name = "terraform test"
inbound_default_policy = "drop"
outbound_default_policy = "accept"
}

locals {
trusted = [
"1.2.3.4",
"4.5.6.7",
"7.8.9.10"
]
}

resource "scaleway_instance_security_group_rules" "main" {
security_group_id = scaleway_instance_security_group.main.id

dynamic "inbound_rule" {
for_each = local.trusted
content {
action = "accept"
ip = inbound_rule.value
port = 80
}
}
}
```

You can also use object to assign IP and port in the same time.
In your locals, you can use [objects](https://www.terraform.io/docs/configuration/types.html#structural-types) to encapsulate several values that will be used later on in the loop:

```hcl
resource "scaleway_instance_security_group" "main" {
description = "test"
name = "terraform test"
inbound_default_policy = "drop"
outbound_default_policy = "accept"
}

locals {
trusted = [
{ ip = "1.2.3.4", port = "80" },
{ ip = "5.6.7.8", port = "81" },
{ ip = "9.10.11.12", port = "81" },
]
}

resource "scaleway_instance_security_group_rules" "main" {
security_group_id = scaleway_instance_security_group.main.id

dynamic "inbound_rule" {
for_each = local.trusted
content {
action = "accept"
ip = inbound_rule.value.ip
port = inbound_rule.value.port
}
}
}
```

## Arguments Reference

The following arguments are supported:
Expand Down