Skip to content

Commit

Permalink
fix: align subnet modules (#412)
Browse files Browse the repository at this point in the history 
Co-authored-by: Andrew Peabody <[email protected]>
  • Loading branch information
@tuunit @apeabody
tuunit and apeabody authored Dec 30, 2022
1 parent 67cce5a commit 36d1c55
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
26 changes: 14 additions & 12 deletions modules/subnets-beta/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ It supports creating:

- Subnets within vpc network.

It also uses google beta provider to support the following resource fields:

- google_compute_subnetwork.purpose
- google_compute_subnetwork.role

## Usage

Basic usage of this submodule is as follows:
Expand Down Expand Up @@ -47,6 +42,7 @@ module "vpc" {
subnet_flow_logs_interval = "INTERVAL_10_MIN"
subnet_flow_logs_sampling = 0.7
subnet_flow_logs_metadata = "INCLUDE_ALL_METADATA"
subnet_flow_logs_filter_expr = "true"
}
]
Expand Down Expand Up @@ -86,10 +82,16 @@ module "vpc" {

The subnets list contains maps, where each object represents a subnet. Each map has the following inputs (please see examples folder for additional references):

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| subnet\_name | The name of the subnet being created | string | - | yes |
| subnet\_ip | The IP and CIDR range of the subnet being created | string | - | yes |
| subnet\_region | The region where the subnet will be created | string | - | yes |
| subnet\_private\_access | Whether this subnet will have private Google access enabled | string | `"false"` | no |
| subnet\_flow\_logs | Whether the subnet will record and send flow log data to logging | string | `"false"` | no |
| Name | Description | Type | Default | Required |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------- | :----: | :----------------------: | :------: |
| subnet\_name | The name of the subnet being created | string | - | yes |
| subnet\_ip | The IP and CIDR range of the subnet being created | string | - | yes |
| subnet\_region | The region where the subnet will be created | string | - | yes |
| subnet\_private\_access | Whether this subnet will have private Google access enabled | string | `"false"` | no |
| subnet\_flow\_logs | Whether the subnet will record and send flow log data to logging | string | `"false"` | no |
| subnet\_flow\_logs\_interval | If subnet\_flow\_logs is true, sets the aggregation interval for collecting flow logs | string | `"INTERVAL_5_SEC"` | no |
| subnet\_flow\_logs\_sampling | If subnet\_flow\_logs is true, set the sampling rate of VPC flow logs within the subnetwork | string | `"0.5"` | no |
| subnet\_flow\_logs\_metadata | If subnet\_flow\_logs is true, configures whether metadata fields should be added to the reported VPC flow logs | string | `"INCLUDE_ALL_METADATA"` | no |
| subnet\_flow\_logs\_filter_expr | Export filter defining which VPC flow logs should be logged, see https://cloud.google.com/vpc/docs/flow-logs#filtering for formatting details | string | `"true"` | no |
| purpose | The purpose of the subnet usage. Whether it is to be used as a regular subnet or for proxy or loadbalacing purposes, see https://cloud.google.com/vpc/docs/subnets#purpose for more details | string | `"PRIVATE"` | no |
| role | The role of the subnet when using it as a proxy or loadbalancer network. Whether it is to be used as the active or as a backup subnet, see https://cloud.google.com/load-balancing/docs/proxy-only-subnets#proxy_only_subnet_create for more details | string | - | no |
2 changes: 2 additions & 0 deletions modules/subnets-beta/main.tf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@ resource "google_compute_subnetwork" "subnetwork" {
aggregation_interval = lookup(each.value, "subnet_flow_logs_interval", "INTERVAL_5_SEC")
flow_sampling = lookup(each.value, "subnet_flow_logs_sampling", "0.5")
metadata = lookup(each.value, "subnet_flow_logs_metadata", "INCLUDE_ALL_METADATA")
filter_expr = lookup(each.value, "subnet_flow_logs_filter", "true")
}] : []
content {
aggregation_interval = log_config.value.aggregation_interval
flow_sampling = log_config.value.flow_sampling
metadata = log_config.value.metadata
filter_expr = log_config.value.filter_expr
}
}
network = var.network_name
Expand Down
4 changes: 4 additions & 0 deletions modules/subnets/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ module "vpc" {
subnet_private_access = "true"
subnet_flow_logs = "true"
description = "This subnet has a description"
purpose = "INTERNAL_HTTPS_LOAD_BALANCER"
role = "ACTIVE"
},
{
subnet_name = "subnet-03"
Expand Down Expand Up @@ -90,3 +92,5 @@ The subnets list contains maps, where each object represents a subnet. Each map
| subnet\_flow\_logs\_sampling | If subnet\_flow\_logs is true, set the sampling rate of VPC flow logs within the subnetwork | string | `"0.5"` | no |
| subnet\_flow\_logs\_metadata | If subnet\_flow\_logs is true, configures whether metadata fields should be added to the reported VPC flow logs | string | `"INCLUDE_ALL_METADATA"` | no |
| subnet\_flow\_logs\_filter_expr | Export filter defining which VPC flow logs should be logged, see https://cloud.google.com/vpc/docs/flow-logs#filtering for formatting details | string | `"true"` | no |
| purpose | The purpose of the subnet usage. Whether it is to be used as a regular subnet or for proxy or loadbalacing purposes, see https://cloud.google.com/vpc/docs/subnets#purpose for more details | string | `"PRIVATE"` | no |
| role | The role of the subnet when using it as a proxy or loadbalancer network. Whether it is to be used as the active or as a backup subnet, see https://cloud.google.com/load-balancing/docs/proxy-only-subnets#proxy_only_subnet_create for more details | string | - | no |

0 comments on commit 36d1c55

Please sign in to comment.