Skip to content

Commit f3d744f

Browse files
committed
update README.md
1 parent fc5a98b commit f3d744f

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
Terraform AWS Elasticache
88
</h1>
99

10-
<p align="center" style="font-size: 1.2rem;">
10+
<p align="center" style="font-size: 1.2rem;">
1111
Terraform module to create Elasticache Cluster and replica for Redis and Memcache.
1212
</p>
1313

1414
<p align="center">
1515

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/terraform-v0.14-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/terraform-v0.15-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
2020
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
@@ -38,7 +38,7 @@
3838
<hr>
3939

4040

41-
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
41+
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
4242

4343
This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
4444

@@ -49,7 +49,7 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
4949

5050
## Prerequisites
5151

52-
This module has a few dependencies:
52+
This module has a few dependencies:
5353

5454
- [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
5555
- [Go](https://golang.org/doc/install)
@@ -73,11 +73,10 @@ Here are some examples of how you can use this module in your inventory structur
7373
```hcl
7474
module "redis" {
7575
source = "clouddrove/elasticache/aws
76-
version = "0.14.0"
76+
version = "0.15.0"
7777
name = "redis"
78-
repository = "https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"
7978
environment = "test"
80-
label_order = ["environment", "application", "name"]
79+
label_order = ["environment", "name"]
8180
engine = "redis"
8281
engine_version = "5.0.0"
8382
family = "redis5.0"
@@ -95,11 +94,10 @@ Here are some examples of how you can use this module in your inventory structur
9594
```hcl
9695
module "redis-cluster" {
9796
source = "clouddrove/elasticache/aws
98-
version = "0.14.0"
97+
version = "0.15.0"
9998
name = "cluster"
100-
repository = "https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"
10199
environment = "test"
102-
label_order = ["environment", "application", "name"]
100+
label_order = ["environment","name"]
103101
cluster_replication_enabled = true
104102
engine = "redis"
105103
engine_version = "5.0.0"
@@ -119,11 +117,10 @@ Here are some examples of how you can use this module in your inventory structur
119117
```hcl
120118
module "memcached" {
121119
source = "clouddrove/elasticache/aws
122-
version = "0.14.0"
120+
version = "0.15.0"
123121
name = "memcached"
124-
repository = "https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"
125122
environment = "test"
126-
label_order = ["environment", "application", "name"]
123+
label_order = ["environment", "name"]
127124
cluster_enabled = true
128125
engine = "memcached"
129126
engine_version = "1.5.10"
@@ -173,17 +170,17 @@ Here are some examples of how you can use this module in your inventory structur
173170
| num\_cache\_nodes | (Required unless replication\_group\_id is provided) The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcache, this value must be between 1 and 20. If this number is reduced on subsequent runs, the highest numbered nodes will be removed. | `number` | `1` | no |
174171
| num\_node\_groups | Number of Shards (nodes). | `string` | `""` | no |
175172
| number\_cache\_clusters | (Required for Cluster Mode Disabled) The number of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications. | `string` | `""` | no |
176-
| parameter\_group\_name | The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. | `string` | `""` | no |
173+
| parameter\_group\_name | The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. | `string` | `"default.redis5.0"` | no |
177174
| port | the port number on which each of the cache nodes will accept connections. | `string` | `""` | no |
178175
| replicas\_per\_node\_group | Replicas per Shard. | `string` | `""` | no |
179176
| replication\_enabled | (Redis only) Enabled or disabled replication\_group for redis standalone instance. | `bool` | `false` | no |
180177
| replication\_group\_id | The replication group identifier This parameter is stored as a lowercase string. | `string` | `""` | no |
181-
| repository | Terraform current module repo | `string` | `"https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"` | no |
178+
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-elasticache"` | no |
182179
| security\_group\_ids | One or more VPC security groups associated with the cache cluster. | `list` | `[]` | no |
183180
| security\_group\_names | A list of cache security group names to associate with this replication group. | `any` | `null` | no |
184181
| snapshot\_arns | A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. | `any` | `null` | no |
185182
| 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. | `string` | `""` | no |
186-
| snapshot\_retention\_limit | (Redis only) 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. | `any` | `null` | no |
183+
| snapshot\_retention\_limit | (Redis only) 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 |
187184
| snapshot\_window | (Redis only) 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. | `any` | `null` | no |
188185
| subnet\_ids | List of VPC Subnet IDs for the cache subnet group. | `list` | `[]` | no |
189186
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
@@ -203,7 +200,7 @@ Here are some examples of how you can use this module in your inventory structur
203200

204201

205202
## Testing
206-
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
203+
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
207204

208205
You need to run the following command in the testing folder:
209206
```hcl
@@ -212,7 +209,7 @@ You need to run the following command in the testing folder:
212209

213210

214211

215-
## Feedback
212+
## Feedback
216213
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-elasticache/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
217214

218215
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-elasticache)!

0 commit comments

Comments
 (0)