Merge pull request #7 from RohitSquareops/Release-bug-fixes

updated readme and variable for slack

Author: RohitSquareops

README.md

@@ -156,6 +156,7 @@ Security scanning is graciously provided by Prowler. Proowler is the leading ful
 | <a name="input_port"></a> [port](#input\_port) | The redis port | `number` | `6379` | no |
 | <a name="input_recovery_window_aws_secret"></a> [recovery\_window\_aws\_secret](#input\_recovery\_window\_aws\_secret) | Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. | `number` | `0` | no |
 | <a name="input_slack_channel"></a> [slack\_channel](#input\_slack\_channel) | The Slack channel where notifications will be posted. | `string` | `""` | no |
+| <a name="input_slack_notification_enabled"></a> [slack\_notification\_enabled](#input\_slack\_notification\_enabled) | Whether to enable/disable slack notification. | `bool` | `false` | no |
 | <a name="input_slack_username"></a> [slack\_username](#input\_slack\_username) | The username to use when sending notifications to Slack. | `string` | `""` | no |
 | <a name="input_slack_webhook_url"></a> [slack\_webhook\_url](#input\_slack\_webhook\_url) | The Slack Webhook URL where notifications will be sent. | `string` | `""` | no |
 | <a name="input_slow_log_destination"></a> [slow\_log\_destination](#input\_slow\_log\_destination) | The destination for slow logs(eg. Cloudwatch log-group name or kinesis firehose stream name.) | `string` | `null` | no |

examples/complete-cluster-mode/README.md

@@ -17,17 +17,25 @@ This example will be very useful for users who are new to a module and want to q
 
 ## Providers
 
-No providers.
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.63 |
 
 ## Modules
 
 | Name | Source | Version |
 |------|--------|---------|
+| <a name="module_kms"></a> [kms](#module\_kms) | terraform-aws-modules/kms/aws | n/a |
 | <a name="module_redis"></a> [redis](#module\_redis) | squareops/elasticache-redis/aws | n/a |
+| <a name="module_vpc"></a> [vpc](#module\_vpc) | squareops/vpc/aws | 3.3.1 |
 
 ## Resources
 
-No resources.
+| Name | Type |
+|------|------|
+| [aws_availability_zones.primary](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
+| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
+| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
 
 ## Inputs
 
@@ -38,7 +46,7 @@ No inputs.
 | Name | Description |
 |------|-------------|
 | <a name="output_auth_token_password"></a> [auth\_token\_password](#output\_auth\_token\_password) | Elasticache-redis auth token password(this password may be old, because Terraform doesn't track it after initial creation) |
-| <a name="output_elastic_cache_redis_endpoint"></a> [elastic\_cache\_redis\_endpoint](#output\_elastic\_cache\_redis\_endpoint) | Elasticache-redis cluster primary endpoint address |
+| <a name="output_elastic_cache_redis_reader_endpoint"></a> [elastic\_cache\_redis\_reader\_endpoint](#output\_elastic\_cache\_redis\_reader\_endpoint) | Elasticache-redis cluster primary endpoint address |
 | <a name="output_elastic_cache_redis_security_group"></a> [elastic\_cache\_redis\_security\_group](#output\_elastic\_cache\_redis\_security\_group) | The security group ID of the cluster |
 | <a name="output_id_of_redis_cluster"></a> [id\_of\_redis\_cluster](#output\_id\_of\_redis\_cluster) | ID of the elasticache-redis cluster |
 | <a name="output_port_no"></a> [port\_no](#output\_port\_no) | Port number of Redis |

examples/complete-cluster-mode/main.tf

@@ -12,8 +12,8 @@ locals {
     Expires    = "Never"
     Department = "Engineering"
   }
-  current_identity           = data.aws_caller_identity.current.arn
-  availability_zones = slice(data.aws_availability_zones.primary.names, 0, 3)
+  current_identity     = data.aws_caller_identity.current.arn
+  availability_zones   = slice(data.aws_availability_zones.primary.names, 0, 3)
   cluster_mode_enabled = true
 }
 
@@ -97,27 +97,28 @@ module "vpc" {
 }
 
 module "redis" {
-  source                           = "squareops/elasticache-redis/aws"
-  name                             = local.name
-  family                           = local.family
-  node_type                        = local.node_type
-  environment                      = local.environment
-  engine_version                   = local.redis_engine_version
-  cluster_mode_enabled             = local.cluster_mode_enabled
-  cluster_mode_num_node_groups     = 1
+  source                               = "squareops/elasticache-redis/aws"
+  name                                 = local.name
+  family                               = local.family
+  node_type                            = local.node_type
+  environment                          = local.environment
+  engine_version                       = local.redis_engine_version
+  cluster_mode_enabled                 = local.cluster_mode_enabled
+  cluster_mode_num_node_groups         = 1
   cluster_mode_replicas_per_node_group = 2
-  vpc_id                           = module.vpc.vpc_id
-  subnets                          = module.vpc.database_subnets
-  kms_key_arn                      = module.kms.key_arn
-  multi_az_enabled                 = true
-  availability_zones               = local.availability_zones
-  snapshot_window                  = "07:00-08:00"
-  maintenance_window               = "sun:09:00-sun:10:00"
-  allowed_security_groups          = local.allowed_security_groups
-  cloudwatch_metric_alarms_enabled = false
-  alarm_cpu_threshold_percent      = 70
-  alarm_memory_threshold_bytes     = "10000000" # in bytes
-  slack_username                   = ""
-  slack_channel                    = ""
-  slack_webhook_url                = ""
+  vpc_id                               = module.vpc.vpc_id
+  subnets                              = module.vpc.database_subnets
+  kms_key_arn                          = module.kms.key_arn
+  multi_az_enabled                     = true
+  availability_zones                   = local.availability_zones
+  snapshot_window                      = "07:00-08:00"
+  maintenance_window                   = "sun:09:00-sun:10:00"
+  allowed_security_groups              = local.allowed_security_groups
+  cloudwatch_metric_alarms_enabled     = false
+  alarm_cpu_threshold_percent          = 70
+  alarm_memory_threshold_bytes         = "10000000" # in bytes
+  slack_notification_enabled           = false
+  slack_username                       = ""
+  slack_channel                        = ""
+  slack_webhook_url                    = ""
 }

examples/complete/main.tf

@@ -114,6 +114,7 @@ module "redis" {
   cloudwatch_metric_alarms_enabled = false
   alarm_cpu_threshold_percent      = 70
   alarm_memory_threshold_bytes     = "10000000" # in bytes
+  slack_notification_enabled       = false
   slack_username                   = ""
   slack_channel                    = ""
   slack_webhook_url                = ""

lambda/sns_slack.zip

@@ -222,12 +222,12 @@ resource "aws_cloudwatch_metric_alarm" "cache_memory" {
 }
 
 resource "aws_kms_key" "this" {
-  count       = var.cloudwatch_metric_alarms_enabled ? 1 : 0
+  count       = var.slack_notification_enabled ? 1 : 0
   description = "KMS key for notify-slack test"
 }
 
 resource "aws_kms_ciphertext" "slack_url" {
-  count     = var.cloudwatch_metric_alarms_enabled ? 1 : 0
+  count     = var.slack_notification_enabled ? 1 : 0
   plaintext = var.slack_webhook_url
   key_id    = aws_kms_key.this[0].arn
 }
@@ -258,7 +258,7 @@ EOF
 }
 
 data "archive_file" "lambdazip" {
-  count       = var.cloudwatch_metric_alarms_enabled ? 1 : 0
+  count       = var.slack_notification_enabled ? 1 : 0
   type        = "zip"
   output_path = "${path.module}/lambda/sns_slack.zip"
 
@@ -268,7 +268,7 @@ data "archive_file" "lambdazip" {
 
 module "cw_sns_slack" {
   source        = "./lambda"
-  count         = var.cloudwatch_metric_alarms_enabled ? 1 : 0
+  count         = var.slack_notification_enabled ? 1 : 0
   name          = format("%s-%s-%s", var.environment, var.name, "sns-slack")
   description   = "notify slack channel on sns topic"
   artifact_file = "${path.module}/lambda/sns_slack.zip"
@@ -288,15 +288,15 @@ module "cw_sns_slack" {
 }
 
 resource "aws_sns_topic_subscription" "slack-endpoint" {
-  count                  = var.cloudwatch_metric_alarms_enabled ? 1 : 0
+  count                  = var.slack_notification_enabled ? 1 : 0
   endpoint               = module.cw_sns_slack[0].arn
   protocol               = "lambda"
   endpoint_auto_confirms = true
   topic_arn              = aws_sns_topic.slack_topic[0].arn
 }
 
 resource "aws_lambda_permission" "sns_lambda_slack_invoke" {
-  count         = var.cloudwatch_metric_alarms_enabled ? 1 : 0
+  count         = var.slack_notification_enabled ? 1 : 0
   statement_id  = "sns_slackAllowExecutionFromSNS"
   action        = "lambda:InvokeFunction"
   function_name = module.cw_sns_slack[0].arn

main.tf

@@ -221,6 +221,12 @@ variable "alarm_memory_threshold_bytes" {
   description = "Ram threshold alarm level in bytes"
 }
 
+variable "slack_notification_enabled" {
+  type        = bool
+  description = "Whether to enable/disable slack notification."
+  default     = false
+}
+
 variable "slack_webhook_url" {
   description = "The Slack Webhook URL where notifications will be sent."
   default     = ""