Skip to content

Commit f973dd5

Browse files
bryantbiggsbryantbiggs
authored
feat: Add Terragrunt module wrapper (#105)
1 parent baecb44 commit f973dd5

File tree

6 files changed

+221
-1
lines changed

6 files changed

+221
-1
lines changed

‎.pre-commit-config.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
repos:
22
- repo: https://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.96.1
3+
rev: v1.98.0
44
hooks:
55
- id: terraform_fmt
6+
- id: terraform_wrapper_module_for_each
67
- id: terraform_docs
78
args:
89
- '--args=--lockfile=false'

‎wrappers/README.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Wrapper for the root module
2+
3+
The configuration in this directory contains an implementation of a single module wrapper pattern, which allows managing several copies of a module in places where using the native Terraform 0.13+ `for_each` feature is not feasible (e.g., with Terragrunt).
4+
5+
You may want to use a single Terragrunt configuration file to manage multiple resources without duplicating `terragrunt.hcl` files for each copy of the same module.
6+
7+
This wrapper does not implement any extra functionality.
8+
9+
## Usage with Terragrunt
10+
11+
`terragrunt.hcl`:
12+
13+
```hcl
14+
terraform {
15+
source = "tfr:///terraform-aws-modules/redshift/aws//wrappers"
16+
# Alternative source:
17+
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-redshift.git//wrappers?ref=master"
18+
}
19+
20+
inputs = {
21+
defaults = { # Default values
22+
create = true
23+
tags = {
24+
Terraform = "true"
25+
Environment = "dev"
26+
}
27+
}
28+
29+
items = {
30+
my-item = {
31+
# omitted... can be any argument supported by the module
32+
}
33+
my-second-item = {
34+
# omitted... can be any argument supported by the module
35+
}
36+
# omitted...
37+
}
38+
}
39+
```
40+
41+
## Usage with Terraform
42+
43+
```hcl
44+
module "wrapper" {
45+
source = "terraform-aws-modules/redshift/aws//wrappers"
46+
47+
defaults = { # Default values
48+
create = true
49+
tags = {
50+
Terraform = "true"
51+
Environment = "dev"
52+
}
53+
}
54+
55+
items = {
56+
my-item = {
57+
# omitted... can be any argument supported by the module
58+
}
59+
my-second-item = {
60+
# omitted... can be any argument supported by the module
61+
}
62+
# omitted...
63+
}
64+
}
65+
```
66+
67+
## Example: Manage multiple S3 buckets in one Terragrunt layer
68+
69+
`eu-west-1/s3-buckets/terragrunt.hcl`:
70+
71+
```hcl
72+
terraform {
73+
source = "tfr:///terraform-aws-modules/s3-bucket/aws//wrappers"
74+
# Alternative source:
75+
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git//wrappers?ref=master"
76+
}
77+
78+
inputs = {
79+
defaults = {
80+
force_destroy = true
81+
82+
attach_elb_log_delivery_policy = true
83+
attach_lb_log_delivery_policy = true
84+
attach_deny_insecure_transport_policy = true
85+
attach_require_latest_tls_policy = true
86+
}
87+
88+
items = {
89+
bucket1 = {
90+
bucket = "my-random-bucket-1"
91+
}
92+
bucket2 = {
93+
bucket = "my-random-bucket-2"
94+
tags = {
95+
Secure = "probably"
96+
}
97+
}
98+
}
99+
}
100+
```

‎wrappers/main.tf

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
module "wrapper" {
2+
source = "../"
3+
4+
for_each = var.items
5+
6+
allow_version_upgrade = try(each.value.allow_version_upgrade, var.defaults.allow_version_upgrade, null)
7+
apply_immediately = try(each.value.apply_immediately, var.defaults.apply_immediately, null)
8+
aqua_configuration_status = try(each.value.aqua_configuration_status, var.defaults.aqua_configuration_status, null)
9+
authentication_profiles = try(each.value.authentication_profiles, var.defaults.authentication_profiles, {})
10+
automated_snapshot_retention_period = try(each.value.automated_snapshot_retention_period, var.defaults.automated_snapshot_retention_period, null)
11+
availability_zone = try(each.value.availability_zone, var.defaults.availability_zone, null)
12+
availability_zone_relocation_enabled = try(each.value.availability_zone_relocation_enabled, var.defaults.availability_zone_relocation_enabled, null)
13+
cloudwatch_log_group_kms_key_id = try(each.value.cloudwatch_log_group_kms_key_id, var.defaults.cloudwatch_log_group_kms_key_id, null)
14+
cloudwatch_log_group_retention_in_days = try(each.value.cloudwatch_log_group_retention_in_days, var.defaults.cloudwatch_log_group_retention_in_days, 0)
15+
cloudwatch_log_group_skip_destroy = try(each.value.cloudwatch_log_group_skip_destroy, var.defaults.cloudwatch_log_group_skip_destroy, null)
16+
cloudwatch_log_group_tags = try(each.value.cloudwatch_log_group_tags, var.defaults.cloudwatch_log_group_tags, {})
17+
cluster_identifier = try(each.value.cluster_identifier, var.defaults.cluster_identifier, "")
18+
cluster_timeouts = try(each.value.cluster_timeouts, var.defaults.cluster_timeouts, {})
19+
cluster_version = try(each.value.cluster_version, var.defaults.cluster_version, null)
20+
create = try(each.value.create, var.defaults.create, true)
21+
create_cloudwatch_log_group = try(each.value.create_cloudwatch_log_group, var.defaults.create_cloudwatch_log_group, false)
22+
create_endpoint_access = try(each.value.create_endpoint_access, var.defaults.create_endpoint_access, false)
23+
create_parameter_group = try(each.value.create_parameter_group, var.defaults.create_parameter_group, true)
24+
create_random_password = try(each.value.create_random_password, var.defaults.create_random_password, true)
25+
create_scheduled_action_iam_role = try(each.value.create_scheduled_action_iam_role, var.defaults.create_scheduled_action_iam_role, false)
26+
create_snapshot_schedule = try(each.value.create_snapshot_schedule, var.defaults.create_snapshot_schedule, false)
27+
create_subnet_group = try(each.value.create_subnet_group, var.defaults.create_subnet_group, true)
28+
database_name = try(each.value.database_name, var.defaults.database_name, null)
29+
default_iam_role_arn = try(each.value.default_iam_role_arn, var.defaults.default_iam_role_arn, null)
30+
elastic_ip = try(each.value.elastic_ip, var.defaults.elastic_ip, null)
31+
encrypted = try(each.value.encrypted, var.defaults.encrypted, true)
32+
endpoint_name = try(each.value.endpoint_name, var.defaults.endpoint_name, "")
33+
endpoint_resource_owner = try(each.value.endpoint_resource_owner, var.defaults.endpoint_resource_owner, null)
34+
endpoint_subnet_group_name = try(each.value.endpoint_subnet_group_name, var.defaults.endpoint_subnet_group_name, "")
35+
endpoint_vpc_security_group_ids = try(each.value.endpoint_vpc_security_group_ids, var.defaults.endpoint_vpc_security_group_ids, [])
36+
enhanced_vpc_routing = try(each.value.enhanced_vpc_routing, var.defaults.enhanced_vpc_routing, null)
37+
final_snapshot_identifier = try(each.value.final_snapshot_identifier, var.defaults.final_snapshot_identifier, null)
38+
iam_role_arns = try(each.value.iam_role_arns, var.defaults.iam_role_arns, [])
39+
iam_role_description = try(each.value.iam_role_description, var.defaults.iam_role_description, null)
40+
iam_role_name = try(each.value.iam_role_name, var.defaults.iam_role_name, null)
41+
iam_role_path = try(each.value.iam_role_path, var.defaults.iam_role_path, null)
42+
iam_role_permissions_boundary = try(each.value.iam_role_permissions_boundary, var.defaults.iam_role_permissions_boundary, null)
43+
iam_role_tags = try(each.value.iam_role_tags, var.defaults.iam_role_tags, {})
44+
iam_role_use_name_prefix = try(each.value.iam_role_use_name_prefix, var.defaults.iam_role_use_name_prefix, true)
45+
kms_key_arn = try(each.value.kms_key_arn, var.defaults.kms_key_arn, null)
46+
logging = try(each.value.logging, var.defaults.logging, {})
47+
maintenance_track_name = try(each.value.maintenance_track_name, var.defaults.maintenance_track_name, null)
48+
manage_master_password = try(each.value.manage_master_password, var.defaults.manage_master_password, false)
49+
manage_master_password_rotation = try(each.value.manage_master_password_rotation, var.defaults.manage_master_password_rotation, false)
50+
manual_snapshot_retention_period = try(each.value.manual_snapshot_retention_period, var.defaults.manual_snapshot_retention_period, null)
51+
master_password = try(each.value.master_password, var.defaults.master_password, null)
52+
master_password_rotate_immediately = try(each.value.master_password_rotate_immediately, var.defaults.master_password_rotate_immediately, null)
53+
master_password_rotation_automatically_after_days = try(each.value.master_password_rotation_automatically_after_days, var.defaults.master_password_rotation_automatically_after_days, null)
54+
master_password_rotation_duration = try(each.value.master_password_rotation_duration, var.defaults.master_password_rotation_duration, null)
55+
master_password_rotation_schedule_expression = try(each.value.master_password_rotation_schedule_expression, var.defaults.master_password_rotation_schedule_expression, null)
56+
master_password_secret_kms_key_id = try(each.value.master_password_secret_kms_key_id, var.defaults.master_password_secret_kms_key_id, null)
57+
master_username = try(each.value.master_username, var.defaults.master_username, "awsuser")
58+
multi_az = try(each.value.multi_az, var.defaults.multi_az, null)
59+
node_type = try(each.value.node_type, var.defaults.node_type, "")
60+
number_of_nodes = try(each.value.number_of_nodes, var.defaults.number_of_nodes, 1)
61+
owner_account = try(each.value.owner_account, var.defaults.owner_account, null)
62+
parameter_group_description = try(each.value.parameter_group_description, var.defaults.parameter_group_description, null)
63+
parameter_group_family = try(each.value.parameter_group_family, var.defaults.parameter_group_family, "redshift-1.0")
64+
parameter_group_name = try(each.value.parameter_group_name, var.defaults.parameter_group_name, null)
65+
parameter_group_parameters = try(each.value.parameter_group_parameters, var.defaults.parameter_group_parameters, {})
66+
parameter_group_tags = try(each.value.parameter_group_tags, var.defaults.parameter_group_tags, {})
67+
port = try(each.value.port, var.defaults.port, null)
68+
preferred_maintenance_window = try(each.value.preferred_maintenance_window, var.defaults.preferred_maintenance_window, "sat:10:00-sat:10:30")
69+
publicly_accessible = try(each.value.publicly_accessible, var.defaults.publicly_accessible, false)
70+
random_password_length = try(each.value.random_password_length, var.defaults.random_password_length, 16)
71+
scheduled_actions = try(each.value.scheduled_actions, var.defaults.scheduled_actions, {})
72+
skip_final_snapshot = try(each.value.skip_final_snapshot, var.defaults.skip_final_snapshot, true)
73+
snapshot_cluster_identifier = try(each.value.snapshot_cluster_identifier, var.defaults.snapshot_cluster_identifier, null)
74+
snapshot_copy = try(each.value.snapshot_copy, var.defaults.snapshot_copy, {})
75+
snapshot_identifier = try(each.value.snapshot_identifier, var.defaults.snapshot_identifier, null)
76+
snapshot_schedule_definitions = try(each.value.snapshot_schedule_definitions, var.defaults.snapshot_schedule_definitions, [])
77+
snapshot_schedule_description = try(each.value.snapshot_schedule_description, var.defaults.snapshot_schedule_description, null)
78+
snapshot_schedule_force_destroy = try(each.value.snapshot_schedule_force_destroy, var.defaults.snapshot_schedule_force_destroy, null)
79+
snapshot_schedule_identifier = try(each.value.snapshot_schedule_identifier, var.defaults.snapshot_schedule_identifier, null)
80+
subnet_group_description = try(each.value.subnet_group_description, var.defaults.subnet_group_description, null)
81+
subnet_group_name = try(each.value.subnet_group_name, var.defaults.subnet_group_name, null)
82+
subnet_group_tags = try(each.value.subnet_group_tags, var.defaults.subnet_group_tags, {})
83+
subnet_ids = try(each.value.subnet_ids, var.defaults.subnet_ids, [])
84+
tags = try(each.value.tags, var.defaults.tags, {})
85+
usage_limits = try(each.value.usage_limits, var.defaults.usage_limits, {})
86+
use_snapshot_identifier_prefix = try(each.value.use_snapshot_identifier_prefix, var.defaults.use_snapshot_identifier_prefix, true)
87+
vpc_security_group_ids = try(each.value.vpc_security_group_ids, var.defaults.vpc_security_group_ids, [])
88+
}

‎wrappers/outputs.tf

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
output "wrapper" {
2+
description = "Map of outputs of a wrapper."
3+
value = module.wrapper
4+
# sensitive = false # No sensitive module output found
5+
}

‎wrappers/variables.tf

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
variable "defaults" {
2+
description = "Map of default values which will be used for each item."
3+
type = any
4+
default = {}
5+
}
6+
7+
variable "items" {
8+
description = "Maps of items to create a wrapper from. Values are passed through to the module."
9+
type = any
10+
default = {}
11+
}

‎wrappers/versions.tf

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
terraform {
2+
required_version = ">= 1.3"
3+
4+
required_providers {
5+
aws = {
6+
source = "hashicorp/aws"
7+
version = ">= 5.45"
8+
}
9+
10+
random = {
11+
source = "hashicorp/random"
12+
version = ">= 3.0"
13+
}
14+
}
15+
}

0 commit comments

Comments
 (0)