Merge pull request #1 from pbs/initial_setup

Initial Setup

Author: yhakbar

.gitignore

@@ -2,5 +2,4 @@
 .DS_Store
 target
 CHANGELOG.md
-*.tfstate
-*.tfstate.backup
+*tfstate*

README-HEADER.md

@@ -1,4 +1,4 @@
-# PBS TF MOD_TITLE
+# PBS TF ElastiCache Redis Standalone Module
 
 ## Installation
 
@@ -7,7 +7,7 @@
 Use this URL for the source of the module. See the usage examples below for more details.
 
 ```hcl
-github.com/pbs/terraform-aws-MOD_NAME?ref=x.y.z
+github.com/pbs/terraform-aws-elasticache-redis-standalone-module?ref=x.y.z
 ```
 
 ### Alternative Installation Methods
@@ -16,20 +16,17 @@ More information can be found on these install methods and more in [the document
 
 ## Usage
 
-<!-- TODO -->
-This should be a basic description of what this module does.
-Fill this out before completing usage of this template.
-<!-- TODO -->
+Provisions an Elasticache Redis cluster (with Cluster Mode Disabled).
+
+> ℹ️ Note the confusing terminology around `Cluster Mode`. The `Cluster Mode` setting is a Redis feature that allows data to be sharded among nodes in a cluster, and requires some additional configuration to connect with it correctly. A Redis cluster that does not have `Cluster Mode` enabled is a set of standalone Redis nodes that have a single primary node for reading and writing and replica nodes for reading.
+
+By default, it will provision one writer and one reader node, but that can be adjusted by setting the `nodes` variable to a different value.
 
 Integrate this module like so:
 
 ```hcl
-module "MOD_SHORTNAME" {
-  source = "github.com/pbs/terraform-aws-MOD_NAME?ref=x.y.z"
-
-  <!-- TODO -->
-  Show some examples of valid values for required parameters.
-  <!-- TODO -->
+module "elasticache-redis-standalone" {
+  source = "github.com/pbs/terraform-aws-elasticache-redis-standalone-module?ref=x.y.z"
 
   # Tagging Parameters
   organization = var.organization

README.md

@@ -0,0 +1,15 @@
+data "aws_vpc" "vpc" {
+  count = var.vpc_id == null ? 1 : 0
+  tags  = local.vpc_data_lookup_tags
+}
+
+data "aws_subnets" "private_subnets" {
+  count = var.subnets == null ? 1 : 0
+  dynamic "filter" {
+    for_each = local.subnet_data_lookup_filters
+    content {
+      name   = filter.key
+      values = filter.value
+    }
+  }
+}

data.tf

@@ -11,8 +11,8 @@ All the techniques for installing modules are based around the ways that Terrafo
 Assuming you don't have manual modifications that you need to make to serve the purposes of an application, the most convenient method of integrating modules might be by using the repo source of this module like so:
 
 ```hcl
-module "MOD_SHORTNAME" {
-    source = "github.com/pbs/terraform-MOD_NAME?ref=x.y.z"
+module "elasticache-redis-standalone" {
+    source = "github.com/pbs/terraform-elasticache-redis-standalone-module?ref=x.y.z"
 }
 ```
 
@@ -29,9 +29,9 @@ Note that the provider being used might also have availability or security impli
 You can install the minified module directly in your repo manually like so:
 
 ```bash
-mkdir -p 'terraform/modules/MOD_SHORTNAME'
-gh -R 'pbs/terraform-MOD_NAME' release download -p 'release.tar.gz' x.y.z
-tar -xvf release.tar.gz -C 'terraform/modules/MOD_SHORTNAME'
+mkdir -p 'terraform/modules/elasticache-redis-standalone'
+gh -R 'pbs/terraform-elasticache-redis-standalone-module' release download -p 'release.tar.gz' x.y.z
+tar -xvf release.tar.gz -C 'terraform/modules/elasticache-redis-standalone'
 rm -f release.tar.gz
 ```
 
@@ -46,14 +46,14 @@ Please [read this][atlassian-subtree] for information about Git Subtrees, as tha
 The simplest use case would work like so:
 
 ```bash
-git remote add -f MOD_SHORTNAME [email protected]:pbs/terraform-MOD_NAME.git
-git subtree add --prefix terraform/modules/MOD_SHORTNAME MOD_SHORTNAME main --squash
+git remote add -f elasticache-redis-standalone [email protected]:pbs/terraform-elasticache-redis-standalone-module.git
+git subtree add --prefix terraform/modules/elasticache-redis-standalone elasticache-redis-standalone main --squash
 ```
 
 If necessary, pin the repo version, rather than adding `main` as your subtree:
 
 ```bash
-git subtree add --prefix terraform/modules/MOD_SHORTNAME MOD_SHORTNAME $REF --squash
+git subtree add --prefix terraform/modules/elasticache-redis-standalone elasticache-redis-standalone $REF --squash
 ```
 
 Where `$REF` is a commit SHA, tag, or branch name.

docs/general/install/README.md

@@ -1,3 +1,3 @@
-# MOD_TITLE
+# elasticache redis standalone module
 
 This directory will be used for any documentation that is unique to this module.

docs/module/README.md

@@ -1,4 +1,4 @@
-module "MOD_SHORTNAME" {
+module "redis" {
   source = "../.."
 
   organization = var.organization

examples/basic/main.tf

@@ -1,4 +1,39 @@
-output "hello_world" {
-  description = "Hello World"
-  value       = module.MOD_SHORTNAME.hello_world
+output "name" {
+  description = "The name of the ElastiCache replication group"
+  value       = module.redis.name
+}
+
+output "arn" {
+  description = "The ARN of the ElastiCache replication group"
+  value       = module.redis.arn
+}
+
+output "sg_ids" {
+  description = "The security group ids"
+  value       = module.redis.sg_ids
+}
+
+output "engine_version_actual" {
+  description = "Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine."
+  value       = module.redis.engine_version_actual
+}
+
+output "member_clusters" {
+  description = "Identifiers of all the nodes that are part of this replication group."
+  value       = module.redis.member_clusters
+}
+
+output "primary_endpoint_address" {
+  description = "Address of the endpoint for the primary node in the replication group."
+  value       = module.redis.primary_endpoint_address
+}
+
+output "reader_endpoint_address" {
+  description = "Address of the endpoint for the reader node in the replication group."
+  value       = module.redis.reader_endpoint_address
+}
+
+output "tags" {
+  description = "The tags"
+  value       = module.redis.tags
 }

examples/basic/outputs.tf

@@ -1,7 +1,7 @@
 # terraform {
 #   backend "s3" {
 #     bucket         = "my-bucket-tfstate"
-#     key            = "example-terraform-aws-MOD_SHORTNAME-basic"
+#     key            = "example-terraform-aws-elasticache-redis-standalone-basic"
 #     profile        = "my-profile"
 #     region         = "us-east-1"
 #     dynamodb_table = "terraform-lock"

examples/basic/sample-backend.tf

@@ -13,7 +13,7 @@ variable "environment" {
 variable "product" {
   description = "Tag used to group resources according to application"
 
-  default = "example-tf-MOD_SHORTNAME-basic"
+  default = "ex-tf-redis-basic"
 
   validation {
     condition     = can(regex("[a-z\\-]+", var.product))
@@ -24,7 +24,7 @@ variable "product" {
 variable "repo" {
   description = "Tag used to point to the repo using this module"
 
-  default = "https://github.com/pbs/terraform-MOD_NAME.git"
+  default = "https://github.com/pbs/terraform-elasticache-redis-standalone-module.git"
 
   validation {
     condition     = can(regex("(?:git|ssh|https?|git@[-\\w.]+):(\\/\\/)?(.*?)(\\.git)(\\/?|\\#[-\\d\\w._]+?)$", var.repo))

examples/basic/tags.tf

@@ -1 +1,3 @@
 github.com/googleapis/go-type-adapters v1.0.0 h1:9XdMn+d/G57qq1s8dNc5IesGCXHf6V2HZ2JwRxfA2tA=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=

go.work.sum

@@ -1,5 +1,30 @@
 locals {
-  name    = var.name != null ? var.name : var.product
+  name                 = var.name != null ? var.name : var.product
+  security_group_ids   = var.security_group_ids != null ? var.security_group_ids : [aws_security_group.sg.id]
+  subnet_group_name    = var.subnet_group_name != null ? var.subnet_group_name : aws_elasticache_subnet_group.subnet_group.id
+  vpc_id               = var.vpc_id != null ? var.vpc_id : data.aws_vpc.vpc[0].id
+  subnets              = var.subnets != null ? var.subnets : data.aws_subnets.private_subnets[0].ids
+  parameter_group_name = var.parameter_group_name != null ? var.parameter_group_name : aws_elasticache_parameter_group.parameter_group.id
+
+  vpc_data_lookup_tags = var.vpc_data_lookup_tags != null ? var.vpc_data_lookup_tags : {
+    "environment" : var.environment
+  }
+
+  subnet_data_lookup_filters = var.subnet_data_lookup_filters != null ? var.subnet_data_lookup_filters : {
+    "vpc-id"   = [local.vpc_id]
+    "tag:Name" = ["*-private-*"]
+  }
+
+  replication_group_description = var.replication_group_description != null ? var.replication_group_description : "Replication group for ${local.name}"
+  replication_group_id          = var.replication_group_id != null ? var.replication_group_id : local.name
+
+  sg_name        = var.use_prefix ? null : var.sg_name != null ? var.sg_name : local.name
+  sg_name_prefix = var.use_prefix ? var.sg_name != null ? var.sg_name : local.name : null
+
+  automatic_failover_enabled = var.automatic_failover_enabled != null ? var.automatic_failover_enabled : var.nodes >= 2
+
+  engine = "redis"
+
   creator = "terraform"
 
   tags = merge(

locals.tf

@@ -1 +1,33 @@
-# Resources go here!
+resource "aws_elasticache_replication_group" "replication_group" {
+  description          = local.replication_group_description
+  replication_group_id = substr(local.replication_group_id, 0, 40) # Max length is 40
+
+  apply_immediately           = var.apply_immediately
+  at_rest_encryption_enabled  = var.at_rest_encryption_enabled
+  auth_token                  = var.auth_token
+  auto_minor_version_upgrade  = var.auto_minor_version_upgrade
+  automatic_failover_enabled  = local.automatic_failover_enabled
+  data_tiering_enabled        = var.data_tiering_enabled
+  engine                      = local.engine
+  engine_version              = var.engine_version
+  final_snapshot_identifier   = var.final_snapshot_identifier
+  global_replication_group_id = var.global_replication_group_id
+  kms_key_id                  = var.kms_key_id
+  maintenance_window          = var.maintenance_window
+  multi_az_enabled            = var.multi_az_enabled
+  node_type                   = var.node_type
+  notification_topic_arn      = var.notification_topic_arn
+  num_cache_clusters          = var.nodes
+  parameter_group_name        = local.parameter_group_name
+  port                        = var.port
+  preferred_cache_cluster_azs = var.preferred_cache_cluster_azs
+  security_group_ids          = local.security_group_ids
+  snapshot_arns               = var.snapshot_arns
+  snapshot_retention_limit    = var.snapshot_retention_limit
+  snapshot_window             = var.snapshot_window
+  subnet_group_name           = local.subnet_group_name
+  transit_encryption_enabled  = var.transit_encryption_enabled
+  user_group_ids              = var.user_group_ids
+
+  tags = local.tags
+}