RDS backups to S3

* Conditonally create a scheduled Fargate task to backup RDS databases to S3
dxw · Jul 29, 2024 · a0dba6d · a0dba6d
1 parent a454611
commit a0dba6d
Show file tree

Hide file tree

Showing 16 changed files with 741 additions and 2 deletions.
diff --git a/README.md b/README.md
diff --git a/buildspecs/dalmatian-sql-backup.yml b/buildspecs/dalmatian-sql-backup.yml
@@ -0,0 +1,18 @@
+version: 0.2
+
+phases:
+  pre_build:
+    commands:
+      - echo Build started on `date`
+      - echo Logging in to Amazon ECR...
+      - aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com
+      - echo Building dalmatian-sql-backup docker image ...
+      - docker build -t dalmatian-sql-backup:latest .
+  build:
+    commands:
+      - echo Adding ECR repo tag...
+      - docker tag dalmatian-sql-backup:latest $REPOSITORY_URI:latest
+  post_build:
+    commands:
+      - echo Pushing the Docker image...
+      - docker push $REPOSITORY_URI:latest
diff --git a/kms-infrastructure.tf b/kms-infrastructure.tf
@@ -46,6 +46,18 @@ resource "aws_kms_key" "infrastructure" {
           for k, v in local.infrastructure_ecs_cluster_services : aws_iam_role.infrastructure_ecs_cluster_service_task_execution[k].arn if v["enable_execute_command"] == true && local.infrastructure_ecs_cluster_enable_execute_command_logging
         ])
       }
