Merge pull request #159 from github/snh-sync

Sync with public repository

Author: snh

.travis.yml

@@ -1,4 +1,5 @@
 ---
+language: minimal
 matrix:
   include:
     - os: osx

README.md

@@ -1,18 +1,19 @@
-# GitHub Enterprise Backup Utilities
+# GitHub Enterprise Server Backup Utilities
 
-This repository includes backup and recovery utilities for [GitHub Enterprise][1].
+This repository includes backup and recovery utilities for
+[GitHub Enterprise Server][1].
 
-**Note**: the [GitHub Enterprise version requirements](docs/requirements.md#github-enterprise-version-requirements) have
+**Note**: the [GitHub Enterprise Server version requirements][2] have
 changed starting with Backup Utilities v2.13.0, released on 27 March 2018.
 
 ### Features
 
 Backup Utilities implement a number of advanced capabilities for backup
 hosts, built on top of the backup and restore features already included in
-GitHub Enterprise.
+GitHub Enterprise Server.
 
- - Complete GitHub Enterprise backup and recovery system via two simple utilities:<br>
-   `ghe-backup` and `ghe-restore`.
+ - Complete GitHub Enterprise Server backup and recovery system via two simple
+   utilities:<br>`ghe-backup` and `ghe-restore`.
  - Online backups. The GitHub appliance need not be put in maintenance mode for
    the duration of the backup run.
  - Incremental backup of Git repository data. Only changes since the last
@@ -31,7 +32,7 @@ GitHub Enterprise.
 - **[Requirements](docs/requirements.md)**
   - **[Backup host requirements](docs/requirements.md#backup-host-requirements)**
   - **[Storage requirements](docs/requirements.md#storage-requirements)**
-  - **[GitHub Enterprise version requirements](docs/requirements.md#github-enterprise-version-requirements)**
+  - **[GitHub Enterprise Server version requirements](docs/requirements.md#github-enterprise-version-requirements)**
 - **[Getting started](docs/getting-started.md)**
 - **[Using the backup and restore commands](docs/usage.md)**
 - **[Scheduling backups](docs/scheduling-backups.md)**
@@ -43,8 +44,10 @@ GitHub Enterprise.
 
 If you find a bug or would like to request a feature in Backup Utilities, please
 open an issue or pull request on this repository. If you have a question related
-to your specific GitHub Enterprise setup or would like assistance with backup
-site setup or recovery, please contact our [Enterprise support team][2] instead.
+to your specific GitHub Enterprise Server setup or would like assistance with
+backup site setup or recovery, please contact our [Enterprise support team][3]
+instead.
 
 [1]: https://enterprise.github.com
-[2]: https://enterprise.github.com/support/
+[2]: docs/requirements.md#github-enterprise-version-requirements
+[3]: https://enterprise.github.com/support/

RELEASING.md

@@ -1,31 +1,35 @@
 # Making a Backup Utilities release
 
-Starting with Backup Utilities v2.13.0, all major releases will follow GitHub Enterprise releases and the version support is inline with that of the [GitHub Enterprise upgrade requirements](https://help.github.com/enterprise/admin/guides/installation/about-upgrade-requirements/) and as such, support is limited to three versions of GitHub Enterprise: the version that corresponds with the version of Backup Utilities, and the two releases prior to it.
+Starting with Backup Utilities v2.13.0, all major releases will follow GitHub Enterprise Server releases and the version support is inline with that of the [GitHub Enterprise Server upgrade requirements](https://help.github.com/enterprise/admin/guides/installation/about-upgrade-requirements/) and as such, support is limited to three versions of GitHub Enterprise Server: the version that corresponds with the version of Backup Utilities, and the two releases prior to it.
 
 For example, Backup Utilities 2.13.0 can be used to backup and restore all patch releases from 2.11.0 to the latest patch release of GitHub Enterprise 2.13. Backup utilities 2.14.0 will be released when GitHub Enterprise 2.14.0 is released and will then be used to backup all releases of GitHub Enterprise from 2.12.0 to the latest patch release of GitHub Enterprise 2.14.
 
-There is no need to align Backup Utilities patch releases with GitHub Enterprise patch releases.
+There is no need to align Backup Utilities patch releases with GitHub Enterprise Server patch releases.
 
-When making a `.0` release, you will need to specify the minimum supported version of GitHub Enterprise that that release supports.
+When making a `.0` release, you will need to specify the minimum supported version of GitHub Enterprise Server that that release supports.
 
-## Automatic Process from chatops (internal to GitHub only) - Coming :soon:
+## Pre-release Actions
 
-### Feature release:
+Prior to making a release,
 
-`.ghe backup-utils-release 2.13.0 2.11.0`
+1. Go through the list of open pull requests and merge any that are ready for merging.
+2. Go through the list of closed pull requests since the last release and ensure those that should be included in the release notes:
+  - have a "bug", "enhancement" or "feature" label,
+  - have a title that clearly describes the changes in that pull request. Reword if necessary.
+3. Perform a dry run (add `--dry-run` to one of the commands below) and verify the version strings are going to be changed and verify the release notes.
 
-### Patch release:
+## Automatic Process from chatops (internal to GitHub only)
 
-`.ghe backup-utils-release 2.13.1`
+Coming :soon:
 
 ## Automatic Process from CLI
 
 1. Install the Debian `devscripts` package:
   `sudo apt-get install devscripts`
 2. Run...
-  - Feature release:  
+  - Feature release:
   `GH_AUTHOR="Bob Smith <[email protected]>" GH_RELEASE_TOKEN=your-amazing-secure-token script/release 2.13.0 2.11.0`
-  - Patch release:  
+  - Patch release:
   `GH_AUTHOR="Bob Smith <[email protected]>" GH_RELEASE_TOKEN=your-amazing-secure-token script/release 2.13.1`
 
 ## Manual Process
@@ -45,3 +49,13 @@ In the event you can't perform the automatic process, or a problem is encountere
 8. Draft a new release at https://github.com/github/backup-utils/releases, including the release notes and attaching the tarball and deb packages.
   The dist tarball you should upload has the revision in the file name, i.e. something like `github-backup-utils-v2.13.0.tar.gz`
 9. Push the head of the release to the 'stable' branch.
+
+## Post-release Actions
+
+Immediately after making a release using one of the methods above, verify the release has succeeded by checking:
+
+- latest release at https://github.com/github/backup-utils/releases is correct,
+- release at https://github.com/github/backup-utils/releases is linked to the vX.Y.Z tag,
+- release has the notes you expect to see,
+- asset download links for the latest release at https://github.com/github/backup-utils/releases all download the correct version of Backup Utilities,
+- the stable branch is inline with master - https://github.com/github/backup-utils/compare/stable...master.

backup.config-example

@@ -1,6 +1,6 @@
-# GitHub Enterprise backup configuration file
+# GitHub Enterprise Server backup configuration file
 
-# The hostname of the GitHub Enterprise appliance to back up. The host
+# The hostname of the GitHub Enterprise Server appliance to back up. The host
 # must be reachable via SSH from the backup host.
 GHE_HOSTNAME="github.example.com"
 

bin/ghe-backup

@@ -81,6 +81,25 @@ if [ "$(ls -il dest1/testfile | awk '{ print $1 }')" != "$(ls -il dest2/testfile
 fi
 rm -rf src dest1 dest2
 
+# if we should use gitbackups to backup repositories
+should_use_gitbackups_for_repositories(){
+  ghe-ssh "$GHE_HOSTNAME" ghe-config --true "app.github.gitbackups"
+}
+
+# check that the appliance supports using gitbackups for repositories
+can_use_gitbackups_for_repositories(){
+  ghe-ssh "$GHE_HOSTNAME" test -e /data/github/current/bin/backup-repositories
+}
+
+# Exit early if the appliance is missing script to backup repositories using gitbackups
+if should_use_gitbackups_for_repositories; then
+  if ! can_use_gitbackups_for_repositories; then
+    echo "Error: Configuration setting 'app.github.gitbackups' is enabled but this version of GHES cannot use gitbackups to back up repositories via 'ghe-backup'."
+    echo "Disable configuration setting 'app.github.gitbackups' and re-run 'ghe-backup' to use rsync."
+    exit 1
+  fi
+fi
+
 # 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.
@@ -174,23 +193,36 @@ ghe-ssh "$GHE_HOSTNAME" -- 'ghe-export-ssh-host-keys' > ssh-host-keys.tar ||
 failures="$failures ssh-host-keys"
 bm_end "ghe-export-ssh-host-keys"
 
+# if we are going to take a binary backup
+is_binary_backup(){
+  ghe-ssh "$GHE_HOSTNAME" ghe-config --true "mysql.backup.binary"
+}
+
 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"
+if is_binary_backup; then
+  touch mysql-binary-backup-sentinel
+fi
 bm_end "ghe-export-mysql"
 
 echo "Backing up Redis database ..."
 ghe-backup-redis > redis.rdb || failures="$failures redis"
 
 echo "Backing up audit log ..."
-ghe-backup-es-audit-log || failures="$failures audit-log"
+ghe-backup-audit-log || failures="$failures audit-log"
 
 echo "Backing up hookshot logs ..."
 ghe-backup-es-hookshot || failures="$failures hookshot"
 
-echo "Backing up Git repositories ..."
-ghe-backup-repositories || failures="$failures repositories"
+if should_use_gitbackups_for_repositories && can_use_gitbackups_for_repositories; then
+  echo "Backing up Git repositories using gitbackups ..."
+  ghe-backup-repositories-gitbackups || failures="$failures repositories"
+else
+  echo "Backing up Git repositories using rsync ..."
+  ghe-backup-repositories-rsync || failures="$failures repositories"
+fi
 
 echo "Backing up GitHub Pages ..."
 ghe-backup-pages || failures="$failures pages"

bin/ghe-host-check

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 #/ Usage: ghe-host-check [-h] [--version] [<host>]
 #/
-#/ Verify connectivity with the GitHub Enterprise host.
+#/ Verify connectivity with the GitHub Enterprise Server host.
 #/
 #/ OPTIONS:
 #/   -h | --help       Show this message.
 #/        --version    Display version information.
-#/   <host>            The GitHub Enterprise host to check. When no <host> is
-#/                     provided, the $GHE_HOSTNAME configured in backup.config
-#/                     is assumed.
+#/   <host>            The GitHub Enterprise Server host to check. When no
+#/                     <host> is provided, the $GHE_HOSTNAME configured in
+#/                     backup.config is assumed.
 #/
 
 set -e
@@ -70,7 +70,7 @@ if [ $rc -ne 0 ]; then
       echo "* https://enterprise.github.com/help/articles/adding-an-ssh-key-for-shell-access" 1>&2
       ;;
     101)
-      echo "Error: couldn't read GitHub Enterprise fingerprint on '$host' or this isn't a GitHub appliance." 1>&2
+      echo "Error: couldn't read GitHub Enterprise Server fingerprint on '$host' or this isn't a GitHub appliance." 1>&2
       ;;
     1)
       if [ "${port:-22}" -eq 22 ] && echo "$output" | grep "use port 122" >/dev/null; then
@@ -84,20 +84,20 @@ if [ $rc -ne 0 ]; then
   exit $rc
 fi
 
-version=$(echo "$output" | sed -n 's/GitHub Enterprise version \(.*\)/\1/p')
+version=$(echo "$output" | grep "GitHub Enterprise" | awk '{print $NF}')
 
 if [ -z "$version" ]; then
   echo "Error: failed to parse version on '$host' or this isn't a GitHub appliance." 1>&2
   exit 2
 fi
 
-# Block restoring snapshots to older releases of GitHub Enterprise
+# Block restoring snapshots to older releases of GitHub Enterprise Server
 if [ -n "$GHE_RESTORE_SNAPSHOT_PATH" ]; then
   snapshot_version=$(cat $GHE_RESTORE_SNAPSHOT_PATH/version)
   # shellcheck disable=SC2046 # Word splitting is required to populate the variables
   read -r snapshot_version_major snapshot_version_minor _ <<<$(ghe_parse_version $snapshot_version)
   if [ "$(version $GHE_REMOTE_VERSION)" -lt "$(version $snapshot_version_major.$snapshot_version_minor.0)" ]; then
-    echo "Error: Snapshot can not be restored to an older release of GitHub Enterprise." >&2
+    echo "Error: Snapshot can not be restored to an older release of GitHub Enterprise Server." >&2
     exit 1
   fi
 fi
@@ -106,23 +106,23 @@ if [ -z "$GHE_ALLOW_REPLICA_BACKUP" ]; then
   if [ "$(ghe-ssh $host -- cat $GHE_REMOTE_ROOT_DIR/etc/github/repl-state 2>/dev/null || true)" = "replica" ]; then
     echo "Error: high availability replica detected." 1>&2
     echo "Backup Utilities should be used to backup from the primary node in" 1>&2
-    echo "high availability environments to ensure consistent and repliable backups." 1>&2
+    echo "high availability environments to ensure consistent and reliable backups." 1>&2
     exit 1
   fi
 fi
 
 # backup-utils 2.13 onwards limits support to the current and previous two releases
-# of GitHub Enterprise.
-supported_minimum_version="2.11.0"
+# of GitHub Enterprise Server.
+supported_minimum_version="2.17.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
+  echo "Error: unsupported release of GitHub Enterprise Server detected." 1>&2
+  echo "Backup Utilities v$BACKUP_UTILS_VERSION requires GitHub Enterprise Server v$supported_minimum_version or newer." 1>&2
+  echo "Please update your GitHub Enterprise Server appliance or use an older version of Backup Utilities." 1>&2
   exit 1
 fi
 

bin/ghe-restore

@@ -62,7 +62,12 @@ while true; do
       exit 1
       ;;
     *)
-      break
+      if [ -n "$1" ]; then
+        GHE_RESTORE_HOST_OPT="$1"
+        shift
+      else
+        break
+      fi
       ;;
   esac
 done
@@ -81,7 +86,7 @@ cleanup () {
 . "$( dirname "${BASH_SOURCE[0]}" )/../share/github-backup-utils/ghe-backup-config"
 
 # Grab the host arg
-GHE_HOSTNAME="${1:-$GHE_RESTORE_HOST}"
+GHE_HOSTNAME="${GHE_RESTORE_HOST_OPT:-$GHE_RESTORE_HOST}"
 
 # Hostname without any port suffix
 hostname=$(echo "$GHE_HOSTNAME" | cut -f 1 -d :)
@@ -137,21 +142,6 @@ if ghe-ssh "$GHE_HOSTNAME" -- \
   exit 1
 fi
 
-# Only allow restores of 2.9 and 2.10 snapshots that have run the audit log migration to 2.11 and above
-if ! $force; then
-  snapshot_instance_version=$(cat $GHE_RESTORE_SNAPSHOT_PATH/version)
-  snapshot_version_major=$(echo "${snapshot_instance_version#v}" | cut -f 1 -d .)
-  snapshot_version_minor=$(echo "$snapshot_instance_version"     | cut -f 2 -d .)
-  if ! test -f $GHE_RESTORE_SNAPSHOT_PATH/es-scan-complete && \
-     [ "$snapshot_version_major" -eq 2 ] && [ "$snapshot_version_minor" -lt 11 ] && \
-     [ "$GHE_VERSION_MAJOR" -eq 2 ] && [ "$GHE_VERSION_MINOR" -ge 11 ]; then
-        echo "Error: Snapshot must be from GitHub Enterprise v2.9 or v2.10 after running the" >&2
-        echo "       audit log migration, or from v2.11.0 or above." >&2
-        echo "Please see https://git.io/v5rCE for the audit log migration procedure." >&2
-        exit 1
-  fi
-fi
-
 # Prompt to verify the restore host given is correct. Restoring overwrites
 # important data on the destination appliance that cannot be recovered. This is
 # mostly to prevent accidents where the backup host is given to restore instead
@@ -311,8 +301,8 @@ fi
 # Restore exported audit and hookshot logs to 2.12.9 and newer single nodes and
 # all releases of cluster
 if $CLUSTER || [ "$(version $GHE_REMOTE_VERSION)" -ge "$(version 2.12.9)" ]; then
-  echo "Restoring Elasticsearch Audit logs ..."
-  ghe-restore-es-audit-log "$GHE_HOSTNAME" 1>&3
+  echo "Restoring Audit logs ..."
+  ghe-restore-audit-log "$GHE_HOSTNAME" 1>&3
 
   echo "Restoring hookshot logs ..."
   ghe-restore-es-hookshot "$GHE_HOSTNAME" 1>&3

debian/changelog

@@ -1,3 +1,63 @@
+github-backup-utils (2.19.1) UNRELEASED; urgency=medium
+
+  * Cater for more explicit gist paths used in routes file #524
+  * Suppress "*.rsync': No such file or directory" errors when no data to backup or restore #525
+
+ -- Colin Seymour <[email protected]>  Wed, 11 Dec 2019 09:33:01 +0000
+
+github-backup-utils (2.19.0) UNRELEASED; urgency=medium
+
+  * Remove temporary exclude file from the backup host not the target GHES appliance #516
+  * Update Debian package depends to include git #520
+
+ -- Colin Seymour <[email protected]>  Tue, 12 Nov 2019 18:57:12 +0000
+
+github-backup-utils (2.18.0) UNRELEASED; urgency=medium
+
+  * Replace "sed -E" in ghe-host-check with a more portable solution #509
+
+ -- Colin Seymour <[email protected]>  Tue, 20 Aug 2019 18:49:44 +0000
+
+github-backup-utils (2.17.1) UNRELEASED; urgency=medium
+
+  * Redirect ghe-export-audit-logs stderr output unless using verbose output #497
+
+ -- Colin Seymour <[email protected]>  Wed, 05 Jun 2019 08:43:25 +0000
+
+github-backup-utils (2.17.0) UNRELEASED; urgency=medium
+
+  * Restore target is ignored when specified on the command line #476
+  * Support incremental backups for MySQL-stored audit logs #485
+
+ -- Colin Seymour <[email protected]>  Thu, 23 May 2019 08:20:15 +0000
+
+github-backup-utils (2.16.1) UNRELEASED; urgency=medium
+
+  * Detect storage user on each cluster host being backed up or restored #472
+
+ -- Colin Seymour <[email protected]>  Tue, 26 Feb 2019 16:37:04 +0000
+
+github-backup-utils (2.16.0) UNRELEASED; urgency=medium
+
+
+ -- Colin Seymour <[email protected]>  Tue, 22 Jan 2019 20:25:34 +0000
+
+github-backup-utils (2.15.1) UNRELEASED; urgency=medium
+
+  * Restoring to an un-configured appliance fails due to a missing license file #449
+
+ -- Colin Seymour <[email protected]>  Tue, 13 Nov 2018 17:34:21 +0000
+
+github-backup-utils (2.15.0) UNRELEASED; urgency=medium
+
+
+ -- Colin Seymour <[email protected]>  Tue, 16 Oct 2018 16:40:03 +0000
+
+github-backup-utils (2.15.0) UNRELEASED; urgency=medium
+
+
+ -- Colin Seymour <[email protected]>  Tue, 16 Oct 2018 16:07:36 +0000
+
 github-backup-utils (2.14.3) UNRELEASED; urgency=medium
 
   * Improve multi-platform detection of simultaneous ghe-backup runs #435