Fixing and preparing update for Terraform 0.12

Author: antonbabenko

.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 repos:
 - repo: git://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.8.1
+  rev: v1.21.0
   hooks:
     - id: terraform_fmt
     - id: terraform_docs
 - repo: git://github.com/pre-commit/pre-commit-hooks
-  rev: v2.1.0
+  rev: v2.4.0
   hooks:
     - id: check-merge-conflict

README.md

@@ -7,26 +7,27 @@ This module
 - Creates Redis ElastiCache clusters
 - Creates, manages, and exports a security group
 
+## Terraform versions
+
+Terraform 0.12. Pin module version to `~> v2.0`. Submit pull-requests to `master` branch.
+
+Terraform 0.11. Pin module version to `~> v1.0`.
+
 ## Usage
 
 ```hcl
 module "redis" {
-  source         = "github.com/terraform-community-modules/tf_aws_elasticache_redis?ref=v1.3.0"
-  env            = var.env
+  source  = "github.com/terraform-community-modules/tf_aws_elasticache_redis.git"
+  version = "~> 2.0"
+
+  env            = "dev"
   name           = "thtest"
   redis_clusters = "2"
   redis_failover = "true"
-  subnets        = module.vpc.database_subnets
-  vpc_id         = module.vpc.vpc_id
-}
-```
+  subnets        = ["subnet-12345678", "subnet-11111111", "subnet-22222222"]
+  vpc_id         = "vpc-12345678"
 
-## Usage with redis_parameters
-
-```hcl
-variable "redis_parameters" {
-  description = "additional parameters"
-  default = [{
+  redis_parameters = [{
     name  = "min-slaves-max-lag"
     value = "5"
   },{
@@ -37,36 +38,32 @@ variable "redis_parameters" {
     value = "32"
   }]
 }
-
-module "redis" {
-  source           = "github.com/terraform-community-modules/tf_aws_elasticache_redis?ref=v1.3.0"
-  ...
-  redis_parameters = var.redis_parameters
-  ...
-}
 ```
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| allowed\_cidr | A list of Security Group ID's to allow access to. | list | `[ "127.0.0.1/32" ]` | no |
-| allowed\_security\_groups | A list of Security Group ID's to allow access to. | list | `[]` | no |
-| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. | string | `"false"` | no |
+| alarm\_actions |  | list | n/a | yes |
+| alarm\_cpu\_threshold | These vars would be used by cloudwatch.tf and should be uncommented if we decide to use them. | string | `"75"` | no |
+| alarm\_memory\_threshold |  | string | `"10000000"` | no |
+| allowed\_cidr | A list of Security Group ID's to allow access to. | list(string) | `[ "127.0.0.1/32" ]` | no |
+| allowed\_security\_groups | A list of Security Group ID's to allow access to. | list(string) | `[]` | no |
+| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. | bool | `"false"` | no |
 | env | env to deploy into, should typically dev/staging/prod | string | n/a | yes |
 | name | Name for the Redis replication group i.e. UserObject | string | n/a | yes |
 | redis\_clusters | Number of Redis cache clusters (nodes) to create | string | n/a | yes |
-| redis\_failover |  | string | `"false"` | no |
+| redis\_failover |  | bool | `"false"` | no |
 | redis\_maintenance\_window | Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period | string | `"fri:08:00-fri:09:00"` | no |
 | redis\_node\_type | Instance type to use for creating the Redis cache clusters | string | `"cache.m3.medium"` | no |
-| redis\_parameters | additional parameters modifyed in parameter group | list | `[]` | no |
-| redis\_port |  | string | `"6379"` | no |
-| redis\_snapshot\_retention\_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro or cache.t2.* cache nodes | string | `"0"` | no |
+| redis\_parameters | additional parameters modifyed in parameter group | list(map(any)) | `[]` | no |
+| redis\_port |  | number | `"6379"` | no |
+| redis\_snapshot\_retention\_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro or cache.t2.* cache nodes | number | `"0"` | no |
 | redis\_snapshot\_window | The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period | string | `"06:30-07:30"` | no |
 | redis\_version | Redis version to use, defaults to 3.2.10 | string | `"3.2.10"` | no |
-| subnets | List of VPC Subnet IDs for the cache subnet group | list | n/a | yes |
-| tags | Tags for redis nodes | map | `{}` | no |
+| subnets | List of VPC Subnet IDs for the cache subnet group | list(string) | n/a | yes |
+| tags | Tags for redis nodes | map(string) | `{}` | no |
 | vpc\_id | VPC ID | string | n/a | yes |
 
 ## Outputs

variables.tf

@@ -16,43 +16,50 @@ variable "alarm_actions" {
 
 variable "apply_immediately" {
   description = "Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false."
-  default     = "false"
+  type        = bool
+  default     = false
 }
 
 variable "allowed_cidr" {
+  description = "A list of Security Group ID's to allow access to."
   type        = list(string)
   default     = ["127.0.0.1/32"]
-  description = "A list of Security Group ID's to allow access to."
 }
 
 variable "allowed_security_groups" {
+  description = "A list of Security Group ID's to allow access to."
   type        = list(string)
   default     = []
-  description = "A list of Security Group ID's to allow access to."
 }
 
 variable "env" {
   description = "env to deploy into, should typically dev/staging/prod"
+  type        = string
 }
 
 variable "name" {
   description = "Name for the Redis replication group i.e. UserObject"
+  type        = string
 }
 
 variable "redis_clusters" {
   description = "Number of Redis cache clusters (nodes) to create"
+  type        = string
 }
 
 variable "redis_failover" {
+  type    = bool
   default = false
 }
 
 variable "redis_node_type" {
   description = "Instance type to use for creating the Redis cache clusters"
+  type        = string
   default     = "cache.m3.medium"
 }
 
 variable "redis_port" {
+  type    = number
   default = 6379
 }
 
@@ -64,36 +71,41 @@ variable "subnets" {
 # might want a map
 variable "redis_version" {
   description = "Redis version to use, defaults to 3.2.10"
+  type        = string
   default     = "3.2.10"
 }
 
 variable "vpc_id" {
   description = "VPC ID"
+  type        = string
 }
 
 variable "redis_parameters" {
-  type        = list(object({ name = string, value = string }))
   description = "additional parameters modifyed in parameter group"
+  type        = list(map(any))
   default     = []
 }
 
 variable "redis_maintenance_window" {
   description = "Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period"
+  type        = string
   default     = "fri:08:00-fri:09:00"
 }
 
 variable "redis_snapshot_window" {
   description = "The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period"
+  type        = string
   default     = "06:30-07:30"
 }
 
 variable "redis_snapshot_retention_limit" {
   description = "The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro or cache.t2.* cache nodes"
+  type        = number
   default     = 0
 }
 
 variable "tags" {
-  type        = map(string)
   description = "Tags for redis nodes"
+  type        = map(string)
   default     = {}
 }