Merge pull request #467 from github/add-skip-checks-flg

add option for skipping checks

Author: chuckp22

backup.config-example

@@ -20,6 +20,10 @@ GHE_NUM_SNAPSHOTS=10
 # ghe-pruning-snapshots will need to be invoked separately via cron
 #GHE_PRUNING_SCHEDULED=yes
 
+# If GHE_SKIP_CHECKS is set to true (or if --skip-checks is used with ghe-backup) then ghe-host-check
+# disk space validation and software version checks on the backup-host will be disabled.
+#GHE_SKIP_CHECKS=false
+
 # The hostname of the GitHub appliance to restore. If you've set up a separate
 # GitHub appliance to act as a standby for recovery, specify its IP or hostname
 # here. The host to restore to may also be specified directly when running

bin/ghe-backup

@@ -5,9 +5,11 @@
 #/ the MySQL database, instance settings, GitHub Pages data, etc.
 #/
 #/ OPTIONS:
-#/   -v | --verbose    Enable verbose output.
-#/   -h | --help       Show this message.
-#/        --version    Display version information.
+#/   -v | --verbose       Enable verbose output.
+#/   -h | --help          Show this message.
+#/        --version       Display version information.
+#/   -i | --incremental   Incremental backup
+#/        --skip-checks   Skip storage/sw version checks
 #/
 
 set -e
@@ -31,6 +33,10 @@ while true; do
       export GHE_INCREMENTAL=true
       shift
       ;;
+    --skip-checks)
+      export GHE_SKIP_CHECKS=true
+      shift
+      ;;
     -*)
       echo "Error: invalid argument: '$1'" 1>&2
       exit 1

bin/ghe-host-check

@@ -144,7 +144,13 @@ if [ -z "$supported" ]; then
   exit 1
 fi
 
-if [[ "$CALLING_SCRIPT" == "ghe-backup" ]]; then
+if [[ "$CALLING_SCRIPT" == "ghe-backup" && "$GHE_SKIP_CHECKS" != "true" ]]; then
+  cat << SKIP_MSG 1>&2
+**You can disable the following storage & version checks by running ghe-backup with option "--skip-checks"
+OR updating GHE_SKIP_CHECKS to 'true' in your backup.config file.
+
+SKIP_MSG
+
   # Bring in the requirements file
   min_rsync=""
   min_openssh=""
@@ -184,6 +190,7 @@ minio: $minio_disk_size MB
 mysql: $mysql_disk_size MB
 actions: $actions_disk_size MB
 mssql: $mssql_disk_size MB
+
 DATA_TRANSFER_SIZE
 
   if [[ $((available_space / (1024 * 1024))) -lt $min_disk_req ]]; then

docs/README.md

@@ -6,7 +6,7 @@
   - **[GitHub Enterprise Server version requirements](requirements.md#github-enterprise-version-requirements)**
 - **[Getting started](getting-started.md)**
 - **[Using the backup and restore commands](usage.md)**
-- **[Scheduling backups](scheduling-backups.md)**
+- **[Scheduling backups & snapshot pruning](scheduling-backups.md)**
 - **[Backup snapshot file structure](backup-snapshot-file-structure.md)**
 - **[How does Backup Utilities differ from a High Availability replica?](faq.md)**
 - **[Docker](docker.md)**

docs/usage.md

@@ -73,13 +73,18 @@ appliance at IP "5.5.5.5":
     Restore of 5.5.5.5:122 from snapshot 20180326T020444 finished.
     To complete the restore process, please visit https://5.5.5.5/setup/settings to review and save the appliance configuration.
 
-A different backup snapshot may be selected by passing the `-s` argument and the
-datestamp-named directory from the backup location.
+A different backup snapshot may be selected by passing the `-s` argument to `ghe-restore` and specifying the
+datestamp-named directory from the backup location as the value.
 
 The `ghe-backup` and `ghe-restore` commands also have a verbose output mode
 (`-v`) that lists files as they're being transferred. It's often useful to
 enable when output is logged to a file.
 
+Every time you execute `ghe-backup` we verify the storage and software setup of the host 
+you [installed][1] Backup Utilities on, to make sure our [requirements][2] for the host are 
+met. You can disable this check using the `--skip-checks` argument or by 
+adding `GHE_SKIP_CHECKS=true` to your configuration file.
+
 ### Restoring settings, TLS certificate, and license 
 
 When restoring to a new GitHub Enterprise Server instance, settings, certificate, and
@@ -107,3 +112,4 @@ GitHub Actions enabled, the following steps are required:
 Please refer to [GHES Documentation](https://docs.github.com/en/enterprise-server/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled) for more details.
 
 [1]: https://github.com/github/backup-utils/blob/master/docs/getting-started.md
+[2]: requirements.md