add mail sending in case of errors

Author: willemvd

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.4
+FROM alpine:3.5
 MAINTAINER Willem willemvd@github
 
 COPY backup.sh /tmp/backup.sh
@@ -11,7 +11,8 @@ RUN apk --no-cache add \
       python \
       py-pip \
       postgresql \
-      openssl && \
+      openssl \
+      heirloom-mailx && \
       pip install --upgrade pip awscli && \
       chmod -R 777 /tmp
 

README.md

@@ -29,4 +29,16 @@ AWS_ACCESS_KEY_ID=<access key id got from Amazon>
 AWS_SECRET_ACCESS_KEY=<secret access key got from Amazon>
 AWS_DEFAULT_REGION=<Amazon region name e.g. eu-central-1>
 S3_BUCKET_NAME=<name of the bucket in S3>
+
+# Email settings
+ENABLE_ERROR_MAIL=<should an email be send when something goes wrong? other then true will disable this>
+ERROR_MAIL_SUBJECT=<subject of the mail, e.g. Failed to run database backup>
+SMTP_HOST=<SMTP host e.g. smtp.office365.com>
+SMTP_PORT=<SMTP port number, mostly 587 or 25>
+SMTP_STARTTLS=<should TLS be used? other then true will disable this>
+SMTP_AUTH=<type of auth, login>
+SMTP_AUTH_USER=<username to login to the SMTP server>
+SMTP_AUTH_PASSWORD=<password for the SMTP user>
+SMTP_FROM=<name and email of the sender in the format: Name <full email adres> >
+SMTP_TO=<email address to send to, multiple addresses can be used with a comma seperated list>
 ```

backup.sh

@@ -1,8 +1,35 @@
 #!/bin/sh
 
-#exit if one of the commands fail
 set -e
 
+handleError() {
+    MSG="Failed to run backup of database '$PGDATABASE' from '$PGHOST:$PGPORT/$PGDATABASE' with user '$PGUSER' to 's3://$S3_BUCKET_NAME/$BACKUP_TYPE/$BACKUP_FILE_NAME'"
+
+    if [  "x$ENABLE_ERROR_MAIL" = "xtrue" ]; then
+
+        OPTS=""
+        if [  "x$SMTP_STARTTLS" = "xtrue" ]; then
+            OPTS="-S smtp-use-starttls";
+        fi
+
+        echo ${MSG} | \
+
+        mailx -v -s "$ERROR_MAIL_SUBJECT" \
+        -S smtp="$SMTP_HOST:$SMTP_PORT" \
+        ${OPTS} \
+        -S smtp-auth=$SMTP_AUTH \
+        -S smtp-auth-user="$SMTP_AUTH_USER" \
+        -S smtp-auth-password="$SMTP_AUTH_PASSWORD" \
+        -r "$SMTP_FROM" \
+        $SMTP_TO
+    else
+        echo ${MSG}
+    fi
+
+    # abort
+    exit 1
+}
+
 DATE=$(date +%Y-%m-%d-%H-%M-%S)
 
 # backup type is used to seperate types like hourly or daily (folders in s3 bucket should be named like that)
@@ -21,7 +48,7 @@ START_DUMP=$(date +%s)
 #PGPASSWORD=
 #PGHOST=
 #PGPORT=
-pg_dump --format=custom > $BACKUP_FILE_NAME
+pg_dump --format=custom > $BACKUP_FILE_NAME || handleError
 
 DONE_DUMP_IN=$(($(date +%s)-$START_DUMP))
 echo "Done dumping ($DONE_DUMP_IN sec) database"
@@ -36,12 +63,12 @@ ENCRYPTION_FILE_NAME_SUFFIX=.enc
 
 echo "Start encrypting database dump file '$BACKUP_FILE_NAME' with cipher type '$OPENSSL_CIPHER_TYPE' and password as defined in environment variable ENCRYPTION_PASS_PHRASE"
 START_ENC=$(date +%s)
-openssl enc -in $BACKUP_FILE_NAME -out $BACKUP_FILE_NAME$ENCRYPTION_FILE_NAME_SUFFIX -e -$OPENSSL_CIPHER_TYPE -pass pass:$ENCRYPTION_PASS_PHRASE
+openssl enc -in $BACKUP_FILE_NAME -out $BACKUP_FILE_NAME$ENCRYPTION_FILE_NAME_SUFFIX -e -$OPENSSL_CIPHER_TYPE -pass pass:$ENCRYPTION_PASS_PHRASE || handleError
 
 DONE_ENC_IN=$(($(date +%s)-$START_ENC))
 echo "Done encrypting ($DONE_ENC_IN sec) database dump file, now remove unencrypted file"
 
-rm -f $BACKUP_FILE_NAME
+rm -fv $BACKUP_FILE_NAME || handleError
 
 echo ""
 
@@ -55,7 +82,7 @@ START_UPLOAD=$(date +%s)
 
 # bucket name to upload to
 #S3_BUCKET_NAME=
-aws s3 cp ./$BACKUP_FILE_NAME$ENCRYPTION_FILE_NAME_SUFFIX s3://$S3_BUCKET_NAME/$BACKUP_TYPE/$BACKUP_FILE_NAME
+aws s3 cp ./$BACKUP_FILE_NAME$ENCRYPTION_FILE_NAME_SUFFIX s3://$S3_BUCKET_NAME/$BACKUP_TYPE/$BACKUP_FILE_NAME || handleError
 
 DONE_UPLOAD_IN=$(($(date +%s)-$START_UPLOAD))
 echo "Done uploading ($DONE_UPLOAD_IN sec) 's3://$S3_BUCKET_NAME/$BACKUP_TYPE/$BACKUP_FILE_NAME'"

openshift-postgresql-s3-backup-scheduledJob.yaml

@@ -16,6 +16,14 @@ items:
   data:
     # don't forget to base64 encode your values
     encryption-pass-phrase: ""
+- apiVersion: "v1"
+  kind: "Secret"
+  metadata:
+    name: "smtp-authentication-secret-production"
+  data:
+    # don't forget to base64 encode your values
+    smtp-user: ""
+    smtp-password: ""
 - apiVersion: batch/v2alpha1
   kind: ScheduledJob
   metadata:
@@ -31,7 +39,7 @@ items:
             activeDeadlineSeconds: 1800
             containers:
             - name: postgresql-s3-hourly-backup
-              image: willemvd/postgresql-client-side-encrypted-s3-backup
+              image: willemvd/postgresql-client-side-encrypted-s3-backup:1.1.0
               env:
               - name: PGDATABASE
                 value:
@@ -66,6 +74,32 @@ items:
                 value:
               - name: BACKUP_TYPE
                 value: hourly
+              - name: ENABLE_ERROR_MAIL
+                value: "true"
+              - name: ERROR_MAIL_SUBJECT
+                value: Failed to run database backup
+              - name: SMTP_HOST
+                value: ""
+              - name: SMTP_PORT
+                value: ""
+              - name: SMTP_STARTTLS
+                value: "true"
+              - name: SMTP_AUTH
+                value:
+              - name: SMTP_AUTH_USER
+                valueFrom:
+                  secretKeyRef:
+                    name: smtp-authentication-secret-production
+                    key: smtp-user
+              - name: SMTP_AUTH_PASSWORD
+                valueFrom:
+                  secretKeyRef:
+                    name: smtp-authentication-secret-production
+                    key: smtp-password
+              - name: SMTP_FROM
+                value: ""
+              - name: SMTP_TO
+                value: ""
             restartPolicy: OnFailure
 - apiVersion: batch/v2alpha1
   kind: ScheduledJob
@@ -82,7 +116,7 @@ items:
             activeDeadlineSeconds: 1800
             containers:
             - name: postgresql-s3-daily-backup
-              image: willemvd/postgresql-client-side-encrypted-s3-backup
+              image: willemvd/postgresql-client-side-encrypted-s3-backup:1.1.0
               env:
               - name: PGDATABASE
                 value:
@@ -117,4 +151,30 @@ items:
                 value:
               - name: BACKUP_TYPE
                 value: daily
+              - name: ENABLE_ERROR_MAIL
+                value: "true"
+              - name: ERROR_MAIL_SUBJECT
+                value: Failed to run database backup
+              - name: SMTP_HOST
+                value: ""
+              - name: SMTP_PORT
+                value: ""
+              - name: SMTP_STARTTLS
+                value: "true"
+              - name: SMTP_AUTH
+                value:
+              - name: SMTP_AUTH_USER
+                valueFrom:
+                  secretKeyRef:
+                    name: smtp-authentication-secret-production
+                    key: smtp-user
+              - name: SMTP_AUTH_PASSWORD
+                valueFrom:
+                  secretKeyRef:
+                    name: smtp-authentication-secret-production
+                    key: smtp-password
+              - name: SMTP_FROM
+                value: ""
+              - name: SMTP_TO
+                value: ""
             restartPolicy: OnFailure