Adds parameters to backup-auth for region support and non AWS endpoint support

Refs dokku/dokku-mariadb#61
2017-08-26 00:03:36 -04:00
parent cfe18140f7
commit c4b0235936
4 changed files with 56 additions and 16 deletions
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ sudo dokku plugin:install https://github.com/dokku/dokku-mongo.git mongo

 ```
 mongo:backup <name> <bucket>   Create a backup of the mongo service to an existing s3 bucket
-mongo:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> Sets up authentication for backups on the mongo service
+mongo:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) Sets up authentication for backups on the mongo service
 mongo:backup-deauth <name>     Removes backup authentication for the mongo service
 mongo:backup-schedule <name> <schedule> <bucket> Schedules a backup of the mongo service
 mongo:backup-unschedule <name> Unschedules the backup of the mongo service
@@ -188,9 +188,7 @@ OR

 ## Backups

-Datastore backups are supported via AWS S3. The only supported region is `us-east-1`, and using an S3 bucket in another region will result in an error.
-
-> If you would like to sponsor work to enable support for other regions, please contact [@josegonzalez](http://github.com/josegonzalez/).
+Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).

 Backups can be performed using the backup commands:

@@ -211,3 +209,16 @@ dokku mongo:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME
 # remove the scheduled backup from cron
 dokku mongo:backup-unschedule lolipop
 ```
+
+Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio):
+ 
+```
+# setup s3 backup authentication with different region
+dokku mongo:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
+ 
+# setup s3 backup authentication with different signature version and endpoint
+dokku mongo:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
+ 
+# more specific example for minio auth
+dokku mongo:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
+```
--- a/2
+++ b/2
@@ -109,7 +109,7 @@ case "$1" in
      declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content"
      cat<<help_content
    $PLUGIN_COMMAND_PREFIX:backup <name> <bucket>, Create a backup of the $PLUGIN_COMMAND_PREFIX service to an existing s3 bucket
-    $PLUGIN_COMMAND_PREFIX:backup-auth <name> <aws_access_key_id> <aws_secret_access_key>, Sets up authentication for backups on the $PLUGIN_COMMAND_PREFIX service
+    $PLUGIN_COMMAND_PREFIX:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>), Sets up authentication for backups on the $PLUGIN_COMMAND_PREFIX service
    $PLUGIN_COMMAND_PREFIX:backup-deauth <name>, Removes backup authentication for the $PLUGIN_COMMAND_PREFIX service
    $PLUGIN_COMMAND_PREFIX:backup-schedule <name> <schedule> <bucket>, Schedules a backup of the $PLUGIN_COMMAND_PREFIX service
    $PLUGIN_COMMAND_PREFIX:backup-unschedule <name>, Unschedules the backup of the $PLUGIN_COMMAND_PREFIX service
