Documentation + Examples cleanup (#33)

* Update terraform versions

* Use t4g instance sizes for examples + Update minimum redis version from 5.x to 6.x

* chore: update changelog + hooks

Author: Abdul Wahid

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
     args: ['--allow-missing-credentials']
   - id: trailing-whitespace
 - repo: https://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.73.0
+  rev: v1.74.0
   hooks:
   - id: terraform_fmt
   - id: terraform_docs

CHANGELOG.md

@@ -5,15 +5,28 @@ All notable changes to this project will be documented in this file.
 <a name="unreleased"></a>
 ## [Unreleased]
 
-- Update README and basic example
-- Allow to configure for ingress from other SGs
-- Support Redis log delivery ([#26](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/26))
-- Support Data Tiering Feature for r6gd nodes
+- Use t4g instance sizes for examples + Update minimum redis version from 5.x to 6.x
+- Update terraform versions
+- Add Data Tiering support ([#32](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/32))
 
-<a name="3.0.0"></a>
-## [3.0.0] - 2022-03-09
 
-- Upgrade module to be compatible with AWS Provider 4.0.0 ([#21](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/21))
+<a name="3.1.2"></a>
+## [3.1.2] - 2022-05-26
+
+- fix example in README ([#30](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/30))
+
+
+<a name="3.1.1"></a>
+## [3.1.1] - 2022-05-12
+
+- Fix outputs for endpoints ([#29](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/29))
+
+
+<a name="3.1.0"></a>
+## [3.1.0] - 2022-05-12
+
+- Allow other sg ingress ([#24](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/24))
+- Support Redis log delivery ([#26](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/26))
 
 
 <a name="3.0.0"></a>
@@ -112,7 +125,10 @@ All notable changes to this project will be documented in this file.
 - Initial commit of docs
 
 
-[Unreleased]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/3.0.0...HEAD
+[Unreleased]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/3.1.2...HEAD
+[3.1.2]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/3.1.1...3.1.2
+[3.1.1]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/3.1.0...3.1.1
+[3.1.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/2.2.0...3.0.0
 [2.2.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/2.0.0...2.1.0

README.md

@@ -20,7 +20,7 @@ module "redis" {
 
   name_prefix           = "core-example"
   num_cache_clusters    = 2
-  node_type             = "cache.t3.small"
+  node_type             = "cache.t4g.small"
 
   engine_version           = "6.x"
   port                     = 6379
@@ -73,23 +73,23 @@ module "redis" {
 
 ## Authors
 
-Module managed by [Abdul Wahid](https://github.com/Ohid25) ([LinkedIn](https://www.linkedin.com/in/abdul-wahid/))
+Module managed by [uMotif](https://github.com/umotif-public/)
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.14.11 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.8.0 |
-| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.1.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.11 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.8.0, < 5.0.0 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.3.2, < 4.0.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.8.0 |
-| <a name="provider_random"></a> [random](#provider\_random) | >= 3.1.0 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.8.0, < 5.0.0 |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 3.3.2, < 4.0.0 |
 
 ## Modules
 
@@ -122,8 +122,8 @@ No modules.
 | <a name="input_cluster_mode_enabled"></a> [cluster\_mode\_enabled](#input\_cluster\_mode\_enabled) | Enable creation of a native redis cluster. | `bool` | `false` | no |
 | <a name="input_data_tiering_enabled"></a> [data\_tiering\_enabled](#input\_data\_tiering\_enabled) | Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. | `bool` | `false` | no |
 | <a name="input_description"></a> [description](#input\_description) | The description of the all resources. | `string` | `"Managed by Terraform"` | no |
-| <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | The version number of the cache engine to be used for the cache clusters in this replication group. | `string` | `"5.0.6"` | no |
-| <a name="input_family"></a> [family](#input\_family) | The family of the ElastiCache parameter group. | `string` | `"redis5.0"` | no |
+| <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | The version number of the cache engine to be used for the cache clusters in this replication group. | `string` | `"6.x"` | no |
+| <a name="input_family"></a> [family](#input\_family) | The family of the ElastiCache parameter group. | `string` | `"redis6.x"` | no |
 | <a name="input_final_snapshot_identifier"></a> [final\_snapshot\_identifier](#input\_final\_snapshot\_identifier) | The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made. | `string` | `null` | no |
 | <a name="input_global_replication_group_id"></a> [global\_replication\_group\_id](#input\_global\_replication\_group\_id) | The ID of the global replication group to which this replication group should belong. | `string` | `null` | no |
 | <a name="input_ingress_cidr_blocks"></a> [ingress\_cidr\_blocks](#input\_ingress\_cidr\_blocks) | List of Ingress CIDR blocks. | `list(string)` | `[]` | no |

examples/redis-basic/main.tf

@@ -34,7 +34,7 @@ module "redis" {
 
   name_prefix        = "redis-basic-example"
   num_cache_clusters = 2
-  node_type          = "cache.t3.small"
+  node_type          = "cache.t4g.small"
 
   engine_version            = "6.x"
   port                      = 6379

examples/redis-clustered-mode/main.tf

@@ -24,7 +24,7 @@ module "redis" {
 
   name_prefix        = "redis-clustered-example"
   num_cache_clusters = 2
-  node_type          = "cache.t3.small"
+  node_type          = "cache.t4g.small"
 
   cluster_mode_enabled    = true
   replicas_per_node_group = 1

variables.tf

@@ -49,7 +49,7 @@ variable "security_group_ids" {
 }
 
 variable "engine_version" {
-  default     = "5.0.6"
+  default     = "6.x"
   type        = string
   description = "The version number of the cache engine to be used for the cache clusters in this replication group."
 }
@@ -108,7 +108,7 @@ variable "apply_immediately" {
 }
 
 variable "family" {
-  default     = "redis5.0"
+  default     = "redis6.x"
   type        = string
   description = "The family of the ElastiCache parameter group."
 }
@@ -219,4 +219,4 @@ variable "data_tiering_enabled" {
   type        = bool
   default     = false
   description = "Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes."
-}
+}

versions.tf

@@ -1,8 +1,8 @@
 terraform {
-  required_version = ">= 0.14.11"
+  required_version = ">= 1.0.11"
 
   required_providers {
-    aws    = ">= 4.8.0"
-    random = ">= 3.1.0"
+    aws    = ">= 4.8.0, < 5.0.0"
+    random = ">= 3.3.2, < 4.0.0"
   }
 }