+      )}${length(local.infrastructure_rds) > 0 && local.infrastructure_kms_encryption && local.enable_infrastructure_rds_backup_to_s3 ? "," : ""}
+      ${templatefile("${path.root}/policies/kms-key-policy-statements/role-allow-encrypt.json.tpl",
+      {
+        role_arns = jsonencode([
+          for k, v in local.infrastructure_rds : aws_iam_role.infrastructure_rds_s3_backups_task[k].arn if local.enable_infrastructure_rds_backup_to_s3
+        ])
+      }
+      )}${length(local.infrastructure_rds) > 0 && local.infrastructure_kms_encryption && local.enable_infrastructure_rds_backup_to_s3 ? "," : ""}
+      ${templatefile("${path.root}/policies/kms-key-policy-statements/cloudwatch-logs-allow.json.tpl",
+      {
+        log_group_arn = length(local.infrastructure_rds) > 0 && local.infrastructure_kms_encryption && local.enable_infrastructure_rds_backup_to_s3 ? "arn:aws:logs:${local.aws_region}:${local.aws_account_id}:log-group:${local.resource_prefix}-infrastructure-rds-s3-backups-*" : ""
+      }
       )}${contains([for k, v in local.custom_s3_buckets : (v["cloudfront_dedicated_distribution"] == true || v["cloudfront_infrastructure_ecs_cluster_service"] != null) && v["create_dedicated_kms_key"] == false ? true : false], true) && local.infrastructure_kms_encryption ? "," : ""}
       ${templatefile("${path.root}/policies/kms-key-policy-statements/cloudfront-distribution-allow.json.tpl",
       {

diff --git a/local-exec-scripts/trigger-codedeploy-project.sh b/local-exec-scripts/trigger-codedeploy-project.sh
@@ -0,0 +1,70 @@
+#!/bin/bash
+
+# exit on failures
+set -e
+set -o pipefail
+
+usage() {
+  echo "Usage: $(basename "$0") [OPTIONS]" 1>&2
+  echo "  -h   - help"
+  echo "  -n   - CodeBuild project name"
+  exit 1
+}
+
+while getopts "n:h" opt; do
+  case $opt in
+    n)
+      PROJECT_NAME=$OPTARG
+      ;;
+    h)
+      usage
+      ;;
+    *)
+      usage
+      ;;
+  esac
+done
+
+if [ -z "$PROJECT_NAME" ]
+then
+  usage
+fi
+
+BUILD_ID="$(
+  aws codebuild start-build \
+  --project-name "$PROJECT_NAME" \
+  | jq -r '.build.id'
+)"
+
+echo "Triggered $PROJECT_NAME CodeBuild project ($BUILD_ID) ..."
+
+COMPLETED=""
+while [ -z "$COMPLETED" ]
+do
+  sleep 10
+  echo "Checking progress of CodeBuild  $BUILD_ID ..."
+  BUILD_PROGRESS="$(
+    aws codebuild batch-get-builds \
+    --ids "$BUILD_ID" \
+  )"
+  COMPLETED="$(
+    echo "$BUILD_PROGRESS" \
+    | jq -r \
+    '.builds[0].phases[] | select(.phaseType == "COMPLETED")'
+  )"
+done
+echo "CodeBuild $BUILD_ID Completed, checking for failures ..."
+
+FAILURES="$(
+  echo "$BUILD_PROGRESS" \
+  | jq -r \
+  '.builds[0].phases[] | select(.phaseStatus == "FAILED")'
+)"
+
+if [ -n "$FAILURES" ]
+then
+  echo "$FAILURES"
+  exit 1
+fi
+
+echo "CodeBuild $BUILD_ID completed without failures"
diff --git a/locals.tf b/locals.tf
@@ -30,12 +30,14 @@ locals {
     length(local.custom_s3_buckets) != 0 ||
     local.enable_cloudformatian_s3_template_store ||
     local.enable_infrastructure_vpc_transfer_s3_bucket ||
-    local.infrastructure_ecs_cluster_enable_execute_command_logging
+    local.infrastructure_ecs_cluster_enable_execute_command_logging ||
+    local.enable_infrastructure_rds_backup_to_s3
   )
   logs_bucket_s3_source_arns = concat(
     length(local.infrastructure_ecs_cluster_services) != 0 ? [aws_s3_bucket.infrastructure_ecs_cluster_service_build_pipeline_artifact_store[0].arn] : [],
     local.enable_infrastructure_vpc_transfer_s3_bucket ? [aws_s3_bucket.infrastructure_vpc_transfer[0].arn] : [],
-    [for k, v in local.custom_s3_buckets : aws_s3_bucket.custom[k].arn]
+    [for k, v in local.custom_s3_buckets : aws_s3_bucket.custom[k].arn],
+    local.enable_infrastructure_rds_backup_to_s3 ? [aws_s3_bucket.infrastructure_rds_s3_backups[0].arn] : [],
   )
   logs_bucket_logs_source_arns = concat(
     local.infrastructure_vpc_flow_logs_s3_with_athena ? ["arn:aws:logs:${local.aws_region}:${local.aws_account_id}:*"] : []
@@ -232,6 +234,17 @@ locals {
     "mysql"    = 3306
     "postgres" = 5432
   }
+  rds_s3_backups_container_entrypoint = {
+    "mysql"    = ""
+    "postgres" = ""
+  }
+  enable_infrastructure_rds_backup_to_s3          = var.enable_infrastructure_rds_backup_to_s3
+  infrastructure_rds_backup_to_s3_cron_expression = var.infrastructure_rds_backup_to_s3_cron_expression
+  infrastructure_rds_backup_to_s3_retention       = var.infrastructure_rds_backup_to_s3_retention
+  enable_infrastructure_rds_tooling_ecs_cluster = anytrue([
+    local.enable_infrastructure_rds_backup_to_s3,
+  ])
+  infrastructure_rds_tooling_ecs_cluster_name = "${local.resource_prefix}-infrastructure-rds-tooling"
 
   infrastructure_elasticache_defaults = var.infrastructure_elasticache_defaults
   infrastructure_elasticache_keys     = length(var.infrastructure_elasticache) > 0 ? keys(values(var.infrastructure_elasticache)[0]) : []

diff --git a/policies/codebuild-allow-builds.json.tpl b/policies/codebuild-allow-builds.json.tpl
@@ -0,0 +1,16 @@
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Action": [
+        "codebuild:StartBuild",
+        "codebuild:StopBuild",
+        "codebuild:BatchGet*",
+        "codebuild:Get*",
+        "codebuild:List*"
+      ],
+      "Effect": "Allow",
+      "Resource": "*"
+    }
+  ]
+}
diff --git a/policies/secrets-manager-get-secret-value.json.tpl b/policies/secrets-manager-get-secret-value.json.tpl
@@ -0,0 +1,12 @@
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "secretsmanager:GetSecretValue"
+      ],
+      "Resource": ${secret_name_arns}
+    }
+  ]
+}
diff --git a/rds-infrastructure-cloudwatch-logs.tf b/rds-infrastructure-cloudwatch-logs.tf
@@ -10,3 +10,12 @@ resource "aws_cloudwatch_log_group" "infrastructure_rds_exports" {
   retention_in_days = 30
   kms_key_id        = local.infrastructure_kms_encryption ? aws_kms_key.infrastructure[0].id : null
 }
