feat!: Added module wrappers. Bump TF version to 1.0. (#55)

antonbabenko · web-flow · commit 2b464ad0f32b · 2022-06-07T10:35:51.000+02:00
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -72,7 +72,8 @@ jobs:
         uses: clowdhaus/terraform-min-max@v1.0.3
 
       - name: Pre-commit Terraform ${{ steps.minMax.outputs.maxVersion }}
-        uses: clowdhaus/terraform-composite-actions/pre-commit@v1.3.0
+        uses: clowdhaus/terraform-composite-actions/pre-commit@v1.5.0
         with:
           terraform-version: ${{ steps.minMax.outputs.maxVersion }}
           terraform-docs-version: ${{ env.TERRAFORM_DOCS_VERSION }}
+          install-hcledit: true
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,6 +3,7 @@ repos:
     rev: v1.72.1
     hooks:
       - id: terraform_fmt
+      - id: terraform_wrapper_module_for_each
       - id: terraform_validate
       - id: terraform_docs
         args:
diff --git a/README.md b/README.md
@@ -35,6 +35,12 @@ There are two separate Terraform resources used for the DynamoDB table: one is f
 terraform state mv module.dynamodb_table.aws_dynamodb_table.this module.dynamodb_table.aws_dynamodb_table.autoscaled
 ```
 
+## Module wrappers
+
+Users of this Terraform module can create multiple similar resources by using [`for_each` meta-argument within `module` block](https://www.terraform.io/language/meta-arguments/for_each) which became available in Terraform 0.13.
+
+Users of Terragrunt can achieve similar results by using modules provided in the [wrappers](https://github.com/terraform-aws-modules/terraform-aws-dynamodb-table/tree/master/wrappers) directory, if they prefer to reduce amount of configuration files.
+
 ## Examples
 
 - [Basic example](https://github.com/terraform-aws-modules/terraform-aws-dynamodb-table/tree/master/examples/basic)
@@ -46,7 +52,7 @@ terraform state mv module.dynamodb_table.aws_dynamodb_table.this module.dynamodb
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.69 |
 
 ## Providers
diff --git a/examples/autoscaling/README.md b/examples/autoscaling/README.md
@@ -19,8 +19,8 @@ Note that this example may create resources which can cost money (AWS Elastic IP
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.37 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.69 |
 | <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 |
 
 ## Providers
diff --git a/examples/autoscaling/versions.tf b/examples/autoscaling/versions.tf
@@ -1,8 +1,14 @@
 terraform {
-  required_version = ">= 0.12.6"
+  required_version = ">= 1.0"
 
   required_providers {
-    aws    = ">= 3.37"
-    random = ">= 2.0"
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.69"
+    }
+    random = {
+      source  = "hashicorp/random"
+      version = ">= 2.0"
+    }
   }
 }
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -19,7 +19,7 @@ Note that this example may create resources which can cost money (AWS Elastic IP
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.69 |
 | <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 |
 
diff --git a/examples/basic/versions.tf b/examples/basic/versions.tf
@@ -1,8 +1,14 @@
 terraform {
-  required_version = ">= 0.12.6"
+  required_version = ">= 1.0"
 
   required_providers {
-    aws    = ">= 3.69"
-    random = ">= 2.0"
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.69"
+    }
+    random = {
+      source  = "hashicorp/random"
+      version = ">= 2.0"
+    }
   }
 }
diff --git a/examples/global-tables/README.md b/examples/global-tables/README.md
@@ -19,16 +19,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.37 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.69 |
 | <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.37 |
-| <a name="provider_aws.euwest2"></a> [aws.euwest2](#provider\_aws.euwest2) | >= 3.37 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.69 |
+| <a name="provider_aws.euwest2"></a> [aws.euwest2](#provider\_aws.euwest2) | >= 3.69 |
 | <a name="provider_random"></a> [random](#provider\_random) | >= 2.0 |
 
 ## Modules
diff --git a/examples/global-tables/versions.tf b/examples/global-tables/versions.tf
@@ -1,8 +1,14 @@
 terraform {
-  required_version = ">= 0.12.6"
+  required_version = ">= 1.0"
 
   required_providers {
-    aws    = ">= 3.37"
-    random = ">= 2.0"
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.69"
+    }
+    random = {
+      source  = "hashicorp/random"
+      version = ">= 2.0"
+    }
   }
 }
diff --git a/versions.tf b/versions.tf
@@ -1,7 +1,10 @@
 terraform {
-  required_version = ">= 0.12.6"
+  required_version = ">= 1.0"
 
   required_providers {
-    aws = ">= 3.69"
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.69"
+    }
   }
 }
diff --git a/wrappers/README.md b/wrappers/README.md
@@ -0,0 +1,100 @@
+# Wrapper for the root module
+
+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).
+
+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.
+
+This wrapper does not implement any extra functionality.
+
+## Usage with Terragrunt
+
+`terragrunt.hcl`:
+
+```hcl
+terraform {
+  source = "tfr:///terraform-aws-modules/dynamodb-table/aws//wrappers"
+  # Alternative source:
+  # source = "git::git@github.com:terraform-aws-modules/terraform-aws-dynamodb-table.git?ref=master//wrappers"
+}
+
+inputs = {
+  defaults = { # Default values
+    create = true
+    tags = {
+      Terraform   = "true"
+      Environment = "dev"
+    }
+  }
+
+  items = {
+    my-item = {
+      # omitted... can be any argument supported by the module
+    }
+    my-second-item = {
+      # omitted... can be any argument supported by the module
+    }
+    # omitted...
+  }
+}
+```
+
+## Usage with Terraform
+
+```hcl
+module "wrapper" {
+  source = "terraform-aws-modules/dynamodb-table/aws//wrappers"
+
+  defaults = { # Default values
+    create = true
+    tags = {
+      Terraform   = "true"
+      Environment = "dev"
+    }
+  }
+
+  items = {
+    my-item = {
+      # omitted... can be any argument supported by the module
+    }
+    my-second-item = {
+      # omitted... can be any argument supported by the module
+    }
+    # omitted...
+  }
+}
+```
+
+## Example: Manage multiple S3 buckets in one Terragrunt layer
+
+`eu-west-1/s3-buckets/terragrunt.hcl`:
+
+```hcl
+terraform {
+  source = "tfr:///terraform-aws-modules/s3-bucket/aws//wrappers"
+  # Alternative source:
+  # source = "git::git@github.com:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
+}
+
+inputs = {
+  defaults = {
+    force_destroy = true
+
+    attach_elb_log_delivery_policy        = true
+    attach_lb_log_delivery_policy         = true
+    attach_deny_insecure_transport_policy = true
+    attach_require_latest_tls_policy      = true
+  }
+
+  items = {
+    bucket1 = {
+      bucket = "my-random-bucket-1"
+    }
+    bucket2 = {
+      bucket = "my-random-bucket-2"
+      tags = {
+        Secure = "probably"
+      }
+    }
+  }
+}
+```
diff --git a/wrappers/main.tf b/wrappers/main.tf
@@ -0,0 +1,40 @@
+module "wrapper" {
+  source = "../"
+
+  for_each = var.items
+
+  create_table                       = try(each.value.create_table, var.defaults.create_table, true)
+  name                               = try(each.value.name, var.defaults.name, null)
+  attributes                         = try(each.value.attributes, var.defaults.attributes, [])
+  hash_key                           = try(each.value.hash_key, var.defaults.hash_key, null)
+  range_key                          = try(each.value.range_key, var.defaults.range_key, null)
+  billing_mode                       = try(each.value.billing_mode, var.defaults.billing_mode, "PAY_PER_REQUEST")
+  write_capacity                     = try(each.value.write_capacity, var.defaults.write_capacity, null)
+  read_capacity                      = try(each.value.read_capacity, var.defaults.read_capacity, null)
+  point_in_time_recovery_enabled     = try(each.value.point_in_time_recovery_enabled, var.defaults.point_in_time_recovery_enabled, false)
+  ttl_enabled                        = try(each.value.ttl_enabled, var.defaults.ttl_enabled, false)
+  ttl_attribute_name                 = try(each.value.ttl_attribute_name, var.defaults.ttl_attribute_name, "")
+  global_secondary_indexes           = try(each.value.global_secondary_indexes, var.defaults.global_secondary_indexes, [])
+  local_secondary_indexes            = try(each.value.local_secondary_indexes, var.defaults.local_secondary_indexes, [])
+  replica_regions                    = try(each.value.replica_regions, var.defaults.replica_regions, [])
+  stream_enabled                     = try(each.value.stream_enabled, var.defaults.stream_enabled, false)
+  stream_view_type                   = try(each.value.stream_view_type, var.defaults.stream_view_type, null)
+  server_side_encryption_enabled     = try(each.value.server_side_encryption_enabled, var.defaults.server_side_encryption_enabled, false)
+  server_side_encryption_kms_key_arn = try(each.value.server_side_encryption_kms_key_arn, var.defaults.server_side_encryption_kms_key_arn, null)
+  tags                               = try(each.value.tags, var.defaults.tags, {})
+  timeouts = try(each.value.timeouts, var.defaults.timeouts, {
+    create = "10m"
+    update = "60m"
+    delete = "10m"
+  })
+  autoscaling_enabled = try(each.value.autoscaling_enabled, var.defaults.autoscaling_enabled, false)
+  autoscaling_defaults = try(each.value.autoscaling_defaults, var.defaults.autoscaling_defaults, {
+    scale_in_cooldown  = 0
+    scale_out_cooldown = 0
+    target_value       = 70
+  })
+  autoscaling_read    = try(each.value.autoscaling_read, var.defaults.autoscaling_read, {})
+  autoscaling_write   = try(each.value.autoscaling_write, var.defaults.autoscaling_write, {})
+  autoscaling_indexes = try(each.value.autoscaling_indexes, var.defaults.autoscaling_indexes, {})
+  table_class         = try(each.value.table_class, var.defaults.table_class, null)
+}
diff --git a/wrappers/outputs.tf b/wrappers/outputs.tf
@@ -0,0 +1,5 @@
+output "wrapper" {
+  description = "Map of outputs of a wrapper."
+  value       = module.wrapper
+  # sensitive = false  # No sensitive module output found
+}
diff --git a/wrappers/variables.tf b/wrappers/variables.tf
@@ -0,0 +1,11 @@
+variable "defaults" {
+  description = "Map of default values which will be used for each item."
+  type        = any
+  default     = {}
+}
+
+variable "items" {
+  description = "Maps of items to create a wrapper from. Values are passed through to the module."
+  type        = any
+  default     = {}
+}
diff --git a/wrappers/versions.tf b/wrappers/versions.tf
@@ -0,0 +1,3 @@
+terraform {
+  required_version = ">= 0.13.1"
+}

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,10 @@`
`1`	`1`	`terraform {`
`2`		`- required_version = ">= 0.12.6"`
	`2`	`+ required_version = ">= 1.0"`
`3`	`3`
`4`	`4`	`required_providers {`
`5`		`- aws = ">= 3.69"`
	`5`	`+ aws = {`
	`6`	`+ source = "hashicorp/aws"`
	`7`	`+ version = ">= 3.69"`
	`8`	`+ }`
`6`	`9`	`}`
`7`	`10`	`}`