Add notification service slack support (#179)

* Add notification service slack support

* Fix slack api key secret creation

Author: bmonkman

templates/Makefile

@@ -28,7 +28,7 @@ apply-secrets:
 	aws secretsmanager describe-secret --secret-id "$(PROJECT)-$(ENVIRONMENT)-rds-<% index .Params `randomSeed` %>" > /dev/null 2>&1 || ( \
 	cd terraform/bootstrap/secrets && \
 	terraform init && \
-	terraform apply $(AUTO_APPROVE) --var "sendgrid_api_key=${sendgridApiKey}" && \
+	terraform apply $(AUTO_APPROVE) --var "sendgrid_api_key=${sendgridApiKey}" --var "slack_api_key=${notificationServiceSlackApiKey}"&& \
 	rm ./terraform.tfstate )
 
 apply-shared-env:

templates/kubernetes/terraform/environments/prod/main.tf

@@ -82,7 +82,7 @@ module "kubernetes" {
   # This domain or address must be verified by the mail provider (Sendgrid, SES, etc.)
   user_auth_mail_from_address = "noreply@${local.domain_name}"
 
-  notification_service_enabled          = <%if eq (index .Params `sendgridApiKey`) "" %>false<% else %>true<% end %>
+  notification_service_enabled          = <%if eq (index .Params `notificationServiceEnabled`) "yes" %>true<% else %>false<% end %>
   notification_service_highly_available = true
 
   cache_store =  "<% index .Params `cacheStore` %>"

templates/kubernetes/terraform/environments/stage/main.tf

@@ -81,7 +81,7 @@ module "kubernetes" {
   # This domain or address must be verified by the mail provider (Sendgrid, SES, etc.)
   user_auth_mail_from_address = "noreply@${local.domain_name}"
 
-  notification_service_enabled          = <%if eq (index .Params `sendgridApiKey`) "" %>false<% else %>true<% end %>
+  notification_service_enabled          = <%if eq (index .Params `notificationServiceEnabled`) "yes" %>true<% else %>false<% end %>
   notification_service_highly_available = false
 
   cache_store = "<% index .Params `cacheStore` %>"

templates/kubernetes/terraform/modules/kubernetes/cert_manager.tf

@@ -1,5 +1,5 @@
 locals {
-  cert_manager_version     = "1.0.4"
+  cert_manager_version     = "1.1.0"
   cluster_issuer_name      = var.cert_manager_use_production_acme_environment ? "clusterissuer-letsencrypt-production" : "clusterissuer-letsencrypt-staging"
   cert_manager_acme_server = var.cert_manager_use_production_acme_environment ? "https://acme-v02.api.letsencrypt.org/directory" : "https://acme-staging-v02.api.letsencrypt.org/directory"
 }

templates/kubernetes/terraform/modules/kubernetes/notification_service.tf

@@ -1,5 +1,7 @@
 locals {
-  sendgrid_api_key_secret_name = "${var.project}-sendgrid-${var.random_seed}" # Created in terraform/bootstrap/secrets
+  # Created in terraform/bootstrap/secrets
+  sendgrid_api_key_secret_name = "${var.project}-sendgrid-${var.random_seed}"
+  slack_api_key_secret_name    = "${var.project}-slack-${var.random_seed}"
 }
 
 data "aws_secretsmanager_secret" "sendgrid_api_key" {
@@ -11,6 +13,15 @@ data "aws_secretsmanager_secret_version" "sendgrid_api_key" {
   secret_id = data.aws_secretsmanager_secret.sendgrid_api_key[0].id
 }
 
+data "aws_secretsmanager_secret" "slack_api_key" {
+  count = var.notification_service_enabled ? 1 : 0
+  name  = local.slack_api_key_secret_name
+}
+data "aws_secretsmanager_secret_version" "slack_api_key" {
+  count     = var.notification_service_enabled ? 1 : 0
+  secret_id = data.aws_secretsmanager_secret.slack_api_key[0].id
+}
+
 resource "kubernetes_namespace" "notification_service" {
   count = var.notification_service_enabled ? 1 : 0
   metadata {
@@ -24,14 +35,20 @@ resource "helm_release" "notification_service" {
   name       = "zero-notification-service"
   repository = "https://commitdev.github.io/zero-notification-service/"
   chart      = "zero-notification-service"
-  version    = "0.0.4"
+  version    = "0.0.5"
   namespace  = kubernetes_namespace.notification_service[0].metadata[0].name
 
   set {
     name  = "application.structuredLogging"
     value = "true"
   }
 
+  # Uncomment to set the image tag of the application to use separately from the chart version
+  # set {
+  #   name  = "image.tag"
+  #   value = "0.0.0"
+  # }
+
   set {
     name  = "autoscaling.enabled"
     value = var.notification_service_highly_available ? "true" : "false" # If false, deployment replicas will be set to 1 and the replica options below will be ignored
@@ -45,9 +62,14 @@ resource "helm_release" "notification_service" {
     value = var.notification_service_highly_available ? "4" : "2"
   }
 
-  # This will become a secret provided as an env var
+  # These will become secrets provided as env vars
   set_sensitive {
     name  = "application.sendgridApiKey"
     value = data.aws_secretsmanager_secret_version.sendgrid_api_key[0].secret_string
   }
+
+  set_sensitive {
+    name  = "application.slackApiKey"
+    value = data.aws_secretsmanager_secret_version.slack_api_key[0].secret_string
+  }
 }

templates/terraform/bootstrap/secrets/main.tf

@@ -43,3 +43,14 @@ module "sendgrid_api_key" {
   value = var.sendgrid_api_key
   tags  = map("sendgrid", local.project)
 }
+
+module "slack_api_key" {
+  count   = <%if eq (index .Params `notificationServiceSlackApiKey`) "" %>0<% else %>1<% end %>
+  source  = "commitdev/zero/aws//modules/secret"
+  version = "0.0.2"
+
+  name  = "${local.project}-slack-<% index .Params `randomSeed` %>"
+  type  = "string"
+  value = var.slack_api_key
+  tags  = map("slack", local.project)
+}

templates/terraform/bootstrap/secrets/variables.tf

@@ -2,3 +2,8 @@ variable "sendgrid_api_key" {
   description = "The Sendgrid API key to use for mailing, if necessary"
   default     = ""
 }
+
+variable "slack_api_key" {
+  description = "The Slack API key to use with the notification service, if necessary"
+  default     = ""
+}

zero-module.yml

@@ -82,9 +82,19 @@ parameters:
     options:
       - "none"
       - "prometheus"
+  - field: notificationServiceEnabled
+    label: "Install the Zero Notification Service in your cluster?"
+    info: Provides easy notification capability through email, slack, etc. - https://github.com/commitdev/zero-notification-service
+    default: yes
+    options:
+      - "yes"
+      - "no"
   - field: sendgridApiKey
     label: "API key to setup email integration (optional: leave blank to opt-out of Sendgrid setup)"
-    info: Signup at https://signup.sendgrid.com or create an API key from https://app.sendgrid.com/settings/api_keys. Sendgrid is an email delivery service enabling transactional email sending and more.
+    info: Signup at https://signup.sendgrid.com or create an API key at https://app.sendgrid.com/settings/api_keys - Sendgrid is an email delivery service enabling transactional email sending and more.
+  - field: notificationServiceSlackApiKey
+    label: "API key of your Slack bot if you want to use Slack with the Zero Notification Service. Leave blank if not applicable."
+    info: See https://slack.com/intl/en-ca/help/articles/215770388-Create-and-regenerate-API-tokens
   - field: accountId
     label: AWS Account ID
     execute: aws sts get-caller-identity --query "Account" | tr -d '"'