Release 1.2.4

README.md

@@ -21,9 +21,10 @@ mysql:backup <name> <bucket> (--use-iam) Create a backup of the mysql service to
 mysql: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 mysql service
 mysql:backup-deauth <name>     Removes backup authentication for the mysql service
 mysql:backup-schedule <name> <schedule> <bucket> Schedules a backup of the mysql service
-mysql:backup-set-encryption <name> <encryption_key>, Sets up GPG encryption for future backups of the mysql service
+mysql:backup-schedule-cat <name> Cat the contents of the configured backup cronfile for the service
+mysql:backup-set-encryption <name> <encryption_key> Sets up GPG encryption for future backups of the mysql service
 mysql:backup-unschedule <name> Unschedules the backup of the mysql service
-mysql:backup-unset-encryption <name>, Removes backup encryption for future backups of the mysql service
+mysql:backup-unset-encryption <name> Removes backup encryption for future backups of the mysql service
 mysql:clone <name> <new-name>  Create container <new-name> then copy data from <name> into <new-name>
 mysql:connect <name>           Connect via mysql to a mysql service
 mysql:create <name>            Create a mysql service with environment variables
@@ -217,6 +218,9 @@ dokku mysql:backup lolipop BUCKET_NAME
 # CRON_SCHEDULE is a crontab expression, eg. "0 3 * * *" for each day at 3am
 dokku mysql:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME
 
