Merge pull request #22 from sund/develop

dryrun

Author: sund

README.md

@@ -1,14 +1,14 @@
-## AutoGITBackup
+## auto gitlab Backup
 
 http://sund.la/glup
 
 ----
 
-A collection of scripts to use omnibus-gitlab's own backup ```gitlab-rake``` command on a cron schedule and rsync to another server, if wanted, or to restore a backup.
+A script to use omnibus-gitlab's own backup ```gitlab-rake``` command on a cron schedule and rsync to another server, if wanted. There is also a restore script available (see below.)
 
-Also will backup and copy the Gitlab-CI DB if configured.
+It can backup and copy the Gitlab-CI DB, if configured.
 
-This script is now more omnibus-gitlab centric. Compare your config fiile with the template! Usage with a source install is possible but not expressly shown here.
+This script is now more omnibus-gitlab centric. Compare your config file with the template! Usage with a source install is possible but not expressly shown here.
 
 #### Clone
 
@@ -23,7 +23,7 @@ Change ```/etc/gitlab/gitlab.rb``` to expire backups
 gitlab_rails['backup_keep_time'] = 604800
 ```
 
-If you use the CI server, enable Ci Backup expiration
+If you use the CI server, enable CI Backup expiration
 
 ```
 ## Backup settings
@@ -42,21 +42,45 @@ cp auto-gitlab-backup.conf.sample auto-gitlab-backup.conf
 edit ```auto-gitlab-backup.conf```
 
 ```bash
-remoteUser="" #user account on remote server
-remoteServer="" #remote host
-remoteDest="" #remote path
-sshKeyPath="" #path to an alternate ssh key, if needed.
-remotePort=22 # ssh port
-## Only change the below setting if you have git's home in a different location or are installing gitlab from source
+## user account on remote server
+#  likely 'git' user
+remoteUser=""
+
+## remote host
+#  a backup gitlab server?
+remoteServer=""
+
+## path to an alternate ssh key, if needed.
+sshKeyPath=""
+
+## $remoteServer path for gitlab backups
+remoteDest=""
+
+## Using the CI server?
+#  change to true or 1 to enable CI backups
+enableCIBackup="0"
+
+## $remoteServer dest for CI backups on remote
+ciRemoteDest="/var/opt/gitlab/ci-backups"
+
+## ssh port or 873 for rsyncd port
+remotePort=22
+
+## git user home.
+#  Only change the below setting if you have git's home in a different location
 gitHome="/var/opt/gitlab"
+
 ## only set below if rvm is in use and you need to source the rvm env file
 # echo $(rvm env --path)
 RVM_envPath=""
+
 ## only use the below settings if your destination is using rsync in daemon mode
 remoteModule=""
 rsync_password_file=""
-checkQuota="0" #change to true or 1 to enable
-enableCIBackup="0" #change to true or 1 to enable CI backups
+
+## Check remote quota
+#  change to true or 1 to enable
+checkQuota="0"
 ```
 
 #### cron settings

auto-gitlab-backup.conf.sample

@@ -1,16 +1,39 @@
-remoteUser="" #user account on remote server
-remoteServer="" #remote host
-remoteDest="" #remote path for gitlab backups
-ciRemoteDest="/var/opt/gitlab/ci-backups" # diff dest for CI backups on remote
-sshKeyPath="" #path to an alternate ssh key, if needed.
-remotePort=22 # ssh port or 873 for rsyncd port
-## Only change the below setting if you have git's home in a different location
+## user account on remote server
+#  likely 'git' user
+remoteUser=""
+
+## remote host
+#  a backup gitlab server?
+remoteServer=""
+
+## path to an alternate ssh key, if needed.
+sshKeyPath=""
+
+## $remoteServer path for gitlab backups
+remoteDest="/var/opt/gitlab/backups"
+
+## Using the CI server?
+#  change to true or 1 to enable CI backups
+enableCIBackup="0"
+
+## $remoteServer dest for CI backups on remote
+ciRemoteDest="/var/opt/gitlab/ci-backups"
+
+## ssh port or 873 for rsyncd port
+remotePort=22
+
+## git user home.
+#  Only change the below setting if you have git's home in a different location
 gitHome="/var/opt/gitlab"
