Sanitized for CV

.gitea/workflows/kumonoboru.yaml

@@ -1,9 +1,7 @@
 name: Configure Kumonoboru
 
-#on:
+on:
-#  push:
+  push:
-#  schedule:
-#    - cron: '30 08 * * *'
 
 jobs:
   deploy:

.kumonoboru

@@ -1,3 +0,0 @@
-Gerbil-TK 		/var/Red-Vol/Media/Pictures
-Pukeko-XYZ-Containers	/var/Red-Vol/Media/Containers
-Pukeko-XYZ-Cloud	/var/Red-Vol/Media/Cloud

inventory.yaml

@@ -0,0 +1,5 @@
+all:
+  hosts:
+    takahe:
+      ansible_host: 192.168.0.66
+      ansible_user: shmick

kumonoboru.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
-##Simple script to run Restic backups
+## Script to run Restic backups to a B2 backend.
+## It makes sure each of the preconfigured repositories can be safely backed up.
 
 show_help()
 {
@@ -8,7 +9,11 @@ show_help()
     echo "  {-r|--repository} repository -- Only backup the specified repository."
     echo "  {-l|--limit} #[Kbps]         -- Limit upload & download speed"
     echo "  {-v|--verbose}	       -- Print debug messages"
-    echo "  {-h|--show_help}                  -- Print this show_help message and exit"
+    echo "  {-h|--show_help}             -- Print this show_help message and exit"
+    echo "Available repositories:"
+    echo "REPO-1      stuff		(path: /stuff/stuff1)"
+    echo "REPO-2      other stuff	(path: /stuff/stuff2)"
+    echo "REPO-3      more stuff        (path: /stuff/stuff3)"
     exit 0
 }
 #Pass arguments to the script
@@ -40,23 +45,7 @@ flags()
 }
 flags "$@"
 
-#File to write results to; picked up by Prometheus and yells about changes
+## Defaults
-PROM_FILE="/var/Red-Vol/Media/Containers/prometheus/data/kumonoboru.prom"
-
-#Remove log from last runs, if present
-if [[ -f $PROM_FILE ]]; then
-	rm $PROM_FILE
-fi
-## Monitoring codes:
-#+ -3 - failed cleaning
-#+ -2 - failed integrity check
-#+ -1 - failed to unlock
-#+  0 - succesfully backed up
-#+  1 - failed backup
-#+  2 - passed integrity check
-#+  3-  succesfully cleaned
-
-#Defaults
 if [[ -z $BWLIMIT ]]; then
 	export BWLIMIT="0"
 else
@@ -69,20 +58,15 @@ if [[ -n $REPOSITORY ]]; then
 	    echo -e "Will only process repository" "$1"
 fi	    
 