+# cat the contents of the configured backup cronfile for the service
+dokku mysql:backup-schedule-cat lolipop
+
 # remove the scheduled backup from cron
 dokku mysql:backup-unschedule lolipop
 ```

common-functions

@@ -59,7 +59,7 @@ is_container_status() {
   declare desc="Returns 0 or 1 depending upon whether a given container has a certain status"
   declare CID="$1" STATUS="$2"
   local TEMPLATE="{{.State.$STATUS}}"
-  local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" || true)
+  local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" 2> /dev/null || true)
 
   if [[ "$CONTAINER_STATUS" == "true" ]]; then
     return 0
@@ -107,23 +107,27 @@ service_alternative_alias() {
 service_backup() {
   declare desc="Creates a backup of a service to an existing s3 bucket"
   declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"
-  local BACKUP_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
+  local SERVICE_BACKUP_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup"
   local BACKUP_ENCRYPTION_CONFIG_ROOT="$PLUGIN_DATA_ROOT/$SERVICE/backup-encryption"
-  local AWS_ACCESS_KEY_ID_FILE="$BACKUP_CONFIG_ROOT/AWS_ACCESS_KEY_ID"
+  local AWS_ACCESS_KEY_ID_FILE="$SERVICE_BACKUP_ROOT/AWS_ACCESS_KEY_ID"
-  local AWS_SECRET_ACCESS_KEY_FILE="$BACKUP_CONFIG_ROOT/AWS_SECRET_ACCESS_KEY"
+  local AWS_SECRET_ACCESS_KEY_FILE="$SERVICE_BACKUP_ROOT/AWS_SECRET_ACCESS_KEY"
+  local ID="$(cat "$SERVICE_ROOT/ID")"
   local BACKUP_PARAMETERS=""
 
-  if [[ "$USE_IAM_OPTIONAL_FLAG" != "--use-iam" ]] && [[ "$USE_IAM_OPTIONAL_FLAG" != "-u" ]]; then
+  if [[ -z "$USE_IAM_OPTIONAL_FLAG" ]]; then
     [[ ! -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"
     BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_ACCESS_KEY_ID=$(cat "$AWS_ACCESS_KEY_ID_FILE") -e AWS_SECRET_ACCESS_KEY=$(cat "$AWS_SECRET_ACCESS_KEY_FILE")"
-  else
+  elif [[ "$USE_IAM_OPTIONAL_FLAG" != "--use-iam" ]] && [[ "$USE_IAM_OPTIONAL_FLAG" != "-u" ]]; then
     dokku_log_fail "Provide AWS credentials or use the --use-iam flag"
   fi
 
   TMPDIR=$(mktemp -d)
   trap 'rm -rf "$TMPDIR" > /dev/null' RETURN INT TERM EXIT
 
+  docker inspect "$ID" &> /dev/null || dokku_log_fail "Service container does not exist"
+  is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
+
   (service_export "$SERVICE" > "${TMPDIR}/export")
 
   # Build parameter list for s3backup tool
@@ -131,16 +135,16 @@ service_backup() {
   BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e BACKUP_NAME=${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
   BACKUP_PARAMETERS="$BACKUP_PARAMETERS -v ${TMPDIR}:/backup"
 
-  if [[ -f "$BACKUP_CONFIG_ROOT/AWS_DEFAULT_REGION" ]]; then
+  if [[ -f "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION" ]]; then
-    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_DEFAULT_REGION=$(cat "$BACKUP_CONFIG_ROOT/AWS_DEFAULT_REGION")"
+    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_DEFAULT_REGION=$(cat "$SERVICE_BACKUP_ROOT/AWS_DEFAULT_REGION")"
   fi
 
-  if [[ -f "$BACKUP_CONFIG_ROOT/AWS_SIGNATURE_VERSION" ]]; then
+  if [[ -f "$SERVICE_BACKUP_ROOT/AWS_SIGNATURE_VERSION" ]]; then
-    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_SIGNATURE_VERSION=$(cat "$BACKUP_CONFIG_ROOT/AWS_SIGNATURE_VERSION")"
+    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e AWS_SIGNATURE_VERSION=$(cat "$SERVICE_BACKUP_ROOT/AWS_SIGNATURE_VERSION")"
   fi
 
-  if [[ -f "$BACKUP_CONFIG_ROOT/ENDPOINT_URL" ]]; then
+  if [[ -f "$SERVICE_BACKUP_ROOT/ENDPOINT_URL" ]]; then
-    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENDPOINT_URL=$(cat "$BACKUP_CONFIG_ROOT/ENDPOINT_URL")"
+    BACKUP_PARAMETERS="$BACKUP_PARAMETERS -e ENDPOINT_URL=$(cat "$SERVICE_BACKUP_ROOT/ENDPOINT_URL")"
   fi
 
   if [[ -f "$BACKUP_ENCRYPTION_CONFIG_ROOT/ENCRYPTION_KEY" ]]; then
@@ -154,23 +158,22 @@ service_backup() {
 service_backup_auth() {
   declare desc="Sets up authentication"
   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="$PLUGIN_DATA_ROOT/$SERVICE/backup"
-  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_ACCESS_KEY_ID" > "$SERVICE_BACKUP_ROOT/AWS_ACCESS_KEY_ID"
-  echo "$AWS_SECRET_ACCESS_KEY" > "${SERVICE_BACKUP_ROOT}/AWS_SECRET_ACCESS_KEY"
+  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"
+    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"
+    echo "$AWS_SIGNATURE_VERSION" > "$SERVICE_BACKUP_ROOT/AWS_SIGNATURE_VERSION"
   fi
 
   if [[ -n "$ENDPOINT_URL" ]]; then
-    echo "$ENDPOINT_URL" > "${SERVICE_BACKUP_ROOT}/ENDPOINT_URL"
+    echo "$ENDPOINT_URL" > "$SERVICE_BACKUP_ROOT/ENDPOINT_URL"
   fi
 }
 
@@ -185,17 +188,33 @@ service_backup_deauth() {
 
 service_backup_schedule() {
   declare desc="schedules a backup of the service"
-  declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3"
+  declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"
   local DOKKU_BIN="$(which dokku)"
   local CRON_FILE="/etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
   local TMP_CRON_FILE="${PLUGIN_DATA_ROOT}/.TMP_CRON_FILE"
 
-  echo "${SCHEDULE} dokku ${DOKKU_BIN} ${PLUGIN_COMMAND_PREFIX}:backup ${SERVICE} ${BUCKET_NAME}" > "$TMP_CRON_FILE"
+  if [[ -n "$USE_IAM_OPTIONAL_FLAG" ]] && [[ "$USE_IAM_OPTIONAL_FLAG" != "--use-iam" ]] && [[ "$USE_IAM_OPTIONAL_FLAG" != "-u" ]]; then
+    dokku_log_fail "Invalid flag provided, only '--use-iam' allowed"
+  fi
+
+  echo "${SCHEDULE} dokku ${DOKKU_BIN} ${PLUGIN_COMMAND_PREFIX}:backup ${SERVICE} ${BUCKET_NAME} ${USE_IAM_OPTIONAL_FLAG}" > "$TMP_CRON_FILE"
   sudo /bin/mv "$TMP_CRON_FILE" "$CRON_FILE"
   sudo /bin/chown root:root "$CRON_FILE"
   sudo /bin/chmod 644 "$CRON_FILE"
 }
 
+service_backup_schedule_cat() {
+  declare desc="cat the contents of the configured backup cronfile for the service"
+  declare SERVICE="$1"
+  local CRON_FILE="/etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-${SERVICE}"
+
+  if [[ ! -f "$CRON_FILE" ]]; then
+    dokku_log_fail "There is no scheduled backup for ${SERVICE}."
+  fi
+
+  cat "$CRON_FILE"
+}
+
 service_backup_unschedule() {
   declare desc="unschedules the backup of the service"
   declare SERVICE="$1"
@@ -229,8 +248,8 @@ service_enter() {
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local ID="$(cat "$SERVICE_ROOT/ID")"
 
-  docker inspect "$ID" &> /dev/null || dokku_log_fail "Container does not exist"
+  docker inspect "$ID" &> /dev/null || dokku_log_fail "Service container does not exist"
-  is_container_status "$ID" "Running" || dokku_log_fail "Container is not running"
+  is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"
 
   local EXEC_CMD=""
   has_tty && local DOKKU_RUN_OPTS+=" -i -t"
@@ -375,8 +394,11 @@ service_logs() {
     DOKKU_LOGS_ARGS="--follow"
   fi
 
+  docker inspect "$ID" &> /dev/null || dokku_log_fail "Service container does not exist"
+  is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running"
+
   # shellcheck disable=SC2086
-  docker logs $DOKKU_LOGS_ARGS "$ID"
+  docker logs $DOKKU_LOGS_ARGS "$ID" 2> /dev/null
 }
 
 service_parse_args() {
@@ -553,13 +575,17 @@ service_status() {
   declare SERVICE="$1"
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local ID="$(cat "$SERVICE_ROOT/ID")"
+  local CONTAINER_STATUS
 
   is_container_status "$ID" "Dead" && echo "dead" && return 0
   is_container_status "$ID" "OOMKilled" && echo "oomkilled" && return 0
   is_container_status "$ID" "Paused" && echo "paused" && return 0
   is_container_status "$ID" "Restarting" && echo "restarting" && return 0
   is_container_status "$ID" "Running" && echo "running" && return 0
-  echo "stopped" && return 0
+
+  CONTAINER_STATUS=$(docker inspect -f "{{.State.Status}}" "$CID" 2> /dev/null || true)
+  [[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0
+  echo "missing" && return 0
 }
 
 service_stop() {
@@ -608,7 +634,7 @@ service_version() {
   declare desc="Displays the running version for an image"
   declare SERVICE="$1"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME"
+  docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2> /dev/null || true
 }
 
 update_plugin_scheme_for_app() {

config

@@ -11,6 +11,8 @@ export PLUGIN_DATA_HOST_ROOT=$MYSQL_HOST_ROOT
 export PLUGIN_DATASTORE_PORTS=(3306)
 export PLUGIN_DATASTORE_WAIT_PORT=3306
 export PLUGIN_DEFAULT_ALIAS="DATABASE"
+export PLUGIN_DISABLE_PULL=${MYSQL_DISABLE_PULL:=}
+export PLUGIN_DISABLE_PULL_VARIABLE="MYSQL_DISABLE_PULL"
 export PLUGIN_ALT_ALIAS="DOKKU_MYSQL"
 export PLUGIN_IMAGE=$MYSQL_IMAGE
 export PLUGIN_IMAGE_VERSION=$MYSQL_IMAGE_VERSION

functions

@@ -30,8 +30,8 @@ service_create() {
   service_parse_args "${@:2}"
 
   if ! docker images | grep -e "^$PLUGIN_IMAGE " | grep -q " $PLUGIN_IMAGE_VERSION " ; then
-    if [[ "$MYSQL_DISABLE_PULL" == "true" ]]; then
+    if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
-      dokku_log_warn "MYSQL_DISABLE_PULL environment variable detected. Not running pull command." 1>&2
+      dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
       dokku_log_warn "   docker pull ${IMAGE}" 1>&2
       dokku_log_warn "$PLUGIN_SERVICE service creation failed"
       exit 1

install

@@ -5,8 +5,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 plugin-install() {
   pull-docker-image() {
     declare IMAGE="$1"
-    if [[ "$MYSQL_DISABLE_PULL" == "true" ]]; then
+    if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
-      echo " !     MYSQL_DISABLE_PULL environment variable detected. Not running pull command." 1>&2
+      echo " !     ${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
       echo " !        docker pull ${IMAGE}" 1>&2
       return
     fi

plugin.toml

@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku mysql service plugin"
-version = "1.1.0"
+version = "1.2.4"
 [plugin.config]

subcommands/backup

@@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 service-backup-cmd() {
   #E backup the 'lolipop' service to the 'my-s3-bucket' bucket on AWS
   #E dokku $PLUGIN_COMMAND_PREFIX:backup lolipop my-s3-bucket --use-iam
-  #F -i|--use-iam, use the IAM profile associated with the current server
+  #F -u|--use-iam, use the IAM profile associated with the current server
   #A service, service to run command against
   #A bucket-name, name of the s3 bucket to upload backups to
   declare desc="creates a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"

subcommands/backup-schedule

@@ -7,19 +7,22 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 service-backup-schedule-cmd() {
   #E schedule a backup
   #E > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lolipop "0 3 * * *" my-s3-bucket
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket
+  #E schedule a backup and authenticate via iam
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam
+  #F -u|--use-iam, use the IAM profile associated with the current server
   #A service, service to run command against
   #A schedule, a cron schedule to run backups on
   #A bucket-name, name of the s3 bucket to upload backups to
   declare desc="schedules a backup of the $PLUGIN_SERVICE service"
   local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3"
+  declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
   [[ -z "$SCHEDULE" ]] && dokku_log_fail "Please specify a schedule for the backup"
   [[ -z "$BUCKET_NAME" ]] && dokku_log_fail "Please specify an aws bucket for the backup"
   verify_service_name "$SERVICE"
-  service_backup_schedule "$SERVICE" "$SCHEDULE" "$BUCKET_NAME"
+  service_backup_schedule "$SERVICE" "$SCHEDULE" "$BUCKET_NAME" "$USE_IAM_OPTIONAL_FLAG"
 }
 
 service-backup-schedule-cmd "$@"

subcommands/backup-schedule-cat

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_BASE_PATH/common/functions"
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
+
+service-backup-schedule-cat-cmd() {
+  #E cat the contents of the configured backup cronfile for the service
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lolipop
+  #A service, service to run command against
+  declare desc="cat the contents of the configured backup cronfile for the service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_backup_schedule_cat "$SERVICE"
+}
+
+service-backup-schedule-cat-cmd "$@"