Merge pull request #2 from offen/mc-extra-flags

Allow passing custom arguments to minio client

README.md

@@ -28,7 +28,7 @@ AWS_SECRET_ACCESS_KEY="<xxx>"
 AWS_S3_BUCKET_NAME="<xxx>"
 
 # This is the FQDN of your storage server, e.g. `storage.example.com`.
-# You can leave it blank when working against AWS S3.
+# Do not set this when working against AWS S3.
 # AWS_ENDPOINT="<xxx>"
 
 ########### BACKUP PRUNING
@@ -38,11 +38,29 @@ AWS_S3_BUCKET_NAME="<xxx>"
 
 # BACKUP_RETENTION_DAYS="7"
 
+# In case the duration a backup takes fluctuates noticeably in your setup
+# you can adjust this setting to make sure there are no race conditions
+# between the backup finishing and the pruning not deleting backups that
+# sit on the very edge of the time window. Set this value to a duration
+# that is expected to be bigger than the maximum difference of backups.
+# Valid values have a suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.
+
+# BACKUP_PRUNING_LEEWAY="10m"
+
 ########### BACKUP ENCRYPTION
 
 # Backups can be encrypted using gpg in case a passphrase is given
 
 # GPG_PASSPHRASE="<xxx>"
+
+########### MINIO CLIENT CONFIGURATION
+
+# Pass these additional flags to all MinIO client `mc` invocations.
+# This can be used for example to pass `--insecure` when using self
+# signed certificates, or passing `--debug` to gain insights on
+# unexpected behavior.
+
+# MC_GLOBAL_OPTIONS="<xxx>"
 ```
 
 ## Example in a docker-compose setup
@@ -80,7 +98,9 @@ volumes:
 
 ## Differences to `futurice/docker-volume-backup`
 
-This image is heavily inspired by the `futurice/docker-volume-backup`. We decided to publish this image because of the following requirements:
+This image is heavily inspired by the `futurice/docker-volume-backup`. We decided to publish this image as a simpler and more lightweight alternative because of the following requirements:
 
-- The original image is based on `ubuntu`, making it very heavy. This version is roughly 500MB smaller in size.
+- The original image is based on `ubuntu`, making it very heavy. This version is roughly 1/3 in compressed size.
+- This image makes use of the MinIO client `mc` instead of the full blown AWS CLI for uploading backups.
 - The original image proposed to handle backup rotation through AWS S3 lifecycle policies. This image adds the option to rotate old backups through the same script so this functionality can also be offered for non-AWS storage backends like MinIO.
+- InfluxDB specific functionality was removed.

src/backup.sh

@@ -12,7 +12,7 @@ function info {
   echo -e "\n[INFO] $1\n"
 }
 
-info "Backup starting"
+info "Preparing backup"
 DOCKER_SOCK="/var/run/docker.sock"
 
 if [ -S "$DOCKER_SOCK" ]; then
@@ -25,12 +25,12 @@ if [ -S "$DOCKER_SOCK" ]; then
   CONTAINERS_TO_STOP_TOTAL="$(cat $TEMPFILE | wc -l)"
   CONTAINERS_TOTAL="$(docker ps --format "{{.ID}}" | wc -l)"
   rm "$TEMPFILE"
-  echo "$CONTAINERS_TOTAL containers running on host in total"
-  echo "$CONTAINERS_TO_STOP_TOTAL containers marked to be stopped during backup"
+  echo "$CONTAINERS_TOTAL containers running on host in total."
+  echo "$CONTAINERS_TO_STOP_TOTAL containers marked to be stopped during backup."
 else
   CONTAINERS_TO_STOP_TOTAL="0"
   CONTAINERS_TOTAL="0"
-  echo "Cannot access \"$DOCKER_SOCK\", won't look for containers to stop"
+  echo "Cannot access \"$DOCKER_SOCK\", won't look for containers to stop."
 fi
 
 if [ "$CONTAINERS_TO_STOP_TOTAL" != "0" ]; then
@@ -57,9 +57,9 @@ fi
 
 if [ ! -z "$AWS_S3_BUCKET_NAME" ]; then
   info "Uploading backup to remote storage"
-  echo "Will upload to bucket \"$AWS_S3_BUCKET_NAME\""
-  mc cp "$BACKUP_FILENAME" "backup-target/$AWS_S3_BUCKET_NAME"
-  echo "Upload finished"
+  echo "Will upload to bucket \"$AWS_S3_BUCKET_NAME\"."
+  mc cp $MC_GLOBAL_OPTIONS "$BACKUP_FILENAME" "backup-target/$AWS_S3_BUCKET_NAME"
+  echo "Upload finished."
 fi
 
 if [ -f "$BACKUP_FILENAME" ]; then
@@ -68,26 +68,29 @@ if [ -f "$BACKUP_FILENAME" ]; then
 fi
 
 info "Backup finished"
-echo "Will wait for next scheduled backup"
+echo "Will wait for next scheduled backup."
 
 if [ ! -z "$BACKUP_RETENTION_DAYS" ]; then
   info "Pruning old backups"
+  echo "Sleeping ${BACKUP_PRUNING_LEEWAY} before checking eligibility."
+  sleep "$BACKUP_PRUNING_LEEWAY"
   bucket=$AWS_S3_BUCKET_NAME
 
-  rule_applies_to=$(mc rm --fake --recursive -force --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket" | wc -l)
+  rule_applies_to=$(mc rm $MC_GLOBAL_OPTIONS --fake --recursive -force --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket" | wc -l)
   if [ "$rule_applies_to" == "0" ]; then
-    echo "No backups found that match the configured retention period. Doing nothing."
+    echo "No backups found older than the configured retention period of $BACKUP_RETENTION_DAYS days."
+    echo "Doing nothing."
     exit 0
   fi
 
-  available=$(mc ls "backup-target/$bucket" | wc -l)
+  total=$(mc ls $MC_GLOBAL_OPTIONS "backup-target/$bucket" | wc -l)
 
-  if [ "$rule_applies_to" == "$available" ]; then
-    echo "Using a retention of $BACKUP_RETENTION_DAYS days would prune all currently existing backups, will not continue."
+  if [ "$rule_applies_to" == "$total" ]; then
+    echo "Using a retention of ${BACKUP_RETENTION_DAYS} days would prune all currently existing backups, will not continue."
     echo "If this is what you want, please remove files manually instead of using this script."
     exit 1
   fi
 
-  mc rm --recursive -force --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket"
-  echo "Successfully pruned all backups older than ${BACKUP_RETENTION_DAYS} days"
+  mc rm $MC_GLOBAL_OPTIONS --recursive -force --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket"
+  echo "Successfully pruned ${rule_applies_to} backups older than ${BACKUP_RETENTION_DAYS} days."
 fi

src/entrypoint.sh

@@ -15,21 +15,24 @@ BACKUP_CRON_EXPRESSION="${BACKUP_CRON_EXPRESSION:-@daily}"
 BACKUP_FILENAME=${BACKUP_FILENAME:-"backup-%Y-%m-%dT%H-%M-%S.tar.gz"}
 
 BACKUP_RETENTION_DAYS="${BACKUP_RETENTION_DAYS:-}"
+BACKUP_PRUNING_LEEWAY="${BACKUP_PRUNING_LEEWAY:-10m}"
 
 AWS_S3_BUCKET_NAME="${AWS_S3_BUCKET_NAME:-}"
 AWS_ENDPOINT="${AWS_ENDPOINT:-s3.amazonaws.com}"
 
 GPG_PASSPHRASE="${GPG_PASSPHRASE:-}"
+
+MC_GLOBAL_OPTIONS="${MC_GLOBAL_OPTIONS:-}"
 EOF
 chmod a+x env.sh
 source env.sh
 
-mc alias set backup-target "https://$AWS_ENDPOINT" "$AWS_ACCESS_KEY_ID" "$AWS_SECRET_ACCESS_KEY"
+mc $MC_GLOBAL_OPTIONS alias set backup-target "https://$AWS_ENDPOINT" "$AWS_ACCESS_KEY_ID" "$AWS_SECRET_ACCESS_KEY"
 
 # Add our cron entry, and direct stdout & stderr to Docker commands stdout
-echo "Installing cron.d entry with expression $BACKUP_CRON_EXPRESSION"
+echo "Installing cron.d entry with expression $BACKUP_CRON_EXPRESSION."
 echo "$BACKUP_CRON_EXPRESSION backup 2>&1" | crontab -
 
 # Let cron take the wheel
-echo "Starting cron in foreground"
+echo "Starting cron in foreground."
 crond -f -l 8