Merge branch 'master' into samirat/add_backup_cadence_to_appliance

Author: Samirat

backup.config-example

@@ -60,7 +60,7 @@ GHE_NUM_SNAPSHOTS=10
 #   - Differential backup every day (1440 minutes)
 #   - Transactionlog backup every 15 minutes
 #
-GHE_MSSQL_BACKUP_CADENCE=10080,1440,15
+#GHE_MSSQL_BACKUP_CADENCE=10080,1440,15
 
 # If set to 'yes', ghe-backup jobs will run in parallel. Defaults to 'no'.
 #

docs/usage.md

@@ -90,4 +90,15 @@ are *not* restored to prevent overwriting manual configuration on the restore
 host. This behavior can be overridden by passing the `-c` argument to `ghe-restore`,
 forcing settings, certificate, and license data to be overwritten with the backup copy's data.
 
+## Backup and restore with GitHub Actions enabled
+
+GitHub Actions data on your external storage provider is not included in regular GitHub Enterprise Server
+backups, and must be backed up separately.  When restoring a GitHub Enterprise Server backup with 
+GitHub Actions enabled, the following steps are required:
+
+1. Enable GitHub Actions on the replacement appliance and configure it to use the same GitHub Actions
+   external storage configuration as the original appliance.
+2. Use `ghe-restore` to restore the backup.
+3. Re-register your self-hosted runners on the replacement appliance.
+
 [1]: https://github.com/github/backup-utils/blob/master/docs/getting-started.md

share/github-backup-utils/ghe-backup-actions

@@ -42,7 +42,7 @@ ghe_verbose "* Transferring Actions files from $host ..."
 ghe-rsync -avz \
   -e "ghe-ssh -p $port" \
   --rsync-path='sudo -u actions rsync' \
-  --exclude "mutexes" --exclude "dumps" \
+  --exclude "mutexes" --exclude "dumps" --exclude "tmp" \
   $link_dest \
   "$host:$GHE_REMOTE_DATA_USER_DIR/actions/" \
   "$GHE_SNAPSHOT_DIR/actions" 1>&3

share/github-backup-utils/ghe-backup-config

@@ -243,6 +243,12 @@ export GHE_SNAPSHOT_DIR
 # Base path for temporary directories and files.
 : ${TMPDIR:="/tmp"}
 
+# Backup cadence for MS SQL. Determines the kind of backup taken, either full, differential,
+# or transaction log, based on when the last backup of that kind was taken. This defaults to
+# taking a full backup once a week, a differential backup once a day, and transaction logs every
+# 15 minutes.
+: ${GHE_MSSQL_BACKUP_CADENCE:=10080,1440,15}
+
 ###############################################################################
 ### Dynamic remote version config
 

share/github-backup-utils/ghe-backup-mssql

@@ -81,9 +81,9 @@ ensure_same_dbs() {
 
   if [[ "${#locals[@]}" -ne 0 ]]; then
     ghe_verbose "Warning: Found following ${#locals[@]} backup files that can't be traced back to the specified GHES host."
-    ghe_verbose "Warning: Did you recently reconfigure the GHES host? Consider deleting these backup files if no longer needed."
+    ghe_verbose "Warning: Did you recently reconfigure the GHES host? Move or delete these backup files if no longer needed."
     for local in "${locals[@]}"; do
-      ghe_verbose "$local"
+      ghe_verbose "$1/$local"
     done
 
     exit 1

test/test-ghe-backup.sh

@@ -352,6 +352,16 @@ begin_test "ghe-backup missing directories or files on source appliance"
 )
 end_test
 
+begin_test "ghe-backup has default cadence configured"
+(
+  set -e
+  enable_actions
+  
+  [ -n "$GHE_MSSQL_BACKUP_CADENCE" ]
+)
+end_test
+
+# Override backup cadence for testing purposes
 GHE_MSSQL_BACKUP_CADENCE=10,5,1
 export GHE_MSSQL_BACKUP_CADENCE
 setup_actions_test_data $GHE_REMOTE_DATA_USER_DIR