implement archive and rsync of configs

if configured the script will tar up the configs and, if needed, rsync them separately.

Issue #28

Author: sund

README.md

@@ -68,6 +68,20 @@ sshKeyPath=""
 ## $remoteServer path for gitlab backups
 remoteDest="/var/opt/gitlab/backups"
 
+## set $localConfDir
+# blank disables conf backups
+# you can create /var/opt/gitlab/backups/configBackups --
+# gitlab doesn't seem to complain with a subfolder
+# in there. Plus it will rsync up with the backup.
+# So you won't need to enable a separate rsync run
+localConfDir="/var/opt/gitlab/backups/configBackups"
+
+## set $remoteServer path for gitlab configs
+# blank disables remote copy
+# unless $localConfDir is outside /var/opt/gitlab/backups/configBackups
+# you can leave this blank
+remoteConfDest=""
+
 ## Using the CI server?
 #  change to true or 1 to enable CI backups
 enableCIBackup="0"
@@ -90,6 +104,10 @@ RVM_envPath=""
 remoteModule=""
 rsync_password_file=""
 
+## only change if configs are in different locations. (unlikely)
+localConfig="/etc/gitlab"
+localsshkeys="/var/opt/gitlab/.ssh"
+
 ## Check remote quota
 #  change to true or 1 to enable
 checkQuota="0"

auto-gitlab-backup.conf.sample

@@ -12,6 +12,20 @@ sshKeyPath=""
 ## $remoteServer path for gitlab backups
 remoteDest="/var/opt/gitlab/backups"
 
+## set $localConfDir
+# blank disables conf backups
+# you can create /var/opt/gitlab/backups/configBackups --
+# gitlab doesn't seem to complain with a subfolder
+# in there. Plus it will rsync up with the backup.
+# So you won't need to enable a separate rsync run
+localConfDir="/var/opt/gitlab/backups/configBackups"
+
+## set $remoteServer path for gitlab configs
+# blank disables remote copy
+# unless $localConfDir is outside /var/opt/gitlab/backups/configBackups
+# you can leave this blank
+remoteConfDest=""
+
 ## Using the CI server?
 #  change to true or 1 to enable CI backups
 enableCIBackup="0"
@@ -34,6 +48,16 @@ RVM_envPath=""
 remoteModule=""
 rsync_password_file=""
 
+## localbackup directories
+# only change if gitlab_rails['backup_path'] in gitlab.rb is set
+# other than $gitHome/[backups|ci-backups]
+gitRakeBackups="/var/opt/gitlab/backups"
+gitRakeCIBackups="/var/opt/gitlab/ci-backups"
+
+## only change if configs are in different locations. (unlikely)
+localConfig="/etc/gitlab"
+localsshkeys="/var/opt/gitlab/.ssh"
+
 ## Check remote quota
 #  change to true or 1 to enable
 checkQuota="0"

auto-gitlab-backup.sh

@@ -38,9 +38,8 @@ export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$PATH"
 gitHome="$(awk -F: -v v="git" '{if ($1==v) print $6}' /etc/passwd)"
 gitlabHome="$gitHome/gitlab"
 gitlab_rails="/opt/gitlab/embedded/service/gitlab-rails"
-gitRakeBackups="/var/opt/gitlab/backups"
-gitRakeCIBackups="/var/opt/gitlab/ci-backups"
 PDIR=$(dirname $(readlink -f $0))
+dateStamp=`date +"%F %H:%m:%S"`
 confFile="$PDIR/auto-gitlab-backup.conf"
 rakeBackup="gitlab-rake gitlab:backup:create"
 rakeCIBackup="gitlab-ci-rake backup:create"
@@ -74,6 +73,20 @@ checkSize() {
     echo
 }
 
