Merge pull request #1008 from github/sync-private-to-public

Sync private to public

Author: wirecat

.github/workflows/docker-image.yml

@@ -15,11 +15,11 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Build the Debian Docker image
-      run: docker build . --file Dockerfile --tag backup-utils-debian:${GITHUB_RUN_ID}
+      run: docker build . --file Dockerfile --tag backup-utils:${GITHUB_RUN_ID}
     - name: Build the Alpine Docker image
       run: docker build . --file Dockerfile.alpine --tag backup-utils-alpine:${GITHUB_RUN_ID}
     - name: Run tests in Debian Docker image
-      run: docker run backup-utils-debian:${GITHUB_RUN_ID} ghe-backup --version
+      run: docker run backup-utils:${GITHUB_RUN_ID} ghe-backup --version
     - name: Run tests in Alpine Docker image
       run: docker run backup-utils-alpine:${GITHUB_RUN_ID} ghe-backup --version
 

.github/workflows/main.yml

@@ -2,11 +2,15 @@ name: Test and build
 
 on: [pull_request]
 
+
 jobs:
   build:
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'ubuntu-20.04', 'ubuntu-18.04', 'macos-latest']
+        # macos-latest references are kept here for historical purposes. removed macos-latest from the 
+        #matrix as it is not a typical case for users and causes a lot of friction with other linux-based 
+        # installs. Recommend developing on codespaces or using an ubuntu container. 
+        os: ['ubuntu-22.04', 'ubuntu-20.04', 'ubuntu-18.04']
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:

Dockerfile

@@ -1,4 +1,4 @@
-FROM debian:buster-slim
+FROM ubuntu:focal
 
 RUN apt-get -q -y update && \
     apt-get install -y --no-install-recommends \

RELEASING.md

@@ -44,6 +44,7 @@ done
 # Check to make sure moreutils parallel is installed and working properly
 ghe_parallel_check
 
+
 # Used to record failed backup steps
 failures=
 failures_file="$(mktemp -t backup-utils-backup-failures-XXXXXX)"
@@ -63,7 +64,7 @@ touch "incomplete"
 # Exit early if the snapshot filesystem doesn't support hard links, symlinks and
 # if rsync doesn't support hardlinking of dangling symlinks
 trap 'rm -rf src dest1 dest2' EXIT
-mkdir src
+mkdir -p src
 touch src/testfile
 if ! ln -s /data/does/not/exist/hooks/ src/ >/dev/null 2>&1; then
   echo "Error: the filesystem containing $GHE_DATA_DIR does not support symbolic links." 1>&2