+
 ## only set below if rvm is in use and you need to source the rvm env file
 # echo $(rvm env --path)
 RVM_envPath=""
+
 ## only use the below settings if your destination is using rsync in daemon mode
 remoteModule=""
 rsync_password_file=""
-checkQuota="0" #change to true or 1 to enable
-enableCIBackup="0" #change to true or 1 to enable CI backups
+
+## Check remote quota
+#  change to true or 1 to enable
+checkQuota="0"

auto-gitlab-backup.sh

@@ -105,6 +105,22 @@ rsyncUp() {
     fi
 }
 
+rsyncUp_dryrun() {
+# rsync up with default key
+    echo =============================================================
+    echo -e "Start dry run rsync to \n$remoteServer:$remoteDest\ndefault key\n"
+    rsync --dry-run -Cavz --delete-after -e "ssh -p$remotePort" $gitRakeBackups/ $remoteUser@$remoteServer:$remoteDest
+
+    # rsync CI backup
+    if [[ $enableCIBackup == "true" || $enableCIBackup = 1 ]]
+    then
+      echo ===== rsync a CI backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteServer:$ciRemoteDest\ndefault key\n"
+      rsync --dry-run -Cavz --delete-after -e "ssh -p$remotePort" $gitRakeCIBackups/ $remoteUser@$remoteServer:$ciRemoteDest
+    fi
+}
+
 rsyncKey() {
 # rsync up with specific key
     echo =============================================================
@@ -120,6 +136,22 @@ rsyncKey() {
     fi
 }
 
+rsyncKey_dryrun() {
+# rsync up with specific key
+    echo =============================================================
+    echo -e "Start dry run rsync to \n$remoteServer:$remoteDest\nwith specific key\n"
+    rsync --dry-run -Cavz --delete-after -e "ssh -i $sshKeyPath -p$remotePort" $gitRakeBackups/ $remoteUser@$remoteServer:$remoteDest
+
+    # rsync CI backup
+    if [[ $enableCIBackup == "true" || $enableCIBackup = 1 ]]
+    then
+      echo ===== rsync a CI backup =====
+      echo -e "Start rsync to \n$remoteServer:$ciRemoteDest\nwith specific key\n"
+      rsync --dry-run -Cavz --delete-after -e "ssh -i $sshKeyPath -p$remotePort" $gitRakeCIBackups/ $remoteUser@$remoteServer:$ciRemoteDest
+    fi
+}
+
+
 rsyncDaemon() {
 # rsync up with specific key
     echo =============================================================
@@ -137,6 +169,24 @@ rsyncDaemon() {
 
 }
 
+rsyncDaemon_dryrun() {
+# rsync up with specific key
+    echo =============================================================
+    echo -e "Start rsync to \n$remoteUser@$remoteServer:$remoteModule\nin daemon mode\n"
+    rsync --dry-run -Cavz --port=$remotePort --password-file=$rsync_password_file --delete-after /$gitRakeBackups/ $remoteUser@$remoteServer::$remoteModule
+
+    # rsync CI backup
+    if [[ $enableCIBackup == "true" || $enableCIBackup = 1 ]]
+    then
+      echo ===== rsync a CI backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteUser@$remoteServer:$remoteCIModule\nin daemon mode\n"
+      rsync --dry-run -Cavz --port=$remotePort --password-file=$rsync_password_file --delete-after /$gitRakeCIBackups/ $remoteUser@$remoteServer::$remoteCIModule
+    fi
+
+}
+
+
 sshQuotaKey() {
 #quota check: with a key remoteServer, run the quota command
 	if [[ $checkQuota == "true" || $checkQuota = 1 ]]
@@ -167,53 +217,99 @@ printScriptver() {
 	echo "Version $(git describe --abbrev=0 --tags --always), commit #$(git log --pretty=format:'%h' -n 1)."
 }
 
-###
-## Git'r done
-#
-
-## test for running as root
-if [[ "$UID" -ne "$ROOT_UID" ]];
-then
-  echo "You must run this script as root to run."
-  exit 1
-fi
-
-# read the conffile
-if [ -e $confFile -a -r $confFile ]
-then
-	source $confFile
-	echo "Parsing config file..."
-        rvm_ENV
-else
-	echo "No confFile found; Remote copy DISABLED."
-fi
+usage() {
+	echo ""
+	echo "Usage:"
+	echo "$0 -h | --help this help page"
+	echo "$0 -d | --dry-run test rsync operations; no data transmitted."
+	echo "$0 no options, perform backup and rsync."
+	echo ""
+}
 
-rakeBackup
-rakeCIBackup
-checkSize
+areWeRoot() {
+  ## test for running as root
+  if [[ "$UID" -ne "$ROOT_UID" ]];
+  then
+  	echo "You must run this script as root to run."
+      if [[ $1 ==  -d ]] || [[ $1 == --dry-run ]]
+        then
+        echo "...even to dryrun as we need to acccess the backup dir."
+      fi
+    usage
+  	exit 1
+  fi
+}
 
-# go back to where we came from
-cd $PDIR
+confFileExist() {
+  # read the conffile
+  if [ -e $confFile -a -r $confFile ]
+  then
+  	source $confFile
+  	echo "Parsing config file..."
+          rvm_ENV
+  else
+  	echo "No confFile found; Remote copy DISABLED."
+  fi
+}
 
-# if the $remoteModule is set run rsyncDaemon
-## here we assume variables are set right and only check when needed.
-if [[ $remoteModule != "" ]]
-then
-	rsyncDaemon
+###
+## Git'r done
+#
 
-# no Daemon so lets see if we are using a special key
-else if [ -e $sshKeyPath -a -r $sshKeyPath ] && [[ $sshKeyPath != "" ]]
-	then
-		rsyncKey
-		sshQuotaKey
-		else if [[ $remoteServer != "" ]]
-		then
-			# use the defualt
-			rsyncUp
-			sshQuota
-		fi
-	fi
-fi
+case $1 in
+	-h|--help )
+		usage
+		;;
+	-d|--dry-run )
+    areWeRoot $1
+    confFileExist
+		##test ssh and rsync functions
+    if [[ $remoteModule != "" ]]
+      then
+      rsyncDaemon_dryrun
+      # no Daemon so lets see if we are using a special key
+    else if [ -e $sshKeyPath -a -r $sshKeyPath ] && [[ $sshKeyPath != "" ]]
+      then
+      rsyncKey_dryrun
+      sshQuotaKey
+    else if [[ $remoteServer != "" ]]
+      then
+      # use the defualt
+      rsyncUp_dryrun
+      sshQuota
+    fi
+    fi
+    fi
+		;;
+	* )
+    areWeRoot $1
+    confFileExist
+    # perform backup
+    rakeBackup
+    rakeCIBackup
+    checkSize
+    # go back to where we came from
+    cd $PDIR
+    # if the $remoteModule is set run rsyncDaemo
+    ## here we assume variables are set right and only check when needed.
+    if [[ $remoteModule != "" ]]
+      then
+      rsyncDaemon
+      # no Daemon so lets see if we are using a special key
+    else if [ -e $sshKeyPath -a -r $sshKeyPath ] && [[ $sshKeyPath != "" ]]
+      then
+      rsyncKey
+      sshQuotaKey
+    else if [[ $remoteServer != "" ]]
+      then
+      # use the defualt
+      syncUp
+      sshQuota
+    fi
+    fi
+    fi
+    ;;
+esac
 
 # Print version
 printScriptver