Merge pull request #375 from github/lildude/unify-strategy

Unify the backup & restore process

Author: lildude

bin/ghe-backup

@@ -56,11 +56,6 @@ mkdir -p "$GHE_SNAPSHOT_DIR"
 cd "$GHE_SNAPSHOT_DIR"
 touch "incomplete"
 
-# This is toggled true once we've successfully re-enabled maintenance mode
-# on the remote appliance. This is used to avoid trying to re-enable in the exit
-# trap again on successful backup runs.
-GHE_MAINTENANCE_MODE_ENABLED=false
-
 # To prevent multiple backup runs happening at the same time, we create a
 # in-progress file with the timestamp and pid of the backup process,
 # giving us a form of locking.
@@ -80,10 +75,6 @@ cleanup () {
     fi
   fi
 
-  if $GHE_MAINTENANCE_MODE_ENABLED; then
-    ghe-maintenance-mode-disable "$GHE_HOSTNAME"
-  fi
-
   # Cleanup SSH multiplexing
   ghe-ssh --clean "$GHE_HOSTNAME"
 }
@@ -131,22 +122,14 @@ export GHE_BACKUP_STRATEGY=${GHE_BACKUP_STRATEGY:-$(ghe-backup-strategy)}
 # Record the strategy with the snapshot so we will know how to restore.
 echo "$GHE_BACKUP_STRATEGY" > strategy
 
-# If we're using the tarball backup strategy, put the appliance in maintenance
-# mode and wait for all writing processes to bleed out.
-if [ "$GHE_BACKUP_STRATEGY" = "tarball" ]; then
-    ghe-maintenance-mode-enable "$GHE_HOSTNAME"
-    GHE_MAINTENANCE_MODE_ENABLED=true
-fi
-
 # Create benchmark file
 bm_init > /dev/null
 
 ghe-backup-store-version  ||
 echo "Warning: storing backup-utils version remotely failed."
 
 echo "Backing up GitHub settings ..."
-ghe-backup-settings ||
-failures="$failures settings"
+ghe-backup-settings || failures="$failures settings"
 
 echo "Backing up SSH authorized keys ..."
 bm_start "ghe-export-authorized-keys"
@@ -163,98 +146,38 @@ bm_end "ghe-export-ssh-host-keys"
 echo "Backing up MySQL database ..."
 bm_start "ghe-export-mysql"
 echo 'set -o pipefail; ghe-export-mysql | gzip' |
-ghe-ssh "$GHE_HOSTNAME" -- /bin/bash > mysql.sql.gz ||
-failures="$failures mysql"
+ghe-ssh "$GHE_HOSTNAME" -- /bin/bash > mysql.sql.gz || failures="$failures mysql"
 bm_end "ghe-export-mysql"
 
 echo "Backing up Redis database ..."
-if [ "$GHE_BACKUP_STRATEGY" = "cluster" ]; then
-  ghe-backup-redis-cluster > redis.rdb ||
-    failures="$failures redis"
-else
-  ghe-backup-redis > redis.rdb ||
-    failures="$failures redis"
-fi
+ghe-backup-redis > redis.rdb || failures="$failures redis"
 
-if [ $GHE_VERSION_MAJOR -ge 2 ]; then
-  echo "Backing up audit log ..."
-  ghe-backup-es-audit-log ||
-  failures="$failures audit-log"
+echo "Backing up audit log ..."
+ghe-backup-es-audit-log || failures="$failures audit-log"
 
-  echo "Backing up hookshot logs ..."
-  ghe-backup-es-hookshot ||
-  failures="$failures hookshot"
-fi
+echo "Backing up hookshot logs ..."
+ghe-backup-es-hookshot || failures="$failures hookshot"
 
 echo "Backing up Git repositories ..."
-if [ "$GHE_BACKUP_STRATEGY" = "cluster" ]; then
-  if ghe-ssh "$GHE_HOSTNAME" test -f /data/github/current/bin/dgit-cluster-backup-routes ; then
-    echo "* Using calculated routes method..."
-    ghe-backup-repositories-cluster-ng || failures="$failures repositories"
-  else
-    echo "* Using legacy method. A faster backup method is available on enterprise 2.7 and up."
-    ghe-backup-repositories-cluster || failures="$failures repositories"
-  fi
-else
-  ghe-backup-repositories-${GHE_BACKUP_STRATEGY} ||
-  failures="$failures repositories"
-fi
+ghe-backup-repositories || failures="$failures repositories"
 
 echo "Backing up GitHub Pages ..."
-ghe-backup-pages-${GHE_BACKUP_STRATEGY} ||
-failures="$failures pages"
-
-if [ "$GHE_VERSION_MAJOR" -ge 2 ]; then
-  if [ "$GHE_BACKUP_STRATEGY" = "cluster" ]; then
-    echo "Backing up storage data ..."
-    if ghe-ssh "$GHE_HOSTNAME" test -f /data/github/current/bin/storage-cluster-backup-routes; then
-      ghe-backup-alambic-cluster-ng || failures="$failures alambic"
-    else
-      ghe-backup-alambic-cluster || failures="$failures alambic"
-    fi
+ghe-backup-pages || failures="$failures pages"
 
