Merge pull request #5 from IBM/feat/http-notifier-config

Feat: add backwork support for http notifications

Author: Ben Honda

.env.example

@@ -39,3 +39,13 @@ export MONGO_ADMIN_USER=$MONGO_BACKUP_USER
 export MONGO_ADMIN_PASSWORD="$MONGO_BACKUP_PASSWORD"
 export FORUM_MONGO_PASSWORD="$MONGO_BACKUP_PASSWORD"
 export EDXAPP_MONGO_PASSWORD="$MONGO_BACKUP_PASSWORD"
+
+export HTTP_NOTIFIER_URL=
+export HTTP_NOTIFIER_METHOD=
+export HTTP_NOTIFIER_ADD_HEADERS=
+export HTTP_NOTIFIER_BEARER_TOKEN=
+export HTTP_NOTIFIER_BASIC_AUTH_USER=
+export HTTP_NOTIFIER_BASIC_AUTH_PASS=
+export HTTP_NOTIFIER_PARAMS=
+export HTTP_NOTIFIER_DATA=
+export HTTP_NOTIFIER_KEY=

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][]
 
+## [1.6.0][] - 2021-02-11
+
+### Added
+
+- support for [backwork-notifier-http](https://pypi.org/project/backwork-notifier-http)
+
 ## [1.4.0][] - 2019-08-18
 
 ### Changed

backwork/docker-entrypoint.sh

@@ -4,9 +4,69 @@ set -eo pipefail
 # Docker volume for backups
 export BACKUP_PATH=/backups
 
+NOTIFICATION_NOTIFIERS=(-n)
 NOTIFICATION_SETTINGS=()
+
+# sentry
 if [[ -n ${SENTRY_DSN:-} ]]; then
-  NOTIFICATION_SETTINGS=(-n sentry "--sentry-dsn=${SENTRY_DSN:?}")
+    # add notifier
+    NOTIFICATION_NOTIFIERS+=(sentry)
+    # Sentry DSN
+    NOTIFICATION_SETTINGS+=("--sentry-dsn=${SENTRY_DSN:?}")
+fi
+
+# http notifier
+if [[ -n ${HTTP_NOTIFIER_URL:-} ]]; then
+    # add notifier
+    NOTIFICATION_NOTIFIERS+=(http)
+
+    # endpoint url
+    NOTIFICATION_SETTINGS+=("--http-notifier-url=${HTTP_NOTIFIER_URL:?}")
+
+    # auth stuff
+    if [[ -n ${HTTP_NOTIFIER_BEARER_TOKEN:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-bearer=${HTTP_NOTIFIER_BEARER_TOKEN:?}")
+    fi
+
+    if [[ -n ${HTTP_NOTIFIER_BASIC_AUTH_USER:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-basic-user=${HTTP_NOTIFIER_BASIC_AUTH_USER:?}")
+    fi
+
+    if [[ -n ${HTTP_NOTIFIER_BASIC_AUTH_PASS:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-basic-pass=${HTTP_NOTIFIER_BASIC_AUTH_PASS:?}")
+    fi
+
+    # additional headers
+    if [[ -n ${HTTP_NOTIFIER_ADD_HEADERS:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-add-headers=${HTTP_NOTIFIER_ADD_HEADERS:?}")
+    fi
+
+    # method
+    if [[ -n ${HTTP_NOTIFIER_METHOD:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-method=${HTTP_NOTIFIER_METHOD:?}")
+    fi
+
+    # params
+    if [[ -n ${HTTP_NOTIFIER_PARAMS:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-params=${HTTP_NOTIFIER_PARAMS:?}")
+    fi
+
+    # data body
+    if [[ -n ${HTTP_NOTIFIER_DATA:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-data='${HTTP_NOTIFIER_DATA:?}'")
+    fi
+
+    # key for error message
+    if [[ -n ${HTTP_NOTIFIER_KEY:-} ]]; then
+        NOTIFICATION_SETTINGS+=("--http-notifier-key=${HTTP_NOTIFIER_KEY:?}")
+    fi
+fi
+
+# all notifiers require at least 1 argument
+if [[ ${#NOTIFICATION_SETTINGS[@]} -eq 0 || ${#NOTIFICATION_NOTIFIERS[@]} -eq 1 ]]; then
+    # no notifiers
+    NOTIFICATION_NOTIFIERS=()
+    NOTIFICATION_SETTINGS=()
 fi
 
 log() {
@@ -40,7 +100,7 @@ upload_backup() {
   remote_path="${SOFTLAYER_PATH:?}/$(date +%Y/%m)"
 
   log "Uploading backup"
-  backwork "${NOTIFICATION_SETTINGS[@]}" upload softlayer \
+  backwork "${NOTIFICATION_NOTIFIERS[@]}" "${NOTIFICATION_SETTINGS[@]}" upload softlayer \
     --username "${SOFTLAYER_USER:?}" \
     --api-key "${SOFTLAYER_API_KEY:?}" \
     --datacenter "${SOFTLAYER_DATACENTER:?}" \
@@ -87,7 +147,7 @@ upload_backup_cos() {
   fi
 
   log "Uploading backup to IBM COS"
-  backwork "${NOTIFICATION_SETTINGS[@]}" upload cos \
+  backwork "${NOTIFICATION_NOTIFIERS[@]}" "${NOTIFICATION_SETTINGS[@]}" upload cos \
     --endpoint-url "${IBM_COS_ENDPOINT_URL}" \
     --instance-id "${IBM_COS_INSTANCE_ID}" \
     --access-key "${IBM_COS_ACCESS_KEY}" \
@@ -123,7 +183,7 @@ back_up_mongo() {
   then
     echo "MONGO_URI is not specified, trying MONGO_HOST"
   else
-    backwork "${NOTIFICATION_SETTINGS[@]}" backup mongo \
+    backwork "${NOTIFICATION_NOTIFIERS[@]}" "${NOTIFICATION_SETTINGS[@]}" backup mongo \
       --uri "${MONGO_URI}" \
       --archive="${BACKUP_PATH:?}/${filename}" \
       --gzip
@@ -136,7 +196,7 @@ back_up_mongo() {
   then
     echo "MONGO_HOST is not specified, skipping."
   else
-    backwork "${NOTIFICATION_SETTINGS[@]}" backup mongo \
+    backwork "${NOTIFICATION_NOTIFIERS[@]}" "${NOTIFICATION_SETTINGS[@]}" backup mongo \
       -u "${MONGO_BACKUP_USER}" \
       -p "${MONGO_BACKUP_PASSWORD}" \
       --host="${MONGO_HOST}" \
@@ -159,7 +219,7 @@ back_up_mysql() {
   filename=mysql_backup_$(date +"%Y%m%d_%H%M%S").archive.gz
 
   log "Taking mysql backup"
-  backwork "${NOTIFICATION_SETTINGS[@]}" backup mysql \
+  backwork "${NOTIFICATION_NOTIFIERS[@]}" "${NOTIFICATION_SETTINGS[@]}" backup mysql \
     --output="${BACKUP_PATH:?}/${filename}" \
     --gzip \
     --all-databases \
@@ -195,7 +255,7 @@ back_up_postgresql() {
 
     filename=postgresql_backup_${database:?}_$(date +"%Y%m%d_%H%M%S").archive.gz
 
-    backwork "${NOTIFICATION_SETTINGS[@]}" backup postgresql \
+    backwork "${NOTIFICATION_NOTIFIERS[@]}" "${NOTIFICATION_SETTINGS[@]}" backup postgresql \
       --output="${BACKUP_PATH:?}/${filename}" \
       --gzip \
       "--host=${PGHOST:?}" \
@@ -221,7 +281,7 @@ back_up_files() {
 
   log "Taking file backup"
   # shellcheck disable=SC2086
-  cmd="backwork ${NOTIFICATION_SETTINGS[@]} backup files \
+  cmd="backwork ${NOTIFICATION_NOTIFIERS[@]} ${NOTIFICATION_SETTINGS[@]} backup files \
         --output=\"${BACKUP_PATH:?}/${filename}\""
   for f in ${BACKUP_LOCAL_PATHS_EXCLUDE:-}; do
     cmd="${cmd} --exclude=\"${f}\""

backwork/requirements.txt

@@ -8,3 +8,4 @@ backwork-backup-postgresql==0.2.1
 backwork-notifier-sentry==0.2.0
 backwork-upload-softlayer==0.2.1
 backwork-upload-cos==0.3.0
+backwork-notifier-http==0.1.3

docker-compose.yaml

@@ -7,7 +7,7 @@ services:
   backwork:
     build:
       context: ./backwork
-    image: bigdatauniversity/backwork:1.5.0
+    image: bigdatauniversity/backwork:1.6.0
     environment:
       - MYSQL_HOST=mysql
       - MYSQL_PORT=3306
@@ -42,6 +42,18 @@ services:
       - LOCAL_BACKUP_NUMBER
       - BACKUP_LOCAL_PATHS
       - MINIMUM_FREE_SPACE
+
+      # config for HTTP request notifier
+      - HTTP_NOTIFIER_URL
+      - HTTP_NOTIFIER_METHOD
+      - HTTP_NOTIFIER_ADD_HEADERS
+      - HTTP_NOTIFIER_BEARER_TOKEN
+      - HTTP_NOTIFIER_BASIC_AUTH_USER
+      - HTTP_NOTIFIER_BASIC_AUTH_PASS
+      - HTTP_NOTIFIER_PARAMS
+      - HTTP_NOTIFIER_DATA
+      - HTTP_NOTIFIER_KEY
+
     links:
       - mysql
       - mongo