Merge pull request #18 from DNXLabs/feature/valkey

Add valkey support

Author: lucasmacedot

.github/workflows/docs.yml

@@ -5,15 +5,15 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-      with:
-        ref: ${{ github.head_ref }}
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
 
-    - name: Render terraform docs inside the README.md and push changes back to pushed branch
-      uses: DNXLabs/[email protected]
-      with:
-        tf_docs_working_dir: .
-        tf_docs_output_file: README.md
-        tf_docs_output_method: inject
-        tf_docs_git_push: 'true'
-        tf_docs_git_commit_message: 'terraform-docs: automated update action'
+      - name: Render terraform docs inside the README.md and push changes back to pushed branch
+        uses: DNXLabs/[email protected]
+        with:
+          tf_docs_working_dir: .
+          tf_docs_output_file: README.md
+          tf_docs_output_method: inject
+          tf_docs_git_push: "true"
+          tf_docs_git_commit_message: "terraform-docs: automated update action"

.github/workflows/documentation.yml

@@ -9,15 +9,15 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-      with:
-        ref: master
+      - uses: actions/checkout@v4
+        with:
+          ref: master
 
-    - name: Render terraform docs inside the README.md and push changes back to pushed branch
-      uses: DNXLabs/[email protected]
-      with:
-        tf_docs_working_dir: .
-        tf_docs_output_file: README.md
-        tf_docs_output_method: inject
-        tf_docs_git_push: 'true'
-        tf_docs_git_commit_message: 'terraform-docs: automated update action'
+      - name: Render terraform docs inside the README.md and push changes back to pushed branch
+        uses: DNXLabs/[email protected]
+        with:
+          tf_docs_working_dir: .
+          tf_docs_output_file: README.md
+          tf_docs_output_method: inject
+          tf_docs_git_push: "true"
+          tf_docs_git_commit_message: "terraform-docs: automated update action"

.github/workflows/lint.yml

@@ -7,7 +7,7 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
       - name: TFLint
         uses: docker://wata727/tflint
 
@@ -17,7 +17,7 @@ jobs:
     container:
       image: hashicorp/terraform:latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
       - run: terraform fmt --recursive -check=true
 
   validate:
@@ -26,15 +26,15 @@ jobs:
     container:
       image: hashicorp/terraform:latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
       - name: Validate Code
         env:
-          AWS_REGION: 'us-east-1'
+          AWS_REGION: "us-east-1"
           TF_WARN_OUTPUT_ERRORS: 1
-          TF_VAR_vpc_id: 'vpc-123456'
+          TF_VAR_vpc_id: "vpc-123456"
           TF_VAR_subnets: '["subnet-12345a"]'
-          TF_VAR_workers_ami_id: 'ami-123456'
-          TF_VAR_cluster_name: 'test_cluster'
+          TF_VAR_workers_ami_id: "ami-123456"
+          TF_VAR_cluster_name: "test_cluster"
         run: |
           terraform init
           terraform validate
@@ -46,18 +46,19 @@ jobs:
             terraform validate
             cd -
           done
+
   minimum:
     name: Minimum version check
     runs-on: ubuntu-latest
     container:
-      image: hashicorp/terraform:0.13.0
+      image: hashicorp/terraform:1.10.0
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
       - name: Validate Code
         env:
-          AWS_REGION: 'us-east-1'
+          AWS_REGION: "us-east-1"
           TF_WARN_OUTPUT_ERRORS: 1
         run: |
-          sed -i -e 's/>=/=/' -e 's/ \(\d\+\.\d\+\)"/ \1.0"/' versions.tf
+          sed -i -e 's/>=/=/' -e 's/ \(\d\+\.\d\+\)"/ \1.0"/' _versions.tf
           terraform init
-          terraform validate -var "region=${AWS_REGION}" -var "vpc_id=vpc-123456" -var "subnets=[\"subnet-12345a\"]" -var "workers_ami_id=ami-123456" -var "cluster_ingress_cidrs=[]" -var "cluster_name=test_cluster"
+          terraform validate -var "region=${AWS_REGION}" -var "vpc_id=vpc-123456" -var "subnets=[\"subnet-12345a\"]" -var "workers_ami_id=ami-123456" -var "cluster_ingress_cidrs=[]" -var "cluster_name=test_cluster"

.github/workflows/scan.yml

@@ -0,0 +1,18 @@
+# name: Scan
+
+# on: [push]
+
+# permissions: read-all
+
+# jobs:
+#   scan:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Checkout repo
+#         uses: actions/checkout@v4
+#       - name: Run Checkov action
+#         id: checkov
+#         uses: bridgecrewio/checkov-action@v12
+#         with:
+#           directory: .
+#           framework: terraform

.github/workflows/test.yml

@@ -0,0 +1,13 @@
+# name: Lint
+
+# on: [push]
+
+# jobs:
+#   test:
+#     name: Run Tests
+#     runs-on: ubuntu-latest
+#     container:
+#       image: hashicorp/terraform:latest
+#     steps:
+#       - uses: actions/checkout@v4
+#       - run: terraform test

.gitignore

@@ -0,0 +1,2 @@
+module
+.terraform

.terraform.lock.hcl

