pvbackup: Refactor to native rclone configuration

* Instead of trying to configure individual providers,
  just use a k8s provided rclone configuration file.
* This allow us to use any rclone supported remote backend

Author: kallisti5

containers/tools/pvbackup/README.md

@@ -4,27 +4,20 @@ I'm a simple container to backup/restore encrypted persistant volume data to an
 
 ## Usage
 
-### Docker
-**Backup**
-```
-docker run -it -e S3_BUCKET="" -e S3_KEY="" -e S3_SECRET="" -e TWOSECRET="" -V volume:/pvs/volume docker.io/haiku/persistsync backup volume
-```
+### Volumes
 
-**Restore**
-```
-docker run -it -e S3_BUCKET="" -e S3_KEY="" -e S3_SECRET="" -e TWOSECRET="" -V volume:/pvs/volume docker.io/haiku/persistsync restore volume
-```
+#### Required
+
+* /root/.config/rclone/rclone.conf containing the rclone configuration
+* /root/.config/twosecret containing the encryption key for the backups
 
 ### Environment Flags
 
 #### Required
 
-* S3_ENDPOINT - s3 endpoint
-* S3_BUCKET - s3 bucket name
-* S3_KEY - s3 bucket access key
-* S3_SECRET - s3 bucket secret key
-* TWOSECRET - encryption password for backup
+* REMOTE_PREFIX - prefix path on remote. Likely bucket name for S3
 
 #### Optional
 
-* S3_MAX_AGE - maximum backup age in bucket. ex: 30d,1y,etc
+* REMOTE_NAME - name of remote specified in configuration file (defaults to "backup")
+* REMOTE_MAX_AGE - maximum backup age in bucket. ex: 30d,1y,etc

containers/tools/pvbackup/VERSION

@@ -1,2 +1,2 @@
 # ONLY UPDATE ONCE READY TO BUILD NEW RELEASE
-2.0.6
+3.0.0

containers/tools/pvbackup/pvsync.sh

@@ -16,57 +16,41 @@ if ! [ -x "$(command -v gpg)" ]; then
   exit 1
 fi
 
-
 BASE="/pvs"
 ACTION="$1"
 VOLUME="$2"
 
-S3_NAME="s3remote"
-
-#S3_HOST="http://s3.wasabisys.com"
-#S3_BUCKET=""
-#S3_KEY=""
-#S3_SECRET=""
-#TWOSECRET=""
+RCLONE_CONFIG_PATH="$HOME/.config/rclone/rclone.conf"
+TWOSECRET_PATH="$HOME/.config/twosecret"
 
-if [ -z "$S3_HOST" ]; then
-	echo "Please set S3_HOST!"
-	exit 1
-fi
-if [ -z "$S3_BUCKET" ]; then
-	echo "Please set S3_BUCKET!"
-	exit 1
-fi
-if [ -z "$S3_KEY" ]; then
-	echo "Please set S3_KEY!"
+if [ ! -f $TWOSECRET_PATH ]; then
+	echo "Missing twosecret key at $TWOSECRET_PATH"
 	exit 1
 fi
-if [ -z "$S3_SECRET" ]; then
-	echo "Please set S3_SECRET!"
+
+if [ ! -f $RCLONE_CONFIG_PATH ]; then
+	echo "Missing rclone configuration at $RCLONE_CONFIG_PATH"
 	exit 1
 fi
-if [ -z "$TWOSECRET" ]; then
-	echo "Please set TWOBUCKET!"
+
+if [ ! -z "$REMOTE_PREFIX" ] ;then
+	echo "REMOTE_PREFIX is not defined!  This is the bucket name for s3 or other prefix path"
 	exit 1
 fi
-if [ -z "$S3_PROVIDER" ]; then
-	echo "Assuming S3 provider Other"
-	S3_PROVIDER="Other"
+
+if [ ! -z "$REMOTE_NAME" ] ;then
+	echo "REMOTE_NAME is not defined. Defaulting to 'backup' (make sure this matches config file)"
+	REMOTE_NAME="backup"
 fi
 
 if [[ ! -d "$BASE/$VOLUME" ]]; then
 	echo "Error: '$BASE/$VOLUME' isn't present on local container! (pvc not mounted?)"
 	exit 1
 fi
 
-rclone config create $S3_NAME s3 \
-	provider=$S3_PROVIDER env_auth=false access_key_id=$S3_KEY \
-	secret_access_key=$S3_SECRET region=$S3_REGION \
-	endpoint=$S3_HOST no_check_bucket=true \
-	acl=private > /dev/null
-
-if [[ $? -ne 0 ]]; then
-	echo "Error: Problem encounted configuring s3! (rclone)"
+rclone ls $REMOTE_NAME:$REMOTE_PREFIX/pv-$VOLUME > /dev/null
+if [ $? -ne 0 ]; then
+	echo "Error: Unable to see within configured storage provider!"
 	exit 1
 fi
 
@@ -91,25 +75,25 @@ case $ACTION in
 			exit 1
 		fi
 		rm /tmp/$SNAPSHOT_NAME
-		rclone copy /tmp/$SNAPSHOT_NAME.gpg $S3_NAME:$S3_BUCKET/pv-$VOLUME/
+		rclone copy /tmp/$SNAPSHOT_NAME.gpg $REMOTE_NAME:$REMOTE_PREFIX/pv-$VOLUME/
 		if [[ $? -ne 0 ]]; then
 			echo "Error: Problem encounted during upload! (rclone)"
 			rm /tmp/$SNAPSHOT_NAME.gpg
 			exit 1
 		fi
-		if [[ ! -z "$S3_MAX_AGE" ]]; then
-			echo "Cleaning up old backups for $VOLUME over $S3_MAX_AGE old..."
-			rclone delete --min-age "$S3_MAX_AGE" $S3_NAME:$S3_BUCKET/pv-$VOLUME/
+		if [[ ! -z "$REMOTE_MAX_AGE" ]]; then
+			echo "Cleaning up old backups for $VOLUME over $REMOTE_MAX_AGE old..."
+			rclone delete --min-age "$REMOTE_MAX_AGE" $REMOTE_NAME:$REMOTE_PREFIX/pv-$VOLUME/
 		fi
-		echo "Snapshot of ${VOLUME} completed successfully! ($S3_BUCKET/pv-$VOLUME/$SNAPSHOT_NAME.gpg)"
+		echo "Snapshot of ${VOLUME} completed successfully! ($REMOTE_PREFIX/pv-$VOLUME/$SNAPSHOT_NAME.gpg)"
 		;;
 
 	restore)
 		# We assume the latest is at the bottom of the rclone ls.
 		# It seems to be true in my testing so far... but this feels sketch
-		LATEST=$(rclone ls $S3_NAME:$S3_BUCKET/pv-$VOLUME/ | tail -1 | awk '{print $2}')
+		LATEST=$(rclone ls $REMOTE_NAME:$REMOTE_PREFIX/pv-$VOLUME/ | tail -1 | awk '{print $2}')
 		echo "Found $LATEST to be the latest snapshot..."
-		rclone copy $S3_NAME:$S3_BUCKET/pv-$VOLUME/$LATEST /tmp/$LATEST
+		rclone copy $REMOTE_NAME:$REMOTE_PREFIX/pv-$VOLUME/$LATEST /tmp/$LATEST
 		if [[ $? -ne 0 ]]; then
 			echo "Error: Problem encounted getting snapshot from s3! (rclone)"
 			rm /tmp/$LATEST