-    echo "Backing up custom Git hooks ..."
-    ghe-backup-git-hooks-cluster ||
-    failures="$failures git-hooks"
-  else
-    echo "Backing up asset attachments ..."
-    ghe-backup-userdata alambic_assets ||
-    failures="$failures alambic_assets"
-
-    echo "Backing up storage data ..."
-    ghe-backup-userdata storage ||
-    failures="$failures storage"
-
-    echo "Backing up hook deliveries ..."
-    ghe-backup-userdata hookshot ||
-    failures="$failures hookshot"
-
-    echo "Backing up custom Git hooks ..."
-    ghe-backup-userdata git-hooks/environments/tarballs ||
-    failures="$failures git-hooks-environments"
-    ghe-backup-userdata git-hooks/repos ||
-    failures="$failures git-hooks-repos"
-  fi
-fi
+echo "Backing up storage data ..."
+ghe-backup-storage || failures="$failures storage"
 
-if [ "$GHE_BACKUP_STRATEGY" != "cluster" ]; then
-  echo "Backing up Elasticsearch indices ..."
-  ghe-backup-es-${GHE_BACKUP_STRATEGY} ||
-  failures="$failures elasticsearch"
-fi
+echo "Backing up custom Git hooks ..."
+ghe-backup-git-hooks || failures="$failures git-hooks"
 
-# If we're using the tarball backup strategy, bring the appliance out of
-# maintenance mode now instead of waiting until after pruning stale snapshots.
-if $GHE_MAINTENANCE_MODE_ENABLED; then
-    ghe-maintenance-mode-disable "$GHE_HOSTNAME" ||
-        echo "Warning: Disabling maintenance mode on $GHE_HOSTNAME failed."
-    GHE_MAINTENANCE_MODE_ENABLED=false
+if [ "$GHE_BACKUP_STRATEGY" = "rsync" ]; then
+  echo "Backing up Elasticsearch indices ..."
+  ghe-backup-es-rsync || failures="$failures elasticsearch"
 fi
 
 # git fsck repositories after the backup
 if [ "$GHE_BACKUP_FSCK" = "yes" ]; then
-  ghe-backup-fsck $GHE_SNAPSHOT_DIR ||
-    failures="$failures fsck"
+  ghe-backup-fsck $GHE_SNAPSHOT_DIR || failures="$failures fsck"
 fi
 
 # If everything was successful, mark the snapshot as complete, update the

bin/ghe-host-check

@@ -54,12 +54,6 @@ hostname=$(ssh_host_part "$host")
 set +e
 output=$(echo "ghe-negotiate-version backup-utils $BACKUP_UTILS_VERSION" | ghe-ssh -o BatchMode=no $options $host -- /bin/sh 2>&1)
 rc=$?
-if [ $rc = 127 ]; then
-  # ghe-negotiate-version not found, fallback to reading version file
-  legacy_version_output="1"
-  output=$(echo "cat \"$GHE_REMOTE_METADATA_FILE\" 2>/dev/null || exit 101" | ghe-ssh -o BatchMode=no $options $host -- /bin/sh 2>&1)
-  rc=$?
-fi
 set -e
 
 if [ $rc -ne 0 ]; then
@@ -89,15 +83,26 @@ if [ $rc -ne 0 ]; then
     exit $rc
 fi
 
-if [ -z "$legacy_version_output" ]; then
-  version=$(echo "$output" | sed -n 's/GitHub Enterprise version \(.*\)/\1/p')
-else
-  version=$(echo "$output" | grep version | cut -d'"' -f4)
-fi
+version=$(echo "$output" | sed -n 's/GitHub Enterprise version \(.*\)/\1/p')
 
 if [ -z "$version" ]; then
     echo "Error: failed to parse version on '$host' or this isn't a GitHub appliance." 1>&2
     exit 2
 fi
 
+# backup-utils 2.13 onwards limits support to the current and previous two releases
+# of GitHub Enterprise.
+supported_minimum_version="2.11.0"
+
+if [ "$(version $version)" -ge "$(version $supported_minimum_version)" ]; then
+  supported=1
+fi
+
+if [ -z "$supported" ]; then
+  echo "Error: unsupported release of GitHub Enterprise detected." 1>&2
+  echo "Backup Utilities v$BACKUP_UTILS_VERSION requires GitHub Enterprise v$supported_minimum_version or newer." 1>&2
+  echo "Please update your GitHub Enterprise appliance or use an older version of Backup Utilities." 1>&2
+  exit 1
+fi
+
 echo "Connect $hostname:$port OK (v$version)"