initial commit

Author: tomarv2

.gitignore

@@ -79,5 +79,5 @@ _testmain.go
 /test/run.out
 /test/times.out
 
-# ignore requried vars file
-**/test_data
+# ignore test file(s)
+**test**

README.md

@@ -1,13 +1,29 @@
-[![](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
-# terraform-aws-elasticache
-Terraform module elasticache
+<p align="center">
+    <a href="https://github.com/tomarv2/terraform-aws-elasticache/actions/workflows/security_scans.yml" alt="Security Scans">
+        <img src="https://github.com/tomarv2/terraform-aws-elasticache/actions/workflows/security_scans.yml/badge.svg?branch=main" /></a>
+    <a href="https://www.apache.org/licenses/LICENSE-2.0" alt="license">
+        <img src="https://img.shields.io/github/license/tomarv2/terraform-aws-elasticache" /></a>
+    <a href="https://github.com/tomarv2/terraform-aws-elasticache/tags" alt="GitHub tag">
+        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-aws-elasticache" /></a>
+    <a href="https://github.com/tomarv2/terraform-aws-elasticache/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/tomarv2/terraform-aws-elasticache" /></a>
+    <a href="https://stackoverflow.com/users/6679867/tomarv2" alt="Stack Exchange reputation">
+        <img src="https://img.shields.io/stackexchange/stackoverflow/r/6679867"></a>
+    <a href="https://discord.gg/XH975bzN" alt="chat on Discord">
+        <img src="https://img.shields.io/discord/813961944443912223?logo=discord"></a>
+    <a href="https://twitter.com/intent/follow?screen_name=varuntomar2019" alt="follow on Twitter">
+        <img src="https://img.shields.io/twitter/follow/varuntomar2019?style=social&logo=twitter"></a>
+</p>
+
+# Terraform module for AWS [ElastiCache]
 
 ## Versions
 
 - Module tested for Terraform 0.14.
 - AWS provider version [3.29.0](https://registry.terraform.io/providers/hashicorp/aws/latest)
 - `main` branch: Provider versions not pinned to keep up with Terraform releases
-- `tags` releases: Tags are pinned with versions (use latest tag in your releases)
+- `tags` releases: Tags are pinned with versions (use <a href="https://github.com/tomarv2/terraform-aws-elasticache/tags" alt="GitHub tag">
+        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-aws-elasticache" /></a> in your releases)
 
 **NOTE:** 
 
@@ -32,32 +48,69 @@ pip install tfremote
 export TF_AWS_BUCKET=<remote state bucket name>
 export TF_AWS_PROFILE=default
 export TF_AWS_BUCKET_REGION=us-west-2
-export PATH=$PATH:/usr/local/bin/
 ```  
 
-- Update:
-```
-example/custom/sample.tfvars
-```
+- Updated `examples` directory with required values 
 
-- Change to: 
-```
-example/base
-``` 
 
 - Run and verify the output before deploying:
 ```
-tf -cloud aws plan -var-file <path to .tfvars file>
+tf -cloud aws plan
 ```
 
 - Run below to deploy:
 ```
-tf -cloud aws apply -var-file <path to .tfvars file>
+tf -cloud aws apply
 ```
 
 - Run below to destroy:
 ```
-tf -cloud aws destroy -var-file <path to .tfvars file>
+tf -cloud aws destroy
+```
+
+> ❗️ **Important** - Two variables are required for using `tf` package:
+>
+> - teamid
+> - prjid
+>
+> These variables are required to set backend path in the remote storage.
+> Variables can be defined using:
+>
+> - As `inline variables` e.g.: `-var='teamid=demo-team' -var='prjid=demo-project'`
+> - Inside `.tfvars` file e.g.: `-var-file=<tfvars file location> `
+>
+> For more information refer to [Terraform documentation](https://www.terraform.io/docs/language/values/variables.html)
+
+##### ElastiCache with Security Group
+```
+module "redis" {
+  source = "../"
+
+  deploy_redis                 = true
+  deploy_redis_parameter_group = true
+  security_group_ids           = [module.security_group.security_group_id]
+  account_id                   = "123456789012"
+  email                        = "demo@demo.com"
+  # ----------------------------------------------
+  # Note: Do not change teamid and prjid once set.
+  teamid = var.teamid
+  prjid  = var.prjid
+}
+
+module "security_group" {
+  source = "git::git@github.com:tomarv2/terraform-aws-security-group.git?ref=v0.0.1"
+
+  deploy_security_group = true
+
+  service_ports = [6379]
+  email         = "demo@demo.com"
+  teamid        = var.teamid
+  prjid         = var.prjid
+}
 ```
 
-Please refer to example directory [link](example/README.md) for references.
+Please refer to examples directory [link](examples) for references.
+
+**Note:**
+
+- For more information on redis: [link](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/cluster-create-determine-requirements.html#redis-cluster-configuration)

elasticache.tf

@@ -0,0 +1,15 @@
+output "elasticache_id" {
+  value = module.redis.elasticache_id
+}
+
+output "elasticache_cluster_address" {
+  value = module.redis.elasticache_cluster_address
+}
+
+output "aws_elasticache_parameter_group" {
+  value = module.redis.aws_elasticache_parameter_group
+}
+
+output "security_group_id" {
+  value = module.security_group.security_group_id
+}

example/base/elasticache.tf

@@ -0,0 +1,7 @@
+# file generated by wrapper script to configure backend
+# do not edit or delete!
+
+terraform {
+  backend "s3" {
+  }
+}