Merge pull request #44 from sund/develop

Merge v1.7 • Disturbing Lack of Faith
sund · Jul 1, 2016 · f4bc212 · f4bc212
2 parents 0a44b74 + 261b819
commit f4bc212
Show file tree

Hide file tree

Showing 4 changed files with 202 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -6,17 +6,19 @@
 
 ## Synopsis
 
-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.)
+A simple script to backup your Gitlab data. This script will copy the backup archives of your gitlab installation via rsync, or scp. Also, you can copy backups to [Backblaze’s B2 Cloud Storage service.](https://www.backblaze.com/b2/cloud-storage.html) There is also a restore script available (see below.)
 
-It can backup and copy the Gitlab-CI DB, if configured.
+It can backup and copy the ```gitlab.rb``` config file, if configured.
 
 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.
 
 ## Installation
 
 ### Prerequisites
 
-Deploy a working GitLab installation and verify you can back it up with the rake task as documented in the [GitLab Documents](http://doc.gitlab.com/ce/raketasks/backup_restore.html).
+Deploy a working GitLab Omnibus installation and verify you can back it up with the rake task as documented in the [GitLab Documents](http://doc.gitlab.com/ce/raketasks/backup_restore.html).
+
+For Backblaze usage, configure your system for the [Backblaze Command-Line Tool](https://www.backblaze.com/b2/docs/quick_command_line.html) Also, see the [wiki page on B2](https://github.com/sund/auto-gitlab-backup/wiki/Backblaze-B2-Command-Line-Tool).
 
 #### Set up gitlab to expire backups
 
@@ -62,6 +64,22 @@ sshKeyPath=""
 ## $remoteServer path for gitlab backups
 remoteDest="/var/opt/gitlab/backups"
 
+## backup gitlab configs
+# change to 1 to enable
+backupConfigs=“0”
+
+## rake quietly
+# change to 1 to enable quiet rake job
+quietRake=0
+
+## enable backblaze b2 sync
+# change to 1 to enable
+# and set bucket name
+# and change b2keepDays if other than 5 days is desired
+b2blaze=0
+b2Bucketname=“”
+b2keepDays=“5”
+
 ## set $localConfDir
 # blank disables conf backups
 # you can create /var/opt/gitlab/backups/configBackups --
@@ -114,3 +132,11 @@ Example for crontab to run at 5:05am everyday.
 *Still under development but useful*
 
 run ```./restoreGitLab.sh -r``` and it will attempt to restore a backup. You may have to run some rake commands manually.
+
+## Help
+
+See the [Wiki](https://github.com/sund/auto-gitlab-backup/wiki) for more detailed instructions or submit a [Issue](https://github.com/sund/auto-gitlab-backup/issues).
+
+## Contribute
+
+See [Contribution Guide](https://github.com/sund/auto-gitlab-backup/blob/master/CONTRIBUTING.md) to improve this script.
diff --git a/agb_logo.png b/agb_logo.png
diff --git a/auto-gitlab-backup.conf.sample b/auto-gitlab-backup.conf.sample
@@ -16,6 +16,18 @@ remoteDest="/var/opt/gitlab/backups"
 # change to 1 to enable
 backupConfigs="0"
 
+## rake quietly
+# change to 1 to enable quiet rake job
+quietRake=0
+
+## enable backblaze b2 sync
+# change to 1 to enable
+# and set bucketname
+# and change b2keepDays if other than 5 days is desired
+b2blaze=0
+b2Bucketname=""
+b2keepDays="5"
+
 ## set $localConfDir
 # blank disables conf backups
 # you can create /var/opt/gitlab/backups/configBackups --

diff --git a/auto-gitlab-backup.sh b/auto-gitlab-backup.sh
@@ -41,7 +41,12 @@ gitlab_rails="/opt/gitlab/embedded/service/gitlab-rails"
 PDIR=$(dirname $(readlink -f $0))
 dateStamp=`date +"%F %H:%m:%S"`
 confFile="$PDIR/auto-gitlab-backup.conf"
-rakeBackup="gitlab-rake gitlab:backup:create"
+if [[ $quietRake == 1 ]]
+then
+  rakeBackup="gitlab-rake gitlab:backup:create CRON=1"
+else
+  rakeBackup="gitlab-rake gitlab:backup:create"
+fi
 
 ###
 ## Functions
@@ -70,15 +75,20 @@ checkSize() {
 
 archiveConfig() {
   echo ===== Archiving Configs =====
-  if [[ -w $localConfDir && $backupConfigs = 1 ]]
+  if [[ $backupConfigs = 1 ]]
   then
-    tar -czf "$localConfDir/gitlabConf-$dateStamp.tgz" $localConfig $localsshkeys
+    if [[ -w $localConfDir ]]
+    then
+      tar -czf "$localConfDir/gitlabConf-$dateStamp.tgz" $localConfig $localsshkeys
 
-    # remove files not within 3 days
-    find $localConfDir -type f -mtime +3 -exec rm -v {} \;
+      # remove files not within 3 days
+      find $localConfDir -type f -mtime +3 -exec rm -v {} \;
 
+    else
+      echo "$localConfDir is not writable."
+    fi
   else
-    echo "Local config backup aren't enabled or $localConfDir is not writable."
+    echo "Local config backups aren't enabled!"
   fi
 }
 
@@ -152,7 +162,6 @@ rsyncKey_dryrun() {
     fi
 }
 
-
 rsyncDaemon() {
 # rsync up with specific key
     echo =============================================================
@@ -185,7 +194,6 @@ rsyncDaemon_dryrun() {
     fi
 }
 
-
 sshQuotaKey() {
 #quota check: with a key remoteServer, run the quota command
 	if [[ $checkQuota == "true" || $checkQuota = 1 ]]
@@ -221,7 +229,7 @@ usage() {
 	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 "$0 no options, perform backup, rsync or b2 operations."
 	echo ""
 }
 
@@ -239,6 +247,144 @@ areWeRoot() {
   fi
 }
 
+b2Sync() {
+  # b2 sync
+  echo =============================================================
+  echo -e "Start b2 sync of $gitRakeBackups to bucket $b2Bucketname \n"
+
+  if [[ $b2blaze == 0 ]]
+  then
+    echo "Backblaze b2 file operations not enabled!"
+  else
+
+    # test for b2 command
+    if type b2 > /dev/null 2>&1
+    then
+      # bucketname set and readable
+      if [ ! -z $b2Bucketname ]
+      then
+        if test -r "$gitRakeBackups" -a -d "$gitRakeBackups"
+        then
+          b2 sync --noProgress --keepDays $b2keepDays --replaceNewer $gitRakeBackups/ b2://$b2Bucketname/backups/
+        else
+          echo " gitRakeBackups ($gitRakeBackups) not readable."
+        fi
+      else
+        echo " b2Bucketname not set."
+      fi
+    else
+      echo " b2 command not found!"
+    fi
+
+  fi
+echo ""
+}
+
+b2SyncProgress() {
+  # b2 sync
+  echo =============================================================
+  echo -e "Start b2 sync of $gitRakeBackups to bucket $b2Bucketname \n"
+
+  if [[ $b2blaze == 0 ]]
+  then
+    echo "Backblaze b2 file operations not enabled!"
+  else
+
+    # test for b2 command
+    if type b2 > /dev/null 2>&1
+    then
+      # bucketname set and readable
+      if [ ! -z $b2Bucketname ]
+      then
+        if test -r "$gitRakeBackups" -a -d "$gitRakeBackups"
+        then
+          b2 sync --keepDays $b2keepDays --replaceNewer $gitRakeBackups/ b2://$b2Bucketname/backups/
+        else
+          echo " gitRakeBackups ($gitRakeBackups) not readable."
+        fi
+      else
+        echo " b2Bucketname not set."
+      fi
+    else
+      echo " b2 command not found!"
+    fi
+
+  fi
+echo ""
+}
+
+b2SyncConf() {
+  # b2 sync
+  echo =============================================================
+  echo -e "Start b2 sync of /etc/gitlab to bucket $b2Bucketname/configs/ \n"
+
+  if [[ $backupConfigs == 1 ]]
+  then
+    if [[ $b2blaze == 0 ]]
+    then
+      echo "Backblaze b2 file operations not enabled!"
+    else
+
+      # test for b2 command
+      if type b2 > /dev/null 2>&1
+      then
+        # bucketname set and readable
+        if [ ! -z $b2Bucketname ]
+        then
+          if test -r "$gitRakeBackups" -a -d "$gitRakeBackups"
+          then
+            b2 sync --noProgress --keepDays $b2keepDays --replaceNewer /etc/gitlab/ b2://$b2Bucketname/configs/
+          else
+            echo " gitRakeBackups ($gitRakeBackups) not readable."
+          fi
+        else
+          echo " b2Bucketname not set."
+        fi
+      else
+        echo " b2 command not found!"
+      fi
+
+    fi
+  fi
+echo ""
+}
+
+b2SyncConfProgress() {
+  # b2 sync
+  echo =============================================================
+  echo -e "Start b2 sync of /etc/gitlab to bucket $b2Bucketname/configs/ \n"
+
+  if [[ $backupConfigs == 1 ]]
+  then
+    if [[ $b2blaze == 0 ]]
+    then
+      echo "Backblaze b2 file operations not enabled!"
+    else
+
+      # test for b2 command
+      if type b2 > /dev/null 2>&1
+      then
+        # bucketname set and readable
+        if [ ! -z $b2Bucketname ]
+        then
+          if test -r "$gitRakeBackups" -a -d "$gitRakeBackups"
+          then
+            b2 sync --keepDays $b2keepDays --replaceNewer /etc/gitlab/ b2://$b2Bucketname/configs/
+          else
+            echo " gitRakeBackups ($gitRakeBackups) not readable."
+          fi
+        else
+          echo " b2Bucketname not set."
+        fi
+      else
+        echo " b2 command not found!"
+      fi
+
+    fi
+  fi
+echo ""
+}
+
 confFileExist() {
   # read the conffile
   if [ -e $confFile -a -r $confFile ]
@@ -267,15 +413,18 @@ case $1 in
     if [[ $remoteModule != "" ]]
       then
       rsyncDaemon_dryrun
+      b2SyncProgress
       # no Daemon so lets see if we are using a special key
     else if [ -e $sshKeyPath -a -r $sshKeyPath ] && [[ $sshKeyPath != "" ]]
       then
       rsyncKey_dryrun
+      b2SyncProgress
       sshQuotaKey
     else if [[ $remoteServer != "" ]]
       then
       # use the defualt
       rsyncUp_dryrun
+      b2SyncProgress
       sshQuota
     fi
     fi
@@ -295,15 +444,18 @@ case $1 in
     if [[ $remoteModule != "" ]]
       then
       rsyncDaemon
+      b2Sync
       # no Daemon so lets see if we are using a special key
     else if [ -e $sshKeyPath -a -r $sshKeyPath ] && [[ $sshKeyPath != "" ]]
       then
       rsyncKey
+      b2Sync
       sshQuotaKey
     else if [[ $remoteServer != "" ]]
       then
       # use the defualt
       rsyncUp
+      b2Sync
       sshQuota
     fi
     fi