@@ -105,6 +106,7 @@ cleanup () {
   fi
 
   rm -rf "$failures_file"
+  rm -f ${GHE_DATA_DIR}/in-progress-backup
 
   # Cleanup SSH multiplexing
   ghe-ssh --clean
@@ -114,10 +116,15 @@ cleanup () {
 trap 'cleanup' EXIT
 trap 'exit $?' INT # ^C always terminate
 
+
+# Check to see if there is a running restore
+ghe_restore_check
+
+# Check to see if there is a running backup
 if [ -h ../in-progress ]; then
   echo "Error: detected a backup already in progress from a previous version of ghe-backup." 1>&2
   echo "If there is no backup in progress anymore, please remove" 1>&2
-  echo "the $GHE_DATA_DIR/in-progress file." 1>&2
+  echo "the $GHE_DATA_DIR/in-progress file and try again." 1>&2
   exit 1
 fi
 
@@ -131,13 +138,15 @@ if [ -f ../in-progress ]; then
     unlink ../in-progress
   else
     echo "Error: A backup of $GHE_HOSTNAME may still be running on PID $pid." 1>&2
-    echo "If PID $pid is not a process related to the backup utilities, please remove" 1>&2
-    echo "the $GHE_DATA_DIR/in-progress file and try again." 1>&2
+    echo 1>&2
+    echo "  If PID $pid is not a process related to the backup utilities, please remove" 1>&2
+    echo "  the $GHE_DATA_DIR/in-progress file and try again." 1>&2
     exit 1
   fi
 fi
 
 echo "$GHE_SNAPSHOT_TIMESTAMP $$" > ../in-progress
+echo "$GHE_SNAPSHOT_TIMESTAMP $$" > ${GHE_DATA_DIR}/in-progress-backup
 
 START_TIME=$(date +%s)
 echo 'Start time:' $START_TIME
@@ -278,3 +287,6 @@ ghe-detect-leaked-ssh-keys -s "$GHE_SNAPSHOT_DIR" || true
 
 # Make sure we exit zero after the conditional
 true
+
+# Remove in-progress file
+ghe_backup_finished

bin/ghe-backup

@@ -122,6 +122,8 @@ cleanup () {
 
   # Cleanup SSH multiplexing
   ghe-ssh --clean
+  # Remove in-progress file
+  rm -f ${GHE_DATA_DIR}/in-progress-restore
 }
 
 # This function's type definition is being passed to a remote host via `ghe-ssh` but is not used locally.
@@ -152,6 +154,9 @@ cleanup_cluster_nodes() {
 # Check to make sure moreutils parallel is installed and working properly
 ghe_parallel_check
 
+# Check to make sure another restore process is not running
+ghe_restore_check
+
 # Grab the host arg
 GHE_HOSTNAME="${GHE_RESTORE_HOST_OPT:-$GHE_RESTORE_HOST}"
 
@@ -170,6 +175,9 @@ GHE_RESTORE_SNAPSHOT_PATH="$(ghe-restore-snapshot-path "$snapshot_id")"
 GHE_RESTORE_SNAPSHOT=$(basename "$GHE_RESTORE_SNAPSHOT_PATH")
 export GHE_RESTORE_SNAPSHOT
 
+# Check to make sure backup is not running
+ghe_backup_check
+
 # Detect if the backup we are restoring has a leaked ssh key
 echo "Checking for leaked keys in the backup snapshot that is being restored ..."
 ghe-detect-leaked-ssh-keys -s "$GHE_RESTORE_SNAPSHOT_PATH" || true
@@ -252,6 +260,8 @@ START_TIME=$(date +%s)
 echo 'Start time:' $START_TIME
 echo "Starting restore of $GHE_HOSTNAME with backup-utils v$BACKUP_UTILS_VERSION from snapshot $GHE_RESTORE_SNAPSHOT"
 ghe_remote_logger "Starting restore from $(hostname) with backup-utils v$BACKUP_UTILS_VERSION / snapshot $GHE_RESTORE_SNAPSHOT ..."
+# Create an in-progress-restore file to prevent simultaneous backup or restore runs
+echo "${START_TIME} $$" > ${GHE_DATA_DIR}/in-progress-restore
 
 # Keep other processes on the VM or cluster in the loop about the restore status.
 #
@@ -579,6 +589,7 @@ echo 'End time:' $END_TIME
 echo 'Runtime:' $(($END_TIME - $START_TIME)) 'seconds'
 
 echo "Restore of $GHE_HOSTNAME from snapshot $GHE_RESTORE_SNAPSHOT finished."
+ghe_restore_finished
 
 if ! $instance_configured; then
   echo "To complete the restore process, please visit https://$hostname/setup/settings to review and save the appliance configuration."

bin/ghe-restore

@@ -66,6 +66,60 @@ for f in "$GHE_BACKUP_CONFIG" "$GHE_BACKUP_ROOT/backup.config" \
   fi
 done
 
+GHE_RESTORE_IN_PROGRESS=$(readlink -fm "${GHE_DATA_DIR}/in-progress-restore")
+GHE_BACKUP_IN_PROGRESS=$(readlink -fm "${GHE_DATA_DIR}/in-progress-backup")
+
+export GHE_RESTORE_IN_PROGRESS
+export GHE_BACKUP_IN_PROGRESS
+
+ghe_restore_check() {
+  if [ -h $GHE_RESTORE_IN_PROGRESS ]; then
+    echo "  Error: detected a restore already in progress from a previous version of ghe-restore." 1>&2
+    echo "  If there is no restore in progress anymore, please remove" 1>&2
+    echo "  the $GHE_RESTORE_IN_PROGRESS file and try again." 1>&2
+    exit 1
+  fi
+
+  if [ -f $GHE_RESTORE_IN_PROGRESS ]; then
+    progress=$(cat $GHE_RESTORE_IN_PROGRESS)
+    pid=$(echo "$progress" | cut -d ' ' -f 2)
+    echo "  Error: A restore of $GHE_HOSTNAME may still be running on PID $pid." 1>&2
+    echo "  If PID $pid is not a process related to the restore utilities, please remove" 1>&2
+    echo "  the $GHE_RESTORE_IN_PROGRESS file and try again." 1>&2
+    exit 1
+  fi
+}
+
+ghe_backup_check() {
+  if [ -h $GHE_BACKUP_IN_PROGRESS ]; then
+    echo "  Error: detected a backup already in progress from a previous version of ghe-backup." 1>&2
+    echo "  If there is no backup in progress anymore, please remove" 1>&2
+    echo "  the $GHE_DATA_DIR/$GHE_BACKUP_IN_PROGRESS file and try again." 1>&2
+    exit 1
+  fi
+
+  if [ -f $GHE_BACKUP_IN_PROGRESS ]; then
+    progress=$(cat $GHE_BACKUP_IN_PROGRESS)
+    pid=$(echo "$progress" | cut -d ' ' -f 2)
+    echo "  Error: A backup of $GHE_HOSTNAME may still be running on PID $pid." 1>&2
+    echo "  If PID $pid is not a process related to the backup utilities, please remove" 1>&2
+    echo "  the $GHE_BACKUP_IN_PROGRESS file and try again." 1>&2
+    exit 1
+  fi
+}
+
+ghe_restore_finished() {
+  if [ -f $GHE_RESTORE_IN_PROGRESS ]; then
+    rm -f $GHE_RESTORE_IN_PROGRESS
+  fi
+}
+
+ghe_backup_finished() {
+  if [ -f $GHE_BACKUP_IN_PROGRESS ]; then
+    rm -f $GHE_BACKUP_IN_PROGRESS
+  fi
+}
+
 ghe_parallel_check() {
   if [ "$GHE_PARALLEL_ENABLED" != "yes" ]; then
     return 0