+archiveConfig() {
+  echo ===== Archiving Configs =====
+  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 {} \; 
+
+  else
+    echo "Local configs aren't enabled or $localConfDir is not writable."
+  fi
+}
+
 rakeBackup() {
     echo ===== raking a backup =====
     cd $gitRakeBackups
@@ -103,6 +116,15 @@ rsyncUp() {
       echo -e "Start rsync to \n$remoteServer:$ciRemoteDest\ndefault key\n"
       rsync -Cavz --delete-after -e "ssh -p$remotePort" $gitRakeCIBackups/ $remoteUser@$remoteServer:$ciRemoteDest
     fi
+
+    # config rsync
+    if [ ! -z $remoteConfDest ]
+    then
+      echo ===== rsync a config backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteServer:$remoteConfDest\ndefault key\n"
+      rsync -Cavz --delete-after -e "ssh -p$remotePort" $localConfDir/ $remoteUser@$remoteServer:$remoteConfDest
+    fi
 }
 
 rsyncUp_dryrun() {
@@ -119,6 +141,15 @@ rsyncUp_dryrun() {
       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
+
+    # config rsync
+    if [ ! -z $remoteConfDest ]
+    then
+      echo ===== rsync a config backup =====
+      echo =============================================================
+      echo -e "Start dry run rsync to \n$remoteServer:$remoteConfDest\ndefault key\n"
+      rsync --dry-run -Cavz --delete-after -e "ssh -p$remotePort" $localConfDir/ $remoteUser@$remoteServer:$remoteConfDest
+    fi
 }
 
 rsyncKey() {
@@ -134,6 +165,15 @@ rsyncKey() {
       echo -e "Start rsync to \n$remoteServer:$ciRemoteDest\nwith specific key\n"
       rsync -Cavz --delete-after -e "ssh -i $sshKeyPath -p$remotePort" $gitRakeCIBackups/ $remoteUser@$remoteServer:$ciRemoteDest
     fi
+
+    # config rsync
+    if [ ! -z $remoteConfDest ]
+    then
+      echo ===== rsync a config backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteServer:$remoteConfDest\ndefault key\n"
+      rsync -Cavz --delete-after -e "ssh -p$remotePort" $localConfDir/ $remoteUser@$remoteServer:$remoteConfDest
+    fi
 }
 
 rsyncKey_dryrun() {
@@ -149,6 +189,15 @@ rsyncKey_dryrun() {
       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
+
+    # config rsync
+    if [ ! -z $remoteConfDest ]
+    then
+      echo ===== rsync a config backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteServer:$remoteConfDest\ndefault key\n"
+      rsync --dry-run -Cavz --delete-after -e "ssh -p$remotePort" $localConfDir/ $remoteUser@$remoteServer:$remoteConfDest
+    fi
 }
 
 
@@ -167,6 +216,14 @@ rsyncDaemon() {
       rsync -Cavz --port=$remotePort --password-file=$rsync_password_file --delete-after /$gitRakeCIBackups/ $remoteUser@$remoteServer::$remoteCIModule
     fi
 
+    # config rsync
+    if [ ! -z $remoteConfDest ]
+    then
+      echo ===== rsync a config backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteServer:$remoteConfDest\ndefault key\n"
+      rsync -Cavz --delete-after -e "ssh -p$remotePort" $localConfDir/ $remoteUser@$remoteServer:$remoteConfDest
+    fi
 }
 
 rsyncDaemon_dryrun() {
@@ -184,6 +241,14 @@ rsyncDaemon_dryrun() {
       rsync --dry-run -Cavz --port=$remotePort --password-file=$rsync_password_file --delete-after /$gitRakeCIBackups/ $remoteUser@$remoteServer::$remoteCIModule
     fi
 
+    # config rsync
+    if [ ! -z $remoteConfDest ]
+    then
+      echo ===== rsync a config backup =====
+      echo =============================================================
+      echo -e "Start rsync to \n$remoteServer:$remoteConfDest\ndefault key\n"
+      rsync --dry-run -Cavz --delete-after -e "ssh -p$remotePort" $localConfDir/ $remoteUser@$remoteServer:$remoteConfDest
+    fi
 }