Merge pull request #406 from github/xn4p4lm-host-check-formatting-update

Update formatting on `ghe-host-check` to improve readability

Author: xN4P4LM

bin/ghe-host-check

@@ -163,9 +163,10 @@ SKIP_MSG
   . "$(dirname "${BASH_SOURCE[0]}")/../share/github-backup-utils/ghe-rsync-size"
 
   #Display dir requirements for repositories and mysql
+  echo "" 1>&2
   echo "Checking host for sufficient space for a backup..." 1>&2
   available_space=$(df -B 1k $GHE_DATA_DIR | awk 'END{printf "%.0f", $4 * 1024}') 
-  echo "We recommend allocating at least 5x the amount of storage allocated to the primary GitHub appliance for historical snapshots and growth over time." 1>&2
+  echo "  We recommend allocating at least 5x the amount of storage allocated to the primary GitHub appliance for historical snapshots and growth over time." 1>&2
 
   repos_disk_size=$(transfer_size repositories /tmp)
   pages_disk_size=$(transfer_size pages /tmp)
@@ -177,21 +178,22 @@ SKIP_MSG
   mssql_disk_size=$(transfer_size mssql /tmp)
 
   min_disk_req=$((repos_disk_size + pages_disk_size + es_disk_size + stor_disk_size + minio_disk_size + mysql_disk_size + actions_disk_size + mssql_disk_size))
-  echo "Available space: $((available_space / (1024 ** 2))) MB" 1>&2
-  echo -e "Min Disk required for this backup is at least $min_disk_req MB\n" 1>&2
-
-cat <<DATA_TRANSFER_SIZE 1>&2
-### Data Transfer Sizes 
-repositories: $repos_disk_size MB
-pages: $pages_disk_size MB
-elasticsearch: $es_disk_size MB
-storage: $stor_disk_size MB
-minio: $minio_disk_size MB
-mysql: $mysql_disk_size MB
-actions: $actions_disk_size MB
-mssql: $mssql_disk_size MB
-
-DATA_TRANSFER_SIZE
+  recommended_disk_req=$((min_disk_req * 5))
+  echo "   - Available space: $((available_space / (1024 ** 2))) MB" 1>&2
+  echo "   - Min Disk required for this backup is at least $min_disk_req MB" 1>&2
+  echo "   - Recommended Disk requirement is $recommended_disk_req MB" 1>&2
+  echo "" 1>&2
+
+  printf '### Data Transfer Sizes 
+ - repositories: %d MB
+ - pages: %d MB
+ - elasticsearch: %d MB
+ - storage: %d MB
+ - minio: %d MB
+ - mysql: %d MB
+ - actions: %d MB
+ - mssql: %d MB\n' \
+  "$repos_disk_size" "$pages_disk_size" "$es_disk_size" "$stor_disk_size" "$minio_disk_size" "$mysql_disk_size" "$actions_disk_size" "$mssql_disk_size" 1>&2
 
   if [[ $((available_space / (1024 * 1024))) -lt $min_disk_req ]]; then
     echo "There is not enough disk space for the backup. Please allocate more space and continue." 1>&2
@@ -221,24 +223,20 @@ DATA_TRANSFER_SIZE
     echo "Please make sure you have the minimum required version of rsync: $min_rsync installed" 1>&2
     exit 1
   elif [[ $rsync_version < 3.2.5 ]] && [[ $RSYNC_WARNING != "no" ]]; then
-  cat << WARN_MSG 1>&2
-**WARNING:** rsync version $rsync_version on backup host is less than 3.2.5, which could result in performance degradation.
-
-For more details, please read documentation at https://github.com/github/backup-utils/blob/master/docs/requirements.md#april-2023-update-of-rsync-requirements
-
-You can disable this warning by changing RSYNC_WARNING to 'no' in your backup.config file.
-   
-WARN_MSG
+    printf "\n  **WARNING:** rsync version %s on backup host is less than 3.2.5, which could result in performance degradation.
+  For more details, please read documentation at https://gh.io/april-2023-update-of-rsync-requirements
+  You can disable this warning by changing RSYNC_WARNING to 'no' in your backup.config file.\n\n" \
+    "$rsync_version" 1>&2
   fi
-  echo "rsync ${rsync_version} >= required ($min_rsync)" 1>&2
+  echo " - rsync ${rsync_version} >= required ($min_rsync)" 1>&2
 
   ssh_version=$(ssh -V 2>&1 | awk '{print $1}'|grep -oPm 1 '[\d\.]+' |head -1 | tr -cd '[:digit:].\n')
   if awk "BEGIN {exit !($ssh_version < $min_openssh)}" &> /dev/null; then
     echo "openSSH version $ssh_version in backup-host does not meet minimum requirements." 1>&2
     echo "Please make sure the minimum required version of openSSH: $min_openssh is installed" 1>&2
     exit 1
   else
-    echo "openSSH ${ssh_version} >= required ($min_openssh)" 1>&2
+    echo " - openSSH ${ssh_version} >= required ($min_openssh)" 1>&2
   fi
 
   jq_version=$(jq --version |awk -F\- '{print $2}' | tr -cd '[:digit:].\n')
@@ -247,8 +245,8 @@ WARN_MSG
     echo "Please make sure you have the minimum required version of jq: $min_jq installed" 1>&2
     exit 1
   else
-    echo "jq ${jq_version} >= required ($min_jq)" 1>&2
+    echo " - jq ${jq_version} >= required ($min_jq)" 1>&2
   fi
 fi
-
+echo "" 1>&2
 echo "Connect $hostname:$port OK (v$version)"