Skip to content

Commit 8faa60d

Browse files
tmknomtmknom
authored
Merge pull request tmknom#15 from tmknom/update-readme
Update README
2 parents 3c546f7 + c09b7bf commit 8faa60d

File tree

1 file changed

+57
-37
lines changed

1 file changed

+57
-37
lines changed

‎README.md

+57-37
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# terraform-aws-elasticache-redis
22

3-
[![CircleCI](https://circleci.com/gh/tmknom/terraform-aws-elasticache-redis.svg?style=svg)](https://circleci.com/gh/tmknom/terraform-aws-elasticache-redis)
3+
[![Terraform Actions Status](https://github.com/tmknom/terraform-aws-elasticache-redis/workflows/Terraform/badge.svg)](https://github.com/tmknom/terraform-aws-elasticache-redis/actions?query=workflow%3ATerraform)
4+
[![Markdown Actions Status](https://github.com/tmknom/terraform-aws-elasticache-redis/workflows/Markdown/badge.svg)](https://github.com/tmknom/terraform-aws-elasticache-redis/actions?query=workflow%3AMarkdown)
5+
[![YAML Actions Status](https://github.com/tmknom/terraform-aws-elasticache-redis/workflows/YAML/badge.svg)](https://github.com/tmknom/terraform-aws-elasticache-redis/actions?query=workflow%3AYAML)
6+
[![JSON Actions Status](https://github.com/tmknom/terraform-aws-elasticache-redis/workflows/JSON/badge.svg)](https://github.com/tmknom/terraform-aws-elasticache-redis/actions?query=workflow%3AJSON)
47
[![GitHub tag](https://img.shields.io/github/tag/tmknom/terraform-aws-elasticache-redis.svg)](https://registry.terraform.io/modules/tmknom/elasticache-redis/aws)
58
[![License](https://img.shields.io/github/license/tmknom/terraform-aws-elasticache-redis.svg)](https://opensource.org/licenses/Apache-2.0)
69

@@ -25,22 +28,22 @@ This module provides recommended settings:
2528

2629
```hcl
2730
module "elasticache_redis" {
28-
source = "git::https://github.com/tmknom/terraform-aws-elasticache-redis.git?ref=tags/1.0.0"
31+
source = "git::https://github.com/tmknom/terraform-aws-elasticache-redis.git?ref=tags/2.0.0"
2932
name = "example"
3033
number_cache_clusters = 2
3134
node_type = "cache.m3.medium"
3235
33-
subnet_ids = ["${var.subnet_ids}"]
34-
vpc_id = "${var.vpc_id}"
35-
ingress_cidr_blocks = ["${var.ingress_cidr_blocks}"]
36+
subnet_ids = var.subnet_ids
37+
vpc_id = var.vpc_id
38+
ingress_cidr_blocks = var.ingress_cidr_blocks
3639
}
3740
```
3841

3942
### Complete
4043

4144
```hcl
4245
module "elasticache_redis" {
43-
source = "git::https://github.com/tmknom/terraform-aws-elasticache-redis.git?ref=tags/1.0.0"
46+
source = "git::https://github.com/tmknom/terraform-aws-elasticache-redis.git?ref=tags/2.0.0"
4447
name = "example"
4548
number_cache_clusters = 2
4649
node_type = "cache.m3.medium"
@@ -57,9 +60,9 @@ module "elasticache_redis" {
5760
family = "redis5.0"
5861
description = "This is example"
5962
60-
subnet_ids = ["${var.subnet_ids}"]
61-
vpc_id = "${var.vpc_id}"
62-
ingress_cidr_blocks = ["${var.ingress_cidr_blocks}"]
63+
subnet_ids = var.subnet_ids
64+
vpc_id = var.vpc_id
65+
ingress_cidr_blocks = var.ingress_cidr_blocks
6366
6467
tags = {
6568
Environment = "prod"
@@ -72,28 +75,42 @@ module "elasticache_redis" {
7275
- [Minimal](https://github.com/tmknom/terraform-aws-elasticache-redis/tree/master/examples/minimal)
7376
- [Complete](https://github.com/tmknom/terraform-aws-elasticache-redis/tree/master/examples/complete)
7477

78+
<!-- BEGINNING OF GENERATED BY TERRAFORM-DOCS -->
79+
80+
## Requirements
81+
82+
| Name | Version |
83+
| --------- | ------- |
84+
| terraform | >= 0.12 |
85+
86+
## Providers
87+
88+
| Name | Version |
89+
| ---- | ------- |
90+
| aws | n/a |
91+
7592
## Inputs
7693

77-
| Name | Description | Type | Default | Required |
78-
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------- | :----: | :--------------------: | :------: |
79-
| ingress_cidr_blocks | List of Ingress CIDR blocks. | list | - | yes |
80-
| name | The replication group identifier. This parameter is stored as a lowercase string. | string | - | yes |
81-
| node_type | The compute and memory capacity of the nodes in the node group. | string | - | yes |
82-
| number_cache_clusters | The number of cache clusters (primary and replicas) this replication group will have. | string | - | yes |
83-
| subnet_ids | List of VPC Subnet IDs for the cache subnet group. | list | - | yes |
84-
| vpc_id | VPC Id to associate with Redis ElastiCache. | string | - | yes |
85-
| apply_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. | string | `false` | no |
86-
| at_rest_encryption_enabled | Whether to enable encryption at rest. | string | `true` | no |
87-
| automatic_failover_enabled | Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. | string | `true` | no |
88-
| description | The description of the all resources. | string | `Managed by Terraform` | no |
89-
| engine_version | The version number of the cache engine to be used for the cache clusters in this replication group. | string | `5.0.0` | no |
90-
| family | The family of the ElastiCache parameter group. | string | `redis5.0` | no |
91-
| maintenance_window | Specifies the weekly time range for when maintenance on the cache cluster is performed. | string | `` | no |
92-
| port | The port number on which each of the cache nodes will accept connections. | string | `6379` | no |
93-
| snapshot_retention_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. | string | `30` | no |
94-
| snapshot_window | The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. | string | `` | no |
95-
| tags | A mapping of tags to assign to all resources. | map | `{}` | no |
96-
| transit_encryption_enabled | Whether to enable encryption in transit. | string | `true` | no |
94+
| Name | Description | Type | Default | Required |
95+
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------ | :------: |
96+
| ingress_cidr_blocks | List of Ingress CIDR blocks. | `list(string)` | n/a | yes |
97+
| name | The replication group identifier. This parameter is stored as a lowercase string. | `string` | n/a | yes |
98+
| node_type | The compute and memory capacity of the nodes in the node group. | `string` | n/a | yes |
99+
| number_cache_clusters | The number of cache clusters (primary and replicas) this replication group will have. | `string` | n/a | yes |
100+
| subnet_ids | List of VPC Subnet IDs for the cache subnet group. | `list(string)` | n/a | yes |
101+
| vpc_id | VPC Id to associate with Redis ElastiCache. | `string` | n/a | yes |
102+
| apply_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. | `bool` | `false` | no |
103+
| at_rest_encryption_enabled | Whether to enable encryption at rest. | `bool` | `true` | no |
104+
| automatic_failover_enabled | Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. | `bool` | `true` | no |
105+
| description | The description of the all resources. | `string` | `"Managed by Terraform"` | no |
106+
| 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 |
107+
| family | The family of the ElastiCache parameter group. | `string` | `"redis5.0"` | no |
108+
| maintenance_window | Specifies the weekly time range for when maintenance on the cache cluster is performed. | `string` | `""` | no |
109+
| port | The port number on which each of the cache nodes will accept connections. | `number` | `6379` | no |
110+
| snapshot_retention_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. | `number` | `30` | no |
111+
| snapshot_window | The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. | `string` | `""` | no |
112+
| tags | A mapping of tags to assign to all resources. | `map(string)` | `{}` | no |
113+
| transit_encryption_enabled | Whether to enable encryption in transit. | `bool` | `true` | no |
97114

98115
## Outputs
99116

@@ -112,9 +129,11 @@ module "elasticache_redis" {
112129
| security_group_owner_id | The owner ID of the Redis ElastiCache security group. |
113130
| security_group_vpc_id | The VPC ID of the Redis ElastiCache security group. |
114131

132+
<!-- END OF GENERATED BY TERRAFORM-DOCS -->
133+
115134
## Development
116135

117-
### Requirements
136+
### Development Requirements
118137

119138
- [Docker](https://www.docker.com/)
120139

@@ -137,21 +156,22 @@ make install
137156
### Makefile targets
138157

139158
```text
159+
apply-complete Run terraform apply examples/complete
160+
apply-minimal Run terraform apply examples/minimal
161+
bump-version Bump version (Required argument 'VERSION')
140162
check-format Check format code
141-
cibuild Execute CI build
142163
clean Clean .terraform
164+
destroy-complete Run terraform destroy examples/complete
165+
destroy-minimal Run terraform destroy examples/minimal
166+
diff Word diff
143167
docs Generate docs
144168
format Format code
145169
help Show help
146170
install Install requirements
147171
lint Lint code
172+
plan-complete Run terraform plan examples/complete
173+
plan-minimal Run terraform plan examples/minimal
148174
release Release GitHub and Terraform Module Registry
149-
terraform-apply-complete Run terraform apply examples/complete
150-
terraform-apply-minimal Run terraform apply examples/minimal
151-
terraform-destroy-complete Run terraform destroy examples/complete
152-
terraform-destroy-minimal Run terraform destroy examples/minimal
153-
terraform-plan-complete Run terraform plan examples/complete
154-
terraform-plan-minimal Run terraform plan examples/minimal
155175
upgrade Upgrade makefile
156176
```
157177

0 commit comments

Comments
 (0)