+
+resource "aws_cloudwatch_log_group" "infrastructure_rds_s3_backups" {
+  for_each = local.enable_infrastructure_rds_backup_to_s3 ? local.infrastructure_rds : {}
+
+  name              = "${local.resource_prefix}-infrastructure-rds-s3-backups-${each.key}"
+  retention_in_days = local.infrastructure_rds_backup_to_s3_retention
+  kms_key_id        = local.infrastructure_kms_encryption ? aws_kms_key.infrastructure[0].arn : null
+  skip_destroy      = true
+}
diff --git a/rds-infrastructure-s3-backups-ecr.tf b/rds-infrastructure-s3-backups-ecr.tf
@@ -0,0 +1,17 @@
+resource "aws_ecr_repository" "infrastructure_rds_s3_backups" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  name = "${local.resource_prefix}-rds-s3-backups"
+
+  #tfsec:ignore:aws-ecr-enforce-immutable-repository
+  image_tag_mutability = "MUTABLE"
+
+  encryption_configuration {
+    encryption_type = local.infrastructure_kms_encryption ? "KMS" : "AES256"
+    kms_key         = local.infrastructure_kms_encryption ? aws_kms_key.infrastructure[0].arn : null
+  }
+
+  image_scanning_configuration {
+    scan_on_push = true
+  }
+}
diff --git a/rds-infrastructure-s3-backups-image-codebuild.tf b/rds-infrastructure-s3-backups-image-codebuild.tf
@@ -0,0 +1,111 @@
+resource "aws_iam_role" "infrastructure_rds_s3_backups_image_codebuild" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  name        = "${local.resource_prefix}-${substr(sha512("rds-s3-backups-image-codebuild"), 0, 6)}"
+  description = "${local.resource_prefix}-rds-s3-backups-image-codebuild"
+  assume_role_policy = templatefile(
+    "${path.root}/policies/assume-roles/service-principle-standard.json.tpl",
+    { services = jsonencode(["codebuild.amazonaws.com", "events.amazonaws.com"]) }
+  )
+}
+
+resource "aws_iam_policy" "infrastructure_rds_s3_backups_image_codebuild_cloudwatch_rw" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  name        = "${local.resource_prefix}-${substr(sha512("rds-s3-backups-image-codebuild-cloudwatch-rw"), 0, 6)}"
+  description = "${local.resource_prefix}-rds-s3-backups-image-codebuild-cloudwatch-rw"
+  policy      = templatefile("${path.root}/policies/cloudwatch-logs-rw.json.tpl", {})
+}
+
+resource "aws_iam_role_policy_attachment" "infrastructure_rds_s3_backups_image_codebuild_cloudwatch_rw" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  role       = aws_iam_role.infrastructure_rds_s3_backups_image_codebuild[0].name
+  policy_arn = aws_iam_policy.infrastructure_rds_s3_backups_image_codebuild_cloudwatch_rw[0].arn
+}
+
+resource "aws_iam_policy" "infrastructure_rds_s3_backups_image_codebuild_allow_builds" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  name        = "${local.resource_prefix}-${substr(sha512("rds-s3-backups-image-codebuild-allow-builds"), 0, 6)}"
+  description = "${local.resource_prefix}-rds-s3-backups-image-codebuild-allow-builds"
+  policy      = templatefile("${path.root}/policies/codebuild-allow-builds.json.tpl", {})
+}
+
+resource "aws_iam_role_policy_attachment" "infrastructure_rds_s3_backups_image_codebuild_allow_builds" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  role       = aws_iam_role.infrastructure_rds_s3_backups_image_codebuild[0].name
+  policy_arn = aws_iam_policy.infrastructure_rds_s3_backups_image_codebuild_allow_builds[0].arn
+}
+
+resource "aws_codebuild_project" "infrastructure_rds_s3_backups_image_build" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  name          = "${local.resource_prefix}-rds-s3-backups-image-build"
+  description   = "${local.resource_prefix} RDS S3 Backups Image Build"
+  build_timeout = "20"
+  service_role  = aws_iam_role.infrastructure_rds_s3_backups_image_codebuild[0].arn
+
+  artifacts {
+    type = "NO_ARTIFACTS"
+  }
+
+  environment {
+    compute_type    = "BUILD_GENERAL1_SMALL"
+    image           = "aws/codebuild/standard:7.0"
+    type            = "LINUX_CONTAINER"
+    privileged_mode = true
+
+    environment_variable {
+      name  = "AWS_ACCOUNT_ID"
+      value = local.aws_account_id
+    }
+
+    environment_variable {
+      name  = "REPOSITORY_URI"
+      value = aws_ecr_repository.infrastructure_rds_s3_backups[0].repository_url
+    }
+  }
+
+  source {
+    type            = "GITHUB"
+    location        = "https://github.com/dxw/dalmatian-sql-backup"
+    git_clone_depth = 1
+    buildspec       = templatefile("${path.root}/buildspecs/dalmatian-sql-backup.yml", {})
+  }
+}
+
+resource "terraform_data" "infrastructure_rds_s3_backups_image_build_trigger_codebuild" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  triggers_replace = [
+    md5(aws_codebuild_project.infrastructure_rds_s3_backups_image_build[0].source.buildspec),
+  ]
+
+  provisioner "local-exec" {
+    interpreter = ["/bin/bash", "-c"]
+    command     = <<EOF
+      ${path.root}/local-exec-scripts/trigger-codedeploy-project.sh \
+      -n "${aws_codebuild_project.infrastructure_rds_s3_backups_image_build[0].name}"
+    EOF
+  }
+}
+
+resource "aws_cloudwatch_event_rule" "infrastructure_rds_s3_backups_image_build_trigger_codebuild" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  name                = "${local.resource_prefix}-rds-s3-backups-image-build-trigger-codebuild"
+  description         = "${local.resource_prefix} RDS S3 Backups Image Build Trigger CodeBuild"
+  schedule_expression = "rate(24 hours)"
+}
+
+resource "aws_cloudwatch_event_target" "infrastructure_rds_s3_backups_image_build_trigger_codebuild" {
+  count = local.enable_infrastructure_rds_backup_to_s3 ? 1 : 0
+
+  target_id = "${local.resource_prefix}-rds-s3-backups-image-build-trigger-codebuild"
+  rule      = aws_cloudwatch_event_rule.infrastructure_rds_s3_backups_image_build_trigger_codebuild[0].name
+  arn       = aws_codebuild_project.infrastructure_rds_s3_backups_image_build[0].id
+
+  role_arn = aws_iam_role.codebuild_role.arn
+}