Merge branch 'master' into patch-1

Author: gamefiend

README.md

@@ -3,33 +3,33 @@
 This repository includes backup and recovery utilities for
 [GitHub Enterprise Server][1].
 
-**UPDATE**: The new parallel backup and restore beta feature will require [GNU awk](https://www.gnu.org/software/gawk) and [moreutils](https://joeyh.name/code/moreutils) to be installed. Note that on some distributions/platforms, the `moreutils-parallel` package is separate from `moreutils` and must be installed on its own.
+**Note**: The parallel backup and restore feature will require [GNU awk](https://www.gnu.org/software/gawk) and [moreutils](https://joeyh.name/code/moreutils) to be installed. Note that on some distributions/platforms, the `moreutils-parallel` package is separate from `moreutils` and must be installed on its own.
 
 **Note**: the [GitHub Enterprise Server version requirements][2] have
 changed starting with Backup Utilities v2.13.0, released on 27 March 2018.
 
-### Features
+## 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 Server.
 
- - Complete GitHub Enterprise Server backup and recovery system via two simple
+- 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
+- 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
+- Incremental backup of Git repository data. Only changes since the last
    snapshot are transferred, leading to faster backup runs and lower network
    bandwidth and machine utilization.
- - Efficient snapshot storage. Only data added since the previous snapshot
+- Efficient snapshot storage. Only data added since the previous snapshot
    consumes new space on the backup host.
- - Multiple backup snapshots with configurable retention periods.
- - Backup commands run under the lowest CPU/IO priority on the GitHub appliance,
+- Multiple backup snapshots with configurable retention periods.
+- Backup commands run under the lowest CPU/IO priority on the GitHub appliance,
    reducing performance impact while backups are in progress.
- - Runs under most Linux/Unix environments.
- - MIT licensed, open source software maintained by GitHub, Inc.
+- Runs under most Linux/Unix environments.
+- MIT licensed, open source software maintained by GitHub, Inc.
 
-### Documentation
+## Documentation
 
 - **[Requirements](docs/requirements.md)**
   - **[Backup host requirements](docs/requirements.md#backup-host-requirements)**
@@ -42,7 +42,7 @@ GitHub Enterprise Server.
 - **[How does Backup Utilities differ from a High Availability replica?](docs/faq.md)**
 - **[Docker](docs/docker.md)**
 
-### Support
+## Support
 
 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
@@ -53,3 +53,4 @@ instead.
 [1]: https://github.com/enterprise
 [2]: docs/requirements.md#github-enterprise-version-requirements
 [3]: https://support.github.com/
+

RELEASING.md

@@ -6,7 +6,7 @@ For example, Backup Utilities 2.13.0 can be used to backup and restore all patch
 
 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 Server that that release supports.
+When making a `.0` release, you will need to specify the minimum supported version of GitHub Enterprise Server that release supports.
 
 Only repo administrator is allowed to run the release script, otherwise it will fail.
 

STYLEGUIDE.md

@@ -165,7 +165,7 @@ rsync /data/user/db remote:/data/user/db
 ---
 ##### Use lowercase and uppercase variable names
 
-Use lowercase variables for locals and internal veriables, and uppercase for variables inherited or exported via the environment
+Use lowercase variables for locals and internal variables, and uppercase for variables inherited or exported via the environment
 
 ```bash
 #!/usr/bin/env bash

backup.config-example

@@ -64,27 +64,23 @@ GHE_NUM_SNAPSHOTS=10
 
 # If set to 'yes', ghe-backup jobs will run in parallel. Defaults to 'no'.
 #
-# WARNING: this feature is in beta.
 #GHE_PARALLEL_ENABLED=yes
 
 # Sets the maximum number of jobs to run in parallel. Defaults to the number
 # of available processing units on the machine.
 #
-# WARNING: this feature is in beta.
 #GHE_PARALLEL_MAX_JOBS=2
 
 # Sets the maximum number of rsync jobs to run in parallel. Defaults to the
 # configured GHE_PARALLEL_MAX_JOBS, or the number of available processing 
 # units on the machine.
 #
-# WARNING: this feature is in beta.
 # GHE_PARALLEL_RSYNC_MAX_JOBS=3
 
 # When jobs are running in parallel wait as needed to avoid starting new jobs
 # when the system's load average is not below the specified percentage. Defaults to
 # unrestricted.
 #
-# WARNING: this feature is in beta.
 #GHE_PARALLEL_MAX_LOAD=50
 
 # When running an external mysql database, run this script to trigger a MySQL backup

bin/ghe-host-check

@@ -53,7 +53,7 @@ port=$(ssh_port_part "$host")
 hostname=$(ssh_host_part "$host")
 
 set +e
-# ghe-negotiate-version verifies if the target is a Github Enterprise Server instance
+# ghe-negotiate-version verifies if the target is a GitHub Enterprise Server instance
 output=$(echo "ghe-negotiate-version backup-utils $BACKUP_UTILS_VERSION" | ghe-ssh -o BatchMode=no $options $host -- /bin/sh 2>&1)
 rc=$?
 set -e
@@ -131,7 +131,7 @@ fi
 
 # backup-utils 2.13 onwards limits support to the current and previous two releases
 # of GitHub Enterprise Server.
-supported_minimum_version="3.4.0"
+supported_minimum_version="3.5.0"
 
 if [ "$(version $version)" -ge "$(version $supported_minimum_version)" ]; then
   supported=1

debian/changelog

@@ -1,3 +1,8 @@
+github-backup-utils (3.7.0) UNRELEASED; urgency=medium
+
+
+ -- Devin Dooley <[email protected]>  Tue, 25 Oct 2022 00:35:38 +0000
+
 github-backup-utils (3.6.0) UNRELEASED; urgency=medium
 
 

docs/getting-started.md

@@ -31,8 +31,8 @@
     * In a clustering environment, the `GHE_EXTRA_SSH_OPTS` key must be configured
       with the `-i <abs path to private key>` SSH option.
 
- 3. Add the backup host's SSH key to the GitHub appliance as an *Authorized SSH
-    key*. See [Adding your SSH key to the ssh-agent][4] for instructions.
+ 3. Add the backup host's SSH public key to the GitHub Enterprise Server appliance, in order to grant it administrative shell access.
+    See [Accessing the GitHub Enterprise Server administrative shell (SSH)][4] for instructions.
 
  4. Run `bin/ghe-host-check` to verify SSH connectivity with the GitHub
     appliance.
@@ -42,4 +42,4 @@
 [1]: https://github.com/github/backup-utils/releases
 [2]: https://github.com/github/backup-utils/releases/tag/v2.11.4
 [3]: https://github.com/github/enterprise-backup-site/blob/master/backup.config-example
-[4]: https://docs.github.com/enterprise-server/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent
+[4]: https://docs.github.com/enterprise-server/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh

docs/requirements.md

@@ -6,12 +6,11 @@ storage and must have network connectivity with the GitHub Enterprise Server app
 ## Backup host requirements
 
 Backup host software requirements are modest: Linux or other modern Unix operating
-system with [bash][1], [git][2], [OpenSSH][3] 5.6 or newer, and [rsync][4] v2.6.4 or newer.
+system (Ubuntu is highly recommended) with [bash][1], [git][2], [OpenSSH][3] 5.6 or newer, [rsync][4] v2.6.4 or newer, and [jq][11] v1.5 or newer.
 
-The new parallel backup and restore beta feature will require [GNU awk][10] and [moreutils][9] to be installed.
+The parallel backup and restore feature will require [GNU awk][10] and [moreutils][9] to be installed.
 
-We encourage the use of [Docker](docker.md) if your backup host doesn't meet these
-requirements, or if Docker is your preferred platform.
+We encourage the use of [Docker](docker.md), as it ensures compatible versions of the aforementioned software are available to backup-utils.
 
 The backup host must be able to establish outbound network connections to the
 GitHub appliance over SSH. TCP port 122 is used to backup GitHub Enterprise Server.
@@ -67,7 +66,7 @@ be running GitHub Enterprise Server 2.12.x or 2.13.x. You can't restore a snapsh
 
 Using multiple backup hosts or backup configurations is not currently recommended.
 
-Due to how some components of Backup Utiltiies (e.g. MSSQL) take incremental backups, running another instance of Backup Utilities may result in unrestorable snapshots as data may be split across backup hosts. If you still wish to have multiple instances of Backup Utilties for redundancy purposes or to run at different frequencies, ensure that they share the same `GHE_DATA_DIR` backup directory.
+Due to how some components of Backup Utilities (e.g. MSSQL) take incremental backups, running another instance of Backup Utilities may result in unrestorable snapshots as data may be split across backup hosts. If you still wish to have multiple instances of Backup Utilities for redundancy purposes or to run at different frequencies, ensure that they share the same `GHE_DATA_DIR` backup directory.
 
 [1]: https://www.gnu.org/software/bash/
 [2]: https://git-scm.com/
@@ -79,3 +78,4 @@ Due to how some components of Backup Utiltiies (e.g. MSSQL) take incremental bac
 [8]: https://help.github.com/enterprise/admin/guides/installation/upgrade-requirements/
 [9]: https://joeyh.name/code/moreutils
 [10]: https://www.gnu.org/software/gawk
+[11]: https://stedolan.github.io/jq/

docs/usage.md

@@ -100,7 +100,7 @@ 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. Put replacement appliance into maintaince mode. 
+2. Put replacement appliance into maintenance mode. 
 3. Use `ghe-restore` to restore the backup.
 4. Re-register your self-hosted runners on the replacement appliance.
 

script/release

@@ -330,7 +330,7 @@ def clean_up(version)
   `git pull --quiet origin #{GH_BASE_BRANCH} --prune`
   `git branch --quiet -D release-#{version} >/dev/null 2>&1`
   `git push --quiet origin :release-#{version} >/dev/null 2>&1`
-  `git branch --quiet -D tmp-packging >/dev/null 2>&1`
+  `git branch --quiet -D tmp-packaging >/dev/null 2>&1`
 end
 
 #### All the action starts ####