-export B2_ACCOUNT_ID=8582a42a3b99 #Master Key
-export B2_ACCOUNT_KEY=00041845e8dd29d7e3d091d77bb8a631ee71332be7 #Master Application ID
-export RESTIC_PASSWORD='f$774$#je4%U8vp8ov*UsZMHqL$m3Smh#fEbbt7hyULQxfnnWmSiS5MEndzVWT$$n^@s$P*o4vV*^rgv3jvvrv@y35VppU$$y*vnG5V@botU&4$39Y6t9HSb3Z548M!4'
-
 
 #Safety function; accepts repository to check
 safety(){
 	REPOSITORY="$1"
-	echo -e "Checking if repository $REPOSITORY is in use "
+	echo -e "Checking if repository is in use - " "$REPOSITORY"
 	#Check no other Restic process is using this repository; Free unnecessary locks, if present
 	if [[ -n $(ps aux | grep restic | grep "$REPOSITORY") ]]; then
 		echo -e "Repository is in use - ignoring"
-		echo "system_backup{name=\"$REPOSITORY\"} -1" >> $PROM_FILE
+		return 1
-		return 1	#					code for   ^ failed to unlock
 #		       ^ If there's a restic process holding the repository, leave it alone.
 	else
 		echo -e "Repository is not in use - unlocking"
@@ -100,10 +84,8 @@ backup(){
 		echo -e "Backing up repository" "$REPOSITORY"
 		if restic --cache-dir="$RESTIC_CACHE_DIR" -r b2:"$REPOSITORY" backup "$REPOSITORY_PATH" --limit-upload="$BWLIMIT" --limit-download="$BWLIMIT"; then
 			echo -e "$REPOSITORY_PATH" "completed upload to $REPOSITORY."
-					echo "system_backup{name=\"$REPOSITORY\"} 0" >> $PROM_FILE
 		else
 			echo -e "$REPOSITORY failed to upload path" "$REPOSITORY_PATH"
-			echo "system_backup{name=\"$REPOSITORY\"} 1" >> $PROM_FILE
 		fi
 	fi
 }
@@ -111,24 +93,20 @@ backup(){
 check(){
 	REPOSITORY="$1"
 	PRUNE="$2"
-	echo -e "Checking integrity (prune: $PRUNE) of repository $REPOSITORY"
+	echo -e "Checking integrity (prune: $PRUNE) of repository" "$REPOSITORY"
 ##	^ This variable will have value if repo is already clean, indicating
 #+	This is a post backup check.
 	if [[ -n $PRUNE ]]; then
 		echo -e "This repository has been cleaned already; will not clean again."
 	fi
 	if safety "$REPOSITORY"; then
-		echo -e "Checking health of repository $REPOSITORY" 
+		echo -e "Checking repository health - " "$REPOSITORY"
 		if restic -r b2:"$REPOSITORY" check --limit-upload="$BWLIMIT" --limit-download="$BWLIMIT"; then
-			echo -e "Repository $REPOSITORY passed integrity check"
+			echo -e "Repository passed integrity check - " "$REPOSITORY"
-			echo "system_backup{name=\"$REPOSITORY\"} 2" >> $PROM_FILE
 			echo -e "Current snapshots:"
 			restic -r b2:"$REPOSITORY" snapshots | tee -a $LOG
 		else
-			echo -e "Repository $REPOSITORY failed integrity check"
+			echo -e "Repository failed integrity check - " "$REPOSITORY"
-			echo "system_backup{name=\"$REPOSITORY\"} -2" >> $PROM_FILE
-			#								code for  ^ failed integrity check
-
 		fi
 	fi
 }
@@ -138,65 +116,66 @@ clean(){
 	if safety "$REPOSITORY"; then
 		echo -e "Cleaning repository" "$REPOSITORY"
 		if restic -r b2:$REPOSITORY forget --keep-daily 7 --keep-weekly 4 --keep-monthly 12 --prune --limit-upload="$BWLIMIT" --limit-download="$BWLIMIT"; then
-			echo -e "Repository $REPOSITORY is clean"
+			echo -e "Repository is trim - " "$REPOSITORY"
-			echo "system_backup{name=\"$REPOSITORY\"} 3" >> $PROM_FILE
 			echo -e "Running post clean check..."
 			check "$REPOSITORY" "1"
 #	 Marks repository as cleaned already ^ so it won't passed to this function again.
 		else
-				echo -e "Failed to clean repository $REPOSITORY"
+				echo -e "Failed to prune repository" "$REPOSITORY"
-				echo "system_backup{name=\"$REPOSITORY\"} -3" >> $PROM_FILE
-				#								code for  ^ failed pruning
-
 		fi
 	fi
 }
 
-REPO_FILE=".kumonoboru"
+#If cleaning was forced, or if it's the first of this month - clean.
-if [[ ! -f $REPO_FILE ]]; then
+if [[ -n $CLEAN ]] || [[ $(date +%d) == "1" ]]; then
-	echo "Repository file $REPO_FILE is undefined. Please define $REPO_FILE."
+	check REPO-1
-	echo "Format:"
+	clean REPO-1
-	echo "[B2-REPOSITORY] [LOCAL_PATH]"
+	check REPO-2
-	echo "Example:"
+	clean REPO-2
-	echo "potato_tmp	/tmp/potato"
+	check REPO-3
-	exit 1
+	clean REPO-3
-fi
+
-if [[ -n $REPOSITORY ]]; then
+#If a specific repository was requested, back it up; otherwise, back them all up.
-	repo_name=$(cat .kumonoboru | grep $REPOSITORY | awk '{print $1}')
+elif [[ -n $REPOSITORY ]] && [[ -z $CLEAN ]]; then
-	repo_path=$(cat .kumonoboru | grep $REPOSITORY | awk '{print $2}')
+	case "$REPOSITORY" in
-	if [[ -z $repo_name ]] || [[ -z $repo_path ]]; then
+		(REPO-1)
-		echo "Could not find repository $REPOSITORY"
+			backup REPO-1 /stuff/stuff1/
-	else
+			;;
-		REPOS["$repo_name"]=$repo_path
+		(REPO-2)
-	fi
+			backup REPO-2 /stuff/stuff2/
-else
+			;;
-	declare -A REPOS
+		(REPO-3)
-	while read -r repo_entry; do
+			backup REPO-3 /stuff/stuff3/
-		repo_name=$(echo "$repo_entry" | awk '{print $1}')
+			;;
-		repo_path=$(echo "$repo_entry" | awk '{print $2}')
+		(*)
-		REPOS["$repo_name"]=$repo_path
+			show_help;;
-	done < .kumonoboru
+	esac	
+
+#If cleaning was not forced, backup the repositories	
+elif [[ -z $CLEAN ]]; then
+	backup REPO-1 /stuff/stuff1/
+	backup REPO-2 /stuff/stuff2/
+	backup REPO-3 /stuff/stuff3/
+
+#If a specific repository was requested to be cleaned, clean it
+elif [[ -n $REPOSITORY ]] && [[ -n $CLEAN ]]; then
+	case "$REPOSITORY" in
+		(REPO-1)
+			check REPO-1
+			clean REPO-1
+			;;
+		(REPO-2)
+			check REPO-2
+			clean REPO-2
+			;;
+		(REPO-3)
+			check REPO-3
+			clean REPO-3
+			;;
+		(*)
+			show_help;;
+	esac	
 fi
 
-for repo in "${!REPOS[@]}"; do
+#Wrap up this run's log and report nicely
-	repo_path=${REPOS[$repo]}
-
-	#If cleaning was forced, or if it's the first of this month - clean.
-	if [[ -n $CLEAN ]] || [[ $(date +%d) == "1" ]]; then
-		check $repo
-		clean $repo
-
-	#If a specific repository was requested, back it up; otherwise, back them all up.
-	elif [[ -z $CLEAN ]]; then
-			backup $repo $repo_path	
-	fi
-done
-
 echo "All done; have a nice day!"
-
-## Once the script finishes, the .prom file will live on for 2 minutes before being deleted.
-#+ This allows Prometheus to pick up the alert, send out a notification, and move on with its life.
-(
-	sleep 120
- 	rm $PROM_FILE
-) 2>1 >/dev/null &

kumonoboru.yaml

@@ -6,7 +6,7 @@
     ansible_sudo_pass: "{{ ANSIBLE_SUDO_PASS }}"
 
   tasks:
-    - name: Install dependencies
+    - name: Install Restic
       ansible.builtin.package:
         name: restic
         state: latest