Merge pull request #582 from github/alejndr0/compression

Disable rsync compression by default.

Author: alejndr0

backup.config-example

@@ -58,6 +58,10 @@ GHE_NUM_SNAPSHOTS=10
 #
 #GHE_EXTRA_RSYNC_OPTS=""
 
+# If set to 'yes', rsync will be set to use compression during backups and restores transfers. Defaults to 'no'.
+#
+#GHE_RSYNC_COMPRESSION_ENABLED=yes
+
 # If enabled and set to 'no', rsync warning message during backups will be suppressed.
 #RSYNC_WARNING=no
 

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

@@ -39,7 +39,7 @@ fi
 # Transfer all Actions data from the user data directory using rsync.
 ghe_verbose "* Transferring Actions files from $host ..."
 log_rsync "BEGIN: actions rsync" 1>&3
-ghe-rsync -avz \
+ghe-rsync -av \
   -e "ghe-ssh -p $port" \
   --rsync-path='sudo -u actions rsync' \
   --exclude "mutexes" --exclude "dumps" --exclude "tmp" \

share/github-backup-utils/ghe-backup-es-rsync

@@ -45,7 +45,7 @@ fi
 # already been transferred.
 ghe_verbose "* Performing initial sync of ES indices ..."
 log_rsync "BEGIN elasticsearch rsync" 1>&3
-ghe-rsync -avz \
+ghe-rsync -av \
   -e "ghe-ssh -p $(ssh_port_part "$host")" \
   --rsync-path="sudo -u elasticsearch rsync" \
   $link_dest \
@@ -70,7 +70,7 @@ ghe-ssh "$host" -- curl -s -XPOST "localhost:9200/_flush" >/dev/null
 # Transfer all ES indices again
 ghe_verbose "* Performing follow-up sync of ES indices ..."
 log_rsync "BEGIN: elasticsearch followup rsync" 1>&3
-ghe-rsync -avz \
+ghe-rsync -av \
   -e "ghe-ssh -p $(ssh_port_part "$host")" \
   --rsync-path="sudo -u elasticsearch rsync" \
   $link_dest \

share/github-backup-utils/ghe-backup-minio

@@ -45,7 +45,6 @@ log_rsync "BEGIN: minio rsync" 1>&3
 ghe-rsync \
   --archive \
   --verbose \
-  --compress \
   --rsh="ghe-ssh -p ${port}" \
   --rsync-path='sudo -u minio rsync' \
   --exclude=".minio.sys" \

share/github-backup-utils/ghe-backup-pages

@@ -75,7 +75,7 @@ for hostname in $hostnames; do
   ghe_verbose "* Transferring pages files ..."
   log_rsync "BEGIN: pages rsync" 1>&3
   # Transfer all data from the user data directory using rsync.
-  ghe-rsync -avz \
+  ghe-rsync -av \
     -e "ssh -q $opts -p $port $ssh_config_file_opt -l $user" \
     --rsync-path='sudo -u git rsync' \
     $link_dest \

share/github-backup-utils/ghe-backup-userdata

@@ -54,7 +54,7 @@ fi
 mkdir -p "$GHE_SNAPSHOT_DIR/$dirname"
 log_rsync "BEGIN: userdata rsync" 1>&3
 # Transfer all data from the user data directory using rsync.
-ghe-rsync -avz \
+ghe-rsync -av \
   -e "ghe-ssh -p $(ssh_port_part "$host")" \
   --rsync-path='sudo -u git rsync' \
   $link_dest \

share/github-backup-utils/ghe-restore-es-audit-log

@@ -51,7 +51,7 @@ if [ -s "$tmp_list" ]; then
   ghe-ssh "$GHE_HOSTNAME" -- "sudo mkdir -p '$GHE_REMOTE_DATA_USER_DIR/elasticsearch-restore'" 1>&3
   ghe-ssh "$GHE_HOSTNAME" -- "sudo chown elasticsearch:elasticsearch '$GHE_REMOTE_DATA_USER_DIR/elasticsearch-restore'" 1>&3
   log_rsync "BEGIN: es-audit log rsync" 1>&3
-  ghe-rsync -avz --delete \
+  ghe-rsync -av --delete \
     -e "ghe-ssh -p $(ssh_port_part "$GHE_HOSTNAME")" \
     --rsync-path="sudo -u elasticsearch rsync" \
     --files-from=$tmp_list \

share/github-backup-utils/ghe-restore-es-rsync

@@ -37,7 +37,7 @@ else
   ghe-ssh "$GHE_HOSTNAME" -- "sudo mkdir -p '$GHE_REMOTE_DATA_USER_DIR/elasticsearch-restore'" 1>&3
   ghe-ssh "$GHE_HOSTNAME" -- "sudo chown elasticsearch:elasticsearch '$GHE_REMOTE_DATA_USER_DIR/elasticsearch-restore'" 1>&3
   log_rsync "BEGIN: elasticsearch rsync" 1>&3
-  ghe-rsync -avz --delete \
+  ghe-rsync -av --delete \
     -e "ghe-ssh -p $(ssh_port_part "$GHE_HOSTNAME")" \
     --rsync-path="sudo -u elasticsearch rsync" \
     --copy-dest="$GHE_REMOTE_DATA_USER_DIR/elasticsearch" \

share/github-backup-utils/ghe-rsync

@@ -29,6 +29,13 @@ if [ "$($( dirname "${BASH_SOURCE[0]}" )/ghe-rsync-feature-checker --trust-sende
   parameters=("--trust-sender" "${parameters[@]}")
 fi
 
+# This adds `--compress` to the parameters if supported by the current version of rsync
+# shellcheck source=share/github-backup-utils/ghe-rsync-feature-checker
+# shellcheck disable=SC2046
+if [ "$($( dirname "${BASH_SOURCE[0]}" )/ghe-rsync-feature-checker --compress)" == "true" ] && [ "$GHE_RSYNC_COMPRESSION_ENABLED" = "yes" ]; then
+  parameters+=("--compress")
+fi
+
 # This loads the $GHE_EXTRA_RSYNC_OPTS from the config file if available then adds them
 # to the parameters and skip adding if already present in the parameters
 # shellcheck source=share/github-backup-utils/ghe-rsync-feature-checker
@@ -41,7 +48,6 @@ if [ -n "$GHE_EXTRA_RSYNC_OPTS" ]; then
   done
 fi
 
-
 ignore_out='^(file has vanished: |rsync warning: some files vanished before they could be transferred)'
 rsync_version_check=$(rsync --version | grep -E "version 3.[0-9]*.[0-9]*")
 if [ -n "$rsync_version_check" ]; then