test

Author: tomarv2

.gitignore

@@ -29,4 +29,55 @@ override.tf.json
 # example: *tfplan*
 
 .idea/
-.terraform.lock.hcl
+.terraform.lock.hcl
+
+# go
+.DS_Store
+*.[56789ao]
+*.a[56789o]
+*.so
+*.pyc
+._*
+.nfs.*
+[56789a].out
+*~
+*.orig
+*.rej
+*.exe
+.*.swp
+core
+*.cgo*.go
+*.cgo*.c
+_cgo_*
+_obj
+_test
+_testmain.go
+
+/VERSION.cache
+/bin/
+/build.out
+/doc/articles/wiki/*.bin
+/goinstall.log
+/last-change
+/misc/cgo/life/run.out
+/misc/cgo/stdio/run.out
+/misc/cgo/testso/main
+/pkg/
+/src/*.*/
+/src/cmd/cgo/zdefaultcc.go
+/src/cmd/dist/dist
+/src/cmd/go/internal/cfg/zdefaultcc.go
+/src/cmd/go/internal/cfg/zosarch.go
+/src/cmd/internal/objabi/zbootstrap.go
+/src/go/build/zcgo.go
+/src/go/doc/headscan
+/src/runtime/internal/sys/zversion.go
+/src/unicode/maketables
+/test.out
+/test/garbage/*.out
+/test/pass.out
+/test/run.out
+/test/times.out
+
+# ignore requried vars file
+**/test_data

README.md

@@ -1,2 +1,63 @@
+[![](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 # terraform-aws-elasticache
 Terraform module 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)
+
+**NOTE:** 
+
+- Read more on [tfremote](https://github.com/tomarv2/tfremote)
+
+## Usage
+
+Recommended method:
+
+- Create python 3.6+ virtual environment 
+```
+python3 -m venv <venv name>
+```
+
+- Install package:
+```
+pip install tfremote
+```
+
+- Set below environment variables:
+```
+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
+```
+
+- Change to: 
+```
+example/base
+``` 
+
+- Run and verify the output before deploying:
+```
+tf -cloud aws plan -var-file <path to .tfvars file>
+```
+
+- Run below to deploy:
+```
+tf -cloud aws apply -var-file <path to .tfvars file>
+```
+
+- Run below to destroy:
+```
+tf -cloud aws destroy -var-file <path to .tfvars file>
+```
+
+Please refer to example directory [link](example/README.md) for references.