--- a/49
+++ b/49
@@ -31,6 +31,7 @@ get_random_ports() {
    local quit=0
    while [ "$quit" -ne 1 ]; do
      netstat -an | grep $port > /dev/null
+      # shellcheck disable=SC2181
      if [ $? -gt 0 ]; then
        quit=1
      else
@@ -105,9 +106,9 @@ service_alternative_alias() {
 service_backup() {
  declare desc="Creates a backup of a service to an existing s3 bucket"
  declare SERVICE="$1" BUCKET_NAME="$2"
-  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
-  local AWS_ACCESS_KEY_ID_FILE="$SERVICE_ROOT/backup/AWS_ACCESS_KEY_ID"
-  local AWS_SECRET_ACCESS_KEY_FILE="$SERVICE_ROOT/backup/AWS_SECRET_ACCESS_KEY"
+  local BACKUP_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
+  local AWS_ACCESS_KEY_ID_FILE="$BACKUP_CONFIG_ROOT/AWS_ACCESS_KEY_ID"
+  local AWS_SECRET_ACCESS_KEY_FILE="$BACKUP_CONFIG_ROOT/AWS_SECRET_ACCESS_KEY"

  [[ ! -f "$AWS_ACCESS_KEY_ID_FILE" ]] && dokku_log_fail "Missing AWS_ACCESS_KEY_ID file"
  [[ ! -f "$AWS_SECRET_ACCESS_KEY_FILE" ]] && dokku_log_fail "Missing AWS_SECRET_ACCESS_KEY file"
@@ -116,23 +117,51 @@ service_backup() {
  trap 'rm -rf "$TMPDIR" > /dev/null' RETURN INT TERM EXIT

  (service_export "$SERVICE" > "${TMPDIR}/export")
-  docker run \
-      -e AWS_ACCESS_KEY_ID="$(cat "$AWS_ACCESS_KEY_ID_FILE")" \
-      -e AWS_SECRET_ACCESS_KEY="$(cat "$AWS_SECRET_ACCESS_KEY_FILE")" \
-      -e BUCKET_NAME="$BUCKET_NAME" \
-      -e BACKUP_NAME="${PLUGIN_COMMAND_PREFIX}-${SERVICE}" \
-      -v "${TMPDIR}:/backup" dokkupaas/s3backup:0.6.0
+
+  # Build parameter list for s3backup tool
+  BACKUP_PARAMETERS="-e AWS_ACCESS_KEY_ID=$(cat "$AWS_ACCESS_KEY_ID_FILE") \
+                     -e AWS_SECRET_ACCESS_KEY=$(cat "$AWS_SECRET_ACCESS_KEY_FILE") \
+                     -e BUCKET_NAME=$BUCKET_NAME \
+                     -e BACKUP_NAME=${PLUGIN_COMMAND_PREFIX}-${SERVICE} \
+                     -v ${TMPDIR}:/backup"
+
+  if [[ -f "$BACKUP_CONFIG_ROOT/AWS_DEFAULT_REGION" ]]; then
+    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_DEFAULT_REGION=$(cat "$BACKUP_CONFIG_ROOT/AWS_DEFAULT_REGION")"
+  fi
+
+  if [[ -f "$BACKUP_CONFIG_ROOT/AWS_SIGNATURE_VERSION" ]]; then
+    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_SIGNATURE_VERSION=$(cat "$BACKUP_CONFIG_ROOT/AWS_SIGNATURE_VERSION")"
+  fi
+
+  if [[ -f "$BACKUP_CONFIG_ROOT/ENDPOINT_URL" ]]; then
+    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENDPOINT_URL=$(cat "$BACKUP_CONFIG_ROOT/ENDPOINT_URL")"
+  fi
+
+  # shellcheck disable=SC2086
+  docker run $BACKUP_PARAMETERS dokkupaas/s3backup:0.7.0
 }

 service_backup_auth() {
  declare desc="Sets up authentication"
-  declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3"
+  declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
  local SERVICE_ROOT="${PLUGIN_DATA_ROOT}/${SERVICE}"
  local SERVICE_BACKUP_ROOT="${SERVICE_ROOT}/backup/"

  mkdir -p "$SERVICE_BACKUP_ROOT"
  echo "$AWS_ACCESS_KEY_ID" > "${SERVICE_BACKUP_ROOT}/AWS_ACCESS_KEY_ID"
  echo "$AWS_SECRET_ACCESS_KEY" > "${SERVICE_BACKUP_ROOT}/AWS_SECRET_ACCESS_KEY"
+
+  if [[ -n "$AWS_DEFAULT_REGION" ]]; then
+    echo "$AWS_DEFAULT_REGION" > "${SERVICE_BACKUP_ROOT}/AWS_DEFAULT_REGION"
+  fi
+
+  if [[ -n "$AWS_SIGNATURE_VERSION" ]]; then
+    echo "$AWS_SIGNATURE_VERSION" > "${SERVICE_BACKUP_ROOT}/AWS_SIGNATURE_VERSION"
+  fi
+
+  if [[ -n "$ENDPOINT_URL" ]]; then
+    echo "$ENDPOINT_URL" > "${SERVICE_BACKUP_ROOT}/ENDPOINT_URL"
+  fi
 }

 service_backup_deauth() {
--- a/2
+++ b/2
@@ -13,7 +13,7 @@ plugin-install() {
  pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
  pull-docker-image "svendowideit/ambassador:latest"
  pull-docker-image "dokkupaas/wait:0.2"
-  pull-docker-image "dokkupaas/s3backup:0.6.0"
+  pull-docker-image "dokkupaas/s3backup:0.7.0"
  pull-docker-image "busybox:latest"

  mkdir -p "$PLUGIN_DATA_ROOT" || echo "Failed to create $PLUGIN_SERVICE directory"