Backup restore functionality added for different versions

.gitignore

@@ -6,3 +6,4 @@
 *.tfvars
 *.pem
 vars
+.helmignore

examples/complete-psql-replica/main.tf

@@ -4,6 +4,8 @@ locals {
   family                  = "postgres15"
   vpc_cidr                = "10.20.0.0/16"
   environment             = "prod"
+  create_namespace        = true
+  namespace               = "postgres"
   storage_type            = "gp3"
   engine_version          = "15.2"
   instance_class          = "db.m5d.large"
@@ -101,7 +103,7 @@ module "rds-pg" {
   publicly_accessible              = false
   skip_final_snapshot              = true
   backup_window                    = "03:00-06:00"
-  maintenance_window               = "Mon:00:00-Mon:03:00"
+  maintenance_window               = "Mon:00:00-Mon:03:00
   final_snapshot_identifier_prefix = "final"
   major_engine_version             = local.engine_version
   deletion_protection              = true
@@ -113,4 +115,23 @@ module "rds-pg" {
   slack_channel                    = "postgresql-notification"
   slack_webhook_url                = "https://hooks/xxxxxxxx"
   custom_user_password             = local.custom_user_password
+  #if you want backup and restore then you have to create your cluster with rds vpc , subnet, key_arn. 
+  #And allow cluster security group in rds security group
+  # cluster_name                     = "cluster-name" 
+  # namespace                        = local.namespace
+  # create_namespace                 = local.create_namespace
+  # postgresdb_backup_enabled = false
+  # postgresdb_backup_config = {
+  #   postgres_database_name  = "" # which database backup you want
+  #   s3_bucket_region     = "" #s3 bucket region
+  #   cron_for_full_backup = "*/3 * * * *" 
+  #   bucket_uri           = "s3://xyz" #s3 bucket uri
+  # }
+  # postgresdb_restore_enabled = false
+  # postgresdb_restore_config = {
+  #   bucket_uri       = "s3://xyz" #s3 bucket uri which have dackup dump file
+  #   backup_file_name = "abc.dump" #Give only .sql or .zip file for restore
+  #   s3_bucket_region = "" # bucket region
+  #   DB_NAME          = "" # which db to restore backup file
+  # }
 }

examples/complete/main.tf

@@ -1,14 +1,16 @@
 locals {
-  region                  = "us-east-2"
+  region                  = "us-east-1"
   name                    = "postgresql"
   family                  = "postgres15"
   vpc_cidr                = "10.20.0.0/16"
   environment             = "prod"
-  engine_version          = "15.2"
-  instance_class          = "db.m5d.large"
+  create_namespace        = true
+  namespace               = "pg"
+  engine_version          = "15.4"
+  instance_class          = "db.t4g.micro"
   storage_type            = "gp3"
   current_identity        = data.aws_caller_identity.current.arn
-  allowed_security_groups = ["sg-0a680afd35"]
+  allowed_security_groups = ["sg-xxxxxxxxxxxxxxxx"]
   custom_user_password    = ""
   additional_tags = {
     Owner      = "Organization_Name"
@@ -22,7 +24,7 @@ data "aws_region" "current" {}
 
 module "kms" {
   source = "terraform-aws-modules/kms/aws"
-
+  version = "~> 1.0"
   deletion_window_in_days = 7
   description             = "Complete key example showing various configurations available"
   enable_key_rotation     = true
@@ -99,32 +101,51 @@ module "vpc" {
 module "rds-pg" {
   source                           = "squareops/rds-postgresql/aws"
   name                             = local.name
-  db_name                          = "postgres"
+  db_name                          = "test"
   multi_az                         = "true"
   family                           = local.family
-  vpc_id                           = module.vpc.vpc_id
+  vpc_id                           = module.vpc.vpc_id 
+  allowed_security_groups          = local.allowed_security_groups
   subnet_ids                       = module.vpc.database_subnets ## db subnets
   environment                      = local.environment
   kms_key_arn                      = module.kms.key_arn
   storage_type                     = local.storage_type
   engine_version                   = local.engine_version
   instance_class                   = local.instance_class
-  master_username                  = "pguser"
+  master_username                  = "admin"
   allocated_storage                = "20"
   max_allocated_storage            = 120
   publicly_accessible              = false
   skip_final_snapshot              = true
   backup_window                    = "03:00-06:00"
   maintenance_window               = "Mon:00:00-Mon:03:00"
-  final_snapshot_identifier_prefix = "final"
+  final_snapshot_identifier_prefix = "final"   
   major_engine_version             = local.engine_version
   deletion_protection              = false
-  cloudwatch_metric_alarms_enabled = true
+  cloudwatch_metric_alarms_enabled = false
   alarm_cpu_threshold_percent      = 70
   disk_free_storage_space          = "10000000" # in bytes
   slack_notification_enabled       = false
   slack_username                   = "Admin"
   slack_channel                    = "postgresql-notification"
   slack_webhook_url                = "https://hooks/xxxxxxxx"
   custom_user_password             = local.custom_user_password
+  #if you want backup and restore then you have to create your cluster with rds vpc id , private subnets, kms key. 
+  #And allow cluster security group in rds security group
+  cluster_name                     = "" 
+  namespace                        = local.namespace
+  create_namespace                 = local.create_namespace
+  postgresdb_backup_enabled = false
+  postgresdb_backup_config = {
+    postgres_database_name  = "" # Specify the database name or Leave empty if you wish to backup all databases
+    cron_for_full_backup = "*/2 * * * *" # set cronjob for backup
+    bucket_uri           = "s3://mongodb-backups-atmosly" # s3 bucket uri
+  }
+  postgresdb_restore_enabled = false
+  postgresdb_restore_config = {
+    bucket_uri       = "s3://mongodb-backups-atmosly" #S3 bucket URI (without a trailing slash /) containing the backup dump file.
+    backup_file_name = "db5_20241114111607.sql" #Give .sql or .zip file for restore
+  }
 }
+
+

examples/complete/provider.tf

@@ -4,3 +4,24 @@ provider "aws" {
     tags = local.additional_tags
   }
 }
+data "aws_eks_cluster" "cluster" {
+  name = ""
+
+}
+data "aws_eks_cluster_auth" "cluster" {
+  name = ""
+}
+
+provider "kubernetes" {
+  host                   = data.aws_eks_cluster.cluster.endpoint
+  cluster_ca_certificate = base64decode(data.aws_eks_cluster.cluster.certificate_authority.0.data)
+  token                  = data.aws_eks_cluster_auth.cluster.token
+}
+
+provider "helm" {
+  kubernetes {
+    host                   = data.aws_eks_cluster.cluster.endpoint
+    cluster_ca_certificate = base64decode(data.aws_eks_cluster.cluster.certificate_authority.0.data)
+    token                  = data.aws_eks_cluster_auth.cluster.token
+  }
+}

examples/complete/version.tf

@@ -3,7 +3,7 @@ terraform {
   required_providers {
     aws = {
       source  = "hashicorp/aws"
-      version = ">= 3.43.0"
+      version = ">= 5.0.0"
     }
   }
 }

helm/values/backup/values.yaml

@@ -0,0 +1,35 @@
+## Enable Full backup
+backup:
+  bucket_uri: ${bucket_uri}
+  aws_default_region: ${s3_bucket_region}
+  cron_for_full_backup: "${cron_for_full_backup}"
+  postgres_database_name: "${postgres_database_name}"
+  database_endpoint: "${db_endpoint}"
+  database_password: "${db_password}"
+  database_user: "${db_username}"
+
+
+annotations:
+  ${annotations}
+
+auth:
+  username: "${db_username}"
+
+affinity:
+  nodeAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      nodeSelectorTerms:
+      - matchExpressions:
+        - key: "Addons-Services"
+          operator: In
+          values:
+          - "true"
+
+backupjob:
+  resources:
+    requests:
+      memory: 100Mi
+      cpu: 50m
+    limits:
+      memory: 200Mi
+      cpu: 100m

helm/values/restore/values.yaml

@@ -0,0 +1,33 @@
+restore:
+  bucket_uri: ${bucket_uri}
+  aws_default_region: ${s3_bucket_region}
+  db_endpoint: "${db_endpoint}"
+  db_password: "${db_password}"
+  db_username: "${db_username}"
+  DB_NAME: "${DB_NAME}"
+  backup_file_name: "${backup_file_name}"
+
+auth:
+  username: "${db_username}"
+
+annotations:
+  ${annotations}
+
+affinity:
+  nodeAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      nodeSelectorTerms:
+      - matchExpressions:
+        - key: "Addons-Services"
+          operator: In
+          values:
+          - "true"
+
+restorejob:
+  resources:
+    requests:
+      memory: 100Mi
+      cpu: 50m
+    limits:
+      memory: 200Mi
+      cpu: 100m

main.tf

@@ -131,7 +131,7 @@ resource "aws_security_group_rule" "cidr_ingress" {
 
 module "security_group_rds" {
   source      = "terraform-aws-modules/security-group/aws"
-  version     = "~> 4"
+  version     = "~> 5.0"
   name        = format("%s-%s-%s", var.environment, var.name, "rds-sg")
   create      = var.create_security_group
   vpc_id      = var.vpc_id
@@ -155,7 +155,7 @@ module "security_group_rds" {
 resource "aws_secretsmanager_secret" "secret_master_db" {
   name = format("%s/%s/%s", var.environment, var.name, "rds-postgresql-pass")
   tags = merge(
-    { "Name" = format("%s/%s/%s", var.environment, var.name, "rds-mysql-pass") },
+    { "Name" = format("%s/%s/%s", var.environment, var.name, "rds-postgres-pass") },
     local.tags,
   )
 }
@@ -317,3 +317,32 @@ resource "aws_lambda_permission" "sns_lambda_slack_invoke" {
   principal     = "sns.amazonaws.com"
   source_arn    = aws_sns_topic.slack_topic[0].arn
 }
+
+module "backup_restore" {
+  depends_on             = [module.db]
+  source                 = "./modules/db-backup-restore"
+  cluster_name           = var.cluster_name
+  namespace              = var.namespace
+  create_namespace       = var.create_namespace
+  postgresdb_backup_enabled = var.postgresdb_backup_enabled
+  postgresdb_backup_config = {
+    db_username          = var.master_username
+    db_password          = var.custom_user_password != "" ? var.custom_user_password : nonsensitive(random_password.master[0].result)
+    postgres_database_name  = var.postgresdb_backup_config.postgres_database_name
+    s3_bucket_region     = var.postgresdb_backup_config.s3_bucket_region            
+    cron_for_full_backup = var.postgresdb_backup_config.cron_for_full_backup            
+    bucket_uri           = var.postgresdb_backup_config.bucket_uri
+    db_endpoint          = replace(var.replica_enable ? module.db_replica[0].db_instance_endpoint : module.db.db_instance_endpoint, ":5432", "")
+  }
+
+  postgresdb_restore_enabled = var.postgresdb_restore_enabled
+  postgresdb_restore_config  = {
+    db_endpoint      = replace(var.replica_enable ? module.db_replica[0].db_instance_endpoint : module.db.db_instance_endpoint, ":5432", "")
+    db_username      = var.master_username
+    db_password      = var.custom_user_password != "" ? var.custom_user_password : nonsensitive(random_password.master[0].result)
+    bucket_uri       = var.postgresdb_restore_config.bucket_uri                    
+    s3_bucket_region = var.postgresdb_restore_config.s3_bucket_region 
+    DB_NAME          = var.postgresdb_restore_config.DB_NAME,  
+    backup_file_name = var.postgresdb_restore_config.backup_file_name,                              
+  }
+}

modules/db-backup-restore/backup/Chart.yaml

@@ -0,0 +1,4 @@
+apiVersion: v1
+description: A helm chart for Backup of postgres and stored in S3
+name: postgres-backup
+version: 1.0.0

modules/db-backup-restore/backup/templates/backup-secret.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: postgres-bucket-uri
+  namespace:  {{ .Release.Namespace }}
+  labels:
+data:
+  MYSQL_BUCKET_URI: {{ .Values.backup.bucket_uri | b64enc | quote }}

modules/db-backup-restore/backup/templates/cronjob.yaml

@@ -0,0 +1,37 @@
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: backup-postgresdb
+spec:
+  schedule: {{ .Values.backup.cron_for_full_backup |  quote }}
+  concurrencyPolicy: Forbid
+  suspend: false
+  successfulJobsHistoryLimit: 3
+  failedJobsHistoryLimit: 1
+
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          affinity: {{ .Values.affinity | toYaml | nindent 10 }}
+          restartPolicy: OnFailure
+          serviceAccountName: sa-postgres-backup
+          containers:
+          - name: backup-postgresdb
+            image: divyanshujain11/rds:postgres-backup-restore
+            imagePullPolicy: Always
+            command: ["./backup.sh"]
+            env:
+            - name: db_endpoint
+              value: {{ .Values.backup.database_endpoint }}
+            - name: db_username
+              value: {{ .Values.backup.database_user }}
+            - name: db_password
+              value: {{ .Values.backup.database_password }}
+            - name: bucket_uri
+              value: {{ .Values.backup.bucket_uri }}
+            - name: AWS_DEFAULT_REGION
+              value: {{ .Values.backup.aws_default_region}}
+            - name: postgres_database_name
+              value: {{ .Values.backup.postgres_database_name }}
+            resources: {{ .Values.backupjob.resources | toYaml | nindent 12 }}

modules/db-backup-restore/backup/templates/service_account.yaml

@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: sa-postgres-backup
+  namespace: {{ .Release.Namespace }}
+  annotations:
+    {{ toYaml .Values.annotations  | indent 4 }}