@@ -35,7 +35,7 @@ module "redis" {
   redis_port                     = try(each.value.redis_port, 6379)
   redis_snapshot_retention_limit = try(each.value.redis_snapshot_retention_limit, 0)
   redis_snapshot_window          = try(each.value.redis_snapshot_window, "06:30-07:30") # "The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster."
-  redis_version                  = try(each.value.redis_version, "3.2.10")              # "Whether to enable encryption in transit. Requires 3.2.6 or >=4.0 redis_version"
+  engine_version                  = try(each.value.engine_version, "3.2.10")              # "Whether to enable encryption in transit. Requires 3.2.6 or >=4.0 engine_version"
   snapshot_arns                  = try(each.value.snapshot_arns, [])                    # "A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. Example: arn:aws:s3:::my_bucket/snapshot1.rdb"
   snapshot_name                  = try(each.value.snapshot_name, "")                    # " The name of a snapshot from which to restore data into the new node group. Changing the snapshot_name forces a new resource"
   tags                           = try(each.value.tags, {})

README.md

@@ -1,3 +1,3 @@
 locals {
-  major_version = tonumber(replace(var.redis_version, "/\\.[\\d][\\.\\d]*/", ""))
+  major_version = tonumber(replace(var.engine_version, "/\\.[\\d][\\.\\d]*/", ""))
 }

_locals.tf

@@ -22,7 +22,6 @@ variable "subnet_tags_filter" {
   }
 }
 
-
 variable "apply_immediately" {
   description = "Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false."
   type        = bool
@@ -59,84 +58,93 @@ variable "name" {
   type        = string
 }
 
-variable "redis_clusters" {
+variable "number_clusters" {
   description = "Number of Redis cache clusters (nodes) to create"
   type        = string
+  default     = 0
 }
 
-variable "redis_cluster_enable" {
+variable "cluster_enabled" {
   description = "Enable or disable cluster mode"
   type        = bool
   default     = false
 }
 
-variable "redis_cluster_num_node_groups" {
+variable "cluster_num_node_groups" {
   description = "Number of node groups"
   type        = number
   default     = 2
 }
 
-variable "redis_cluster_replicas_per_node_group" {
+variable "cluster_replicas_per_node_group" {
   description = "Replicas per node group"
   type        = number
   default     = 1
 }
 
-
-
-variable "redis_failover" {
-  type    = bool
-  default = false
+variable "failover_enabled" {
+  type        = bool
+  default     = false
+  description = "If the cache cluster should have failover enabled"
 }
 
 variable "multi_az_enabled" {
-  type    = bool
-  default = false
+  type        = bool
+  default     = false
+  description = "If the cache cluster should be multi-az"
 }
 
-variable "redis_node_type" {
+variable "node_type" {
   description = "Instance type to use for creating the Redis cache clusters"
   type        = string
-  default     = "cache.m3.medium"
+  default     = "cache.t4g.micro"
 }
 
-variable "redis_port" {
-  type    = number
-  default = 6379
+variable "port" {
+  type        = number
+  description = "Port to use on cache. 6379 for Redis, 11211 for memcached."
+  default     = 6379
 }
 
 variable "vpc_id" {
   type        = string
   description = "Vpc Id"
 }
 
-# might want a map
-variable "redis_version" {
+variable "engine" {
+  type    = string
+  default = "redis"
+  validation {
+    condition     = contains(["redis", "valkey"], var.engine)
+    error_message = "Only 'redis' or 'valkey' is supported."
+  }
+}
+
+variable "engine_version" {
   description = "Redis version to use, defaults to 3.2.10"
   type        = string
   default     = "6.2"
 }
 
-
 variable "redis_parameters" {
   description = "additional parameters modifyed in parameter group"
   type        = list(map(any))
   default     = []
 }
 
-variable "redis_maintenance_window" {
+variable "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" {
+variable "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" {
+variable "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
@@ -163,7 +171,7 @@ variable "availability_zones" {
 variable "at_rest_encryption_enabled" {
   description = "Whether to enable encryption at rest"
   type        = bool
-  default     = false
+  default     = true
 }
 
 variable "kms_key_id" {
@@ -173,7 +181,7 @@ variable "kms_key_id" {
 }
 
 variable "transit_encryption_enabled" {
-  description = "Whether to enable encryption in transit. Requires 3.2.6 or >=4.0 redis_version"
+  description = "Whether to enable encryption in transit. Requires 3.2.6 or >=4.0 engine_version"
   type        = bool
   default     = false
 }
@@ -220,12 +228,14 @@ variable "user_group_ids" {
   default     = null
 }
 
-variable "create_redis_subnet_group" {
-  description = "Create a Subnet group?"
+variable "create_subnet_group" {
+  description = "If the module should create a Subnet group"
+  type        = bool
   default     = true
 }
 
-variable "redis_subnet_group_id" {
-  description = "Redis subnet group id"
+variable "subnet_group_id" {
+  description = "Subnet group ID to use for the replication group"
   type        = string
+  default     = null
 }

variables.tf _variables.tf

@@ -0,0 +1,9 @@
+terraform {
+  required_version = "> 1.3.0"
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "> 5.0.0"
+    }
+  }
+}