├── .circleci └── config.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── main.tf ├── outputs.tf ├── scripts └── cibuild └── variables.tf /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | jobs: 4 | build: 5 | docker: 6 | - image: hashicorp/terraform:latest 7 | 8 | steps: 9 | - checkout 10 | - run: 11 | name: Install Bash 12 | command: apk add --no-cache bash 13 | - run: 14 | name: Execute cibuild 15 | command: ./scripts/cibuild 16 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 2.0.1 2 | 3 | - Fix default value for ElastiCache parameter group. 4 | 5 | ## 2.0.0 6 | 7 | - Break backward compatibility again by swapping out the `aws_elasticache_cluster` resource with `aws_elasticache_replication_group`. 8 | - Remove `aws_elasticache_subnet_group`. 9 | 10 | ## 1.0.0 11 | 12 | - Break backward compatibility by removing the default security group rules 13 | that open `6379` to the VPC CIDR range. Module consumers and add their own 14 | rules via the `security_group_rule` resource. 15 | - Add `cache_security_group_id` as a module output. 16 | 17 | ## 0.3.0 18 | 19 | - Add cache name to alarm names so multiple instances do not conflict within 20 | the same AWS account. 21 | - Apply `hclfmt`. 22 | 23 | ## 0.2.0 24 | 25 | - Remove hardcoded identifiers and interpolate the new `cache_name` variable to 26 | create unique resource names. 27 | 28 | ## 0.1.0 29 | 30 | - Initial release. 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2019 Azavea Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # terraform-aws-redis-elasticache 2 | 3 | [![CircleCI](https://circleci.com/gh/azavea/terraform-aws-redis-elasticache.svg?style=svg)](https://circleci.com/gh/azavea/terraform-aws-redis-elasticache) 4 | 5 | A Terraform module to create an Amazon Web Services (AWS) Redis ElastiCache cluster. 6 | 7 | ## Usage 8 | 9 | ```hcl 10 | resource "aws_sns_topic" "global" { 11 | ... 12 | } 13 | 14 | resource "aws_elasticache_subnet_group" "redis" { 15 | ... 16 | } 17 | 18 | resource "aws_elasticache_parameter_group" "redis" { 19 | ... 20 | } 21 | 22 | module "cache" { 23 | source = "github.com/azavea/terraform-aws-redis-elasticache" 24 | 25 | vpc_id = "vpc-20f74844" 26 | cache_identifier = "cache" 27 | automatic_failover_enabled = "false" 28 | desired_clusters = "1" 29 | instance_type = "cache.t2.micro" 30 | engine_version = "3.2.4" 31 | parameter_group = "${aws_elasticache_parameter_group.redis.name}" 32 | subnet_group = "${aws_elasticache_subnet_group.redis.name}" 33 | maintenance_window = "sun:02:30-sun:03:30" 34 | notification_topic_arn = "${aws_sns_topic.global.arn}" 35 | 36 | alarm_cpu_threshold = "75" 37 | alarm_memory_threshold = "10000000" 38 | alarm_actions = ["${aws_sns_topic.global.arn}"] 39 | 40 | project = "Unknown" 41 | environment = "Unknown" 42 | } 43 | ``` 44 | 45 | ## Variables 46 | 47 | - `vpc_id` - ID of VPC meant to house the cache 48 | - `project` - Name of the project making use of the cluster (default: `Unknown`) 49 | - `environment` - Name of environment the cluster is targeted for (default: `Unknown`) 50 | - `cache_identifier` - Name used as ElastiCache cluster ID 51 | - `automatic_failover_enabled` - Flag to determine if automatic failover should be enabled 52 | - `desired_clusters` - Number of cache clusters in replication group 53 | - `instance_type` - Instance type for cache instance (default: `cache.t2.micro`) 54 | - `engine_version` - Cache engine version (default: `3.2.4`) 55 | - `parameter_group` - Cache parameter group name (default: `redis3.2`) 56 | - `subnet_group` - Cache subnet group name 57 | - `maintenance_window` - Time window to reserve for maintenance 58 | - `notification_topic_arn` - ARN to notify when cache events occur 59 | - `alarm_cpu_threshold` - CPU alarm threshold as a percentage (default: `75`) 60 | - `alarm_memory_threshold` - Free memory alarm threshold in bytes (default: `10000000`) 61 | - `alarm_actions` - ARN to be notified via CloudWatch when alarm thresholds are triggered 62 | 63 | ## Outputs 64 | 65 | - `id` - The replication group ID 66 | - `cache_security_group_id` - Security group ID of the cache cluster 67 | - `port` - Port of replication group leader 68 | - `endpoint` - Public DNS name of replication group leader 69 | -------------------------------------------------------------------------------- /main.tf: -------------------------------------------------------------------------------- 1 | # 2 | # Security group resources 3 | # 4 | resource "aws_security_group" "redis" { 5 | vpc_id = "${var.vpc_id}" 6 | 7 | tags { 8 | Name = "sgCacheCluster" 9 | Project = "${var.project}" 10 | Environment = "${var.environment}" 11 | } 12 | } 13 | 14 | # 15 | # ElastiCache resources 16 | # 17 | resource "aws_elasticache_replication_group" "redis" { 18 | replication_group_id = "${lower(var.cache_identifier)}" 19 | replication_group_description = "Replication group for Redis" 20 | automatic_failover_enabled = "${var.automatic_failover_enabled}" 21 | number_cache_clusters = "${var.desired_clusters}" 22 | node_type = "${var.instance_type}" 23 | engine_version = "${var.engine_version}" 24 | parameter_group_name = "${var.parameter_group}" 25 | subnet_group_name = "${var.subnet_group}" 26 | security_group_ids = ["${aws_security_group.redis.id}"] 27 | maintenance_window = "${var.maintenance_window}" 28 | notification_topic_arn = "${var.notification_topic_arn}" 29 | port = "6379" 30 | 31 | tags { 32 | Name = "CacheReplicationGroup" 33 | Project = "${var.project}" 34 | Environment = "${var.environment}" 35 | } 36 | } 37 | 38 | # 39 | # CloudWatch resources 40 | # 41 | resource "aws_cloudwatch_metric_alarm" "cache_cpu" { 42 | count = "${var.desired_clusters}" 43 | 44 | alarm_name = "alarm${var.environment}CacheCluster00${count.index + 1}CPUUtilization" 45 | alarm_description = "Redis cluster CPU utilization" 46 | comparison_operator = "GreaterThanThreshold" 47 | evaluation_periods = "1" 48 | metric_name = "CPUUtilization" 49 | namespace = "AWS/ElastiCache" 50 | period = "300" 51 | statistic = "Average" 52 | 53 | threshold = "${var.alarm_cpu_threshold}" 54 | 55 | dimensions { 56 | CacheClusterId = "${aws_elasticache_replication_group.redis.id}-00${count.index + 1}" 57 | } 58 | 59 | alarm_actions = ["${var.alarm_actions}"] 60 | } 61 | 62 | resource "aws_cloudwatch_metric_alarm" "cache_memory" { 63 | count = "${var.desired_clusters}" 64 | 65 | alarm_name = "alarm${var.environment}CacheCluster00${count.index + 1}FreeableMemory" 66 | alarm_description = "Redis cluster freeable memory" 67 | comparison_operator = "LessThanThreshold" 68 | evaluation_periods = "1" 69 | metric_name = "FreeableMemory" 70 | namespace = "AWS/ElastiCache" 71 | period = "60" 72 | statistic = "Average" 73 | 74 | threshold = "${var.alarm_memory_threshold}" 75 | 76 | dimensions { 77 | CacheClusterId = "${aws_elasticache_replication_group.redis.id}-00${count.index + 1}" 78 | } 79 | 80 | alarm_actions = ["${var.alarm_actions}"] 81 | } 82 | -------------------------------------------------------------------------------- /outputs.tf: -------------------------------------------------------------------------------- 1 | output "id" { 2 | value = "${aws_elasticache_replication_group.redis.id}" 3 | } 4 | 5 | output "cache_security_group_id" { 6 | value = "${aws_security_group.redis.id}" 7 | } 8 | 9 | output "port" { 10 | value = "6379" 11 | } 12 | 13 | output "endpoint" { 14 | value = "${aws_elasticache_replication_group.redis.primary_endpoint_address}" 15 | } 16 | -------------------------------------------------------------------------------- /scripts/cibuild: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -e 4 | 5 | if [[ -n "${CI_DEBUG}" ]]; then 6 | set -x 7 | fi 8 | 9 | function usage() { 10 | echo -n \ 11 | "Usage: $(basename "$0") 12 | Ensure the Terraform source code is properly formatted. 13 | " 14 | } 15 | 16 | if [ "${BASH_SOURCE[0]}" = "${0}" ]; then 17 | if [ "${1:-}" = "--help" ]; then 18 | usage 19 | else 20 | terraform fmt -check 21 | fi 22 | fi 23 | -------------------------------------------------------------------------------- /variables.tf: -------------------------------------------------------------------------------- 1 | variable "project" { 2 | default = "Unknown" 3 | } 4 | 5 | variable "environment" { 6 | default = "Unknown" 7 | } 8 | 9 | variable "vpc_id" {} 10 | 11 | variable "cache_identifier" {} 12 | 13 | variable "parameter_group" { 14 | default = "default.redis3.2" 15 | } 16 | 17 | variable "subnet_group" {} 18 | 19 | variable "maintenance_window" {} 20 | 21 | variable "desired_clusters" { 22 | default = "1" 23 | } 24 | 25 | variable "instance_type" { 26 | default = "cache.t2.micro" 27 | } 28 | 29 | variable "engine_version" { 30 | default = "3.2.4" 31 | } 32 | 33 | variable "automatic_failover_enabled" { 34 | default = false 35 | } 36 | 37 | variable "notification_topic_arn" {} 38 | 39 | variable "alarm_cpu_threshold" { 40 | default = "75" 41 | } 42 | 43 | variable "alarm_memory_threshold" { 44 | # 10MB 45 | default = "10000000" 46 | } 47 | 48 | variable "alarm_actions" { 49 | type = "list" 50 | } 51 | --------------------------------------------------------------------------------