feat: Detect Windows and MacOS (#726)

.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -3,10 +3,20 @@ description: General questions about the container
 title: "[Question]: "
 labels: ["question"]
 body:
-  - type: markdown
+  - type: checkboxes
     attributes:
-      value: |
-        Please do not use this form for technical issues, and make sure to check the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md) first!
+      label: Is your question not already answered in the FAQ?
+      description: Please read the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md) carefully to avoid asking duplicate questions.
+      options:
+      - label: I made sure the question is not listed in the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md).
+        required: true
+  - type: checkboxes
+    attributes:
+      label: Is this a general question and not a technical issue?
+      description: For technical issues you must use the [bug report](https://github.com/vdsm/virtual-dsm/issues/new?assignees=&labels=bug&projects=&template=BUG_REPORT.yml&title=%5BBug%5D%3A+) form instead. It contains all the right fields (system info, logfiles, etc.) we need in order to be able to help you.
+      options:
+      - label: I am sure my question is not about a technical issue.
+        required: true
   - type: textarea
     id: question
     attributes:

readme.md

@@ -115,8 +115,8 @@ docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMI
 
   ```yaml
   devices:
-    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/dev/disk2
-    - /dev/disk/by-uuid/45678-45678-45678-45678-45678:/dev/disk3
+    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/disk2
+    - /dev/disk/by-uuid/45678-45678-45678-45678-45678:/disk3
   ```
 
   Make sure to bind the disk via its UUID (obtainable via `lsblk -o name,uuid`) instead of its name (`/dev/sdc`), to prevent ever binding the wrong disk when the drive letters happen to change. 

src/config.sh

@@ -12,4 +12,18 @@ DEV_OPTS="$DEV_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0
 ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $DEV_OPTS $ARGUMENTS"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')
 
+# Check available memory as the very last step
+
+RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
+AVAIL_GB=$(( (RAM_AVAIL + 1073741823)/1073741824 ))
+
+if (( (RAM_WANTED + 500000000) > RAM_AVAIL )); then
+  error "Your configured RAM_SIZE of $WANTED_GB GB is higher than the $AVAIL_GB GB of memory available, please set a lower value."
+  exit 17
+fi
+
+if (( (RAM_WANTED + 1450000000) > RAM_AVAIL )); then
+  warn "your configured RAM_SIZE of $WANTED_GB GB is much too close to the $AVAIL_GB GB of memory available, please set a lower value."
+fi
+
 return 0

src/disk.sh

@@ -527,6 +527,11 @@ DISK4_FILE="/storage4/data4"
 : "${DEVICE3:=""}"
 : "${DEVICE4:=""}"
 
+[ -z "$DEVICE" ] && [ -b "/disk1" ] && DEVICE="/disk1"
+[ -z "$DEVICE2" ] && [ -b "/disk2" ] && DEVICE2="/disk2"
+[ -z "$DEVICE3" ] && [ -b "/disk3" ] && DEVICE3="/disk3"
+[ -z "$DEVICE4" ] && [ -b "/disk4" ] && DEVICE4="/disk4"
+
 [ -z "$DEVICE" ] && [ -b "/dev/disk1" ] && DEVICE="/dev/disk1"
 [ -z "$DEVICE2" ] && [ -b "/dev/disk2" ] && DEVICE2="/dev/disk2"
 [ -z "$DEVICE3" ] && [ -b "/dev/disk3" ] && DEVICE3="/dev/disk3"

src/install.sh

@@ -118,14 +118,15 @@ if [ ! -s "$RDC" ]; then
   info "Install: $MSG" && html "$MSG"
 
   RD="$TMP/rd.gz"
+  SIZE=5394188
   POS="65627648-71021835"
   VERIFY="b4215a4b213ff5154db0488f92c87864"
   LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
 
   rm -f "$RD"
   rm -f "$RDC"
-  /run/progress.sh "$RD" "$PRG" &
-  { curl -r "$POS" -sfk -S -o "$RD" "$LOC"; rc=$?; } || :
+  /run/progress.sh "$RD" "$SIZE" "$PRG" &
+  { curl -r "$POS" -sfk --connect-timeout 10 -S -o "$RD" "$LOC"; rc=$?; } || :
 
   fKill "progress.sh"
 
@@ -141,12 +142,14 @@ if [ ! -s "$RDC" ]; then
   if [ "$SUM" != "$VERIFY" ]; then
 
     PAT="/install.pat"
+    SIZE=379637760
+
     rm -f "$RD"
     rm -f "$PAT"
 
     html "$MSG"
-    /run/progress.sh "$PAT" "$PRG" &
-    { wget "$LOC" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+    /run/progress.sh "$PAT" "$SIZE" "$PRG" &
+    { wget "$LOC" -O "$PAT" -q --no-check-certificate --timeout=10 --show-progress "$PROGRESS"; rc=$?; } || :
 
     fKill "progress.sh"
     (( rc != 0 )) && error "Failed to download $LOC , reason: $rc" && exit 60
@@ -208,15 +211,18 @@ html "$MSG"
 PAT="/$BASE.pat"
 rm -f "$PAT"
 
+SIZE=0
+[[ "$URL" == *"DSM_VirtualDSM_69057.pat" ]] && SIZE=363837333
+
 if [[ "$URL" == "file://"* ]]; then
 
   cp "${URL:7}" "$PAT"
 
 else
 
-  /run/progress.sh "$PAT" "$PRG" &
+  /run/progress.sh "$PAT" "$SIZE" "$PRG" &
 
-  { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+  { wget "$URL" -O "$PAT" -q --no-check-certificate --timeout=10 --show-progress "$PROGRESS"; rc=$?; } || :
 
   fKill "progress.sh"
   (( rc != 0 )) && error "Failed to download $URL , reason: $rc" && exit 69

src/network.sh

@@ -240,6 +240,23 @@ closeNetwork() {
   return 0
 }
 
+checkOS() {
+
+  local name
+  local os=""
+  name=$(uname -a)
+
+  [[ "${name,,}" == *"darwin"* ]] && os="MacOS"
+  [[ "${name,,}" == *"microsoft"* ]] && os="Windows"
+
+  if [ -n "$os" ]; then
+    error "You are using Docker Desktop for $os which does not support macvlan, please revert to bridge networking!"
+    return 1
+  fi
+
+  return 0
+}
+
 getInfo() {
 
   if [ -z "$VM_NET_DEV" ]; then
@@ -306,6 +323,8 @@ fi
 
 if [[ "$DHCP" == [Yy1]* ]]; then
 
+  ! checkOS && exit 19
+
   if [[ "$GATEWAY" == "172."* ]]; then
     warn "your gateway IP starts with 172.* which is often a sign that you are not on a macvlan network (required for DHCP)!"
   fi
@@ -318,6 +337,10 @@ if [[ "$DHCP" == [Yy1]* ]]; then
 
 else
 
+  if [[ "$GATEWAY" != "172."* ]]; then
+    ! checkOS && exit 19
+  fi
+
   # Shutdown nginx
   nginx -s stop 2> /dev/null
   fWait "nginx"

src/proc.sh

@@ -30,9 +30,17 @@ if [[ "$KVM" != [Nn]* ]]; then
 
   if [ -n "$KVM_ERR" ]; then
     KVM="N"
-    error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
-    error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
-    [[ "$DEBUG" != [Yy1]* ]] && exit 88
+    if [[ "$OSTYPE" =~ ^darwin ]]; then
+      warn "you are using MacOS which has no KVM support, this will cause a major loss of performance."
+    else
+      if grep -qi Microsoft /proc/version; then
+        warn "you are using Windows 10 which has no KVM support, this will cause a major loss of performance."
+      else
+        error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
+        error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
+        [[ "$DEBUG" != [Yy1]* ]] && exit 88
+      fi
+    fi
   fi
 
 fi

src/progress.sh

@@ -12,7 +12,8 @@ escape () {
 }
 
 file="$1"
-body=$(escape "$2")
+total="$2"
+body=$(escape "$3")
 info="/run/shm/msg.html"
 
 if [[ "$body" == *"..." ]]; then
@@ -24,7 +25,12 @@ do
   if [ -s "$file" ]; then
     bytes=$(du -sb "$file" | cut -f1)
     if (( bytes > 1000 )); then
-      size=$(echo "$bytes" | numfmt --to=iec --suffix=B  | sed -r 's/([A-Z])/ \1/')
+      if [ -z "$total" ] || [[ "$total" == "0" ]]; then
+        size=$(numfmt --to=iec --suffix=B  "$bytes" | sed -r 's/([A-Z])/ \1/')
+      else
+        size=$(printf '%.1f\n' "$((bytes*100*100/total))e-2")
+        size="$size%"
+      fi
       echo "${body//(\[P\])/($size)}"> "$info"
     fi
   fi

src/reset.sh

@@ -86,13 +86,9 @@ echo
 
 # Check memory
 
-if (( RAM_WANTED > RAM_AVAIL )); then
-  error "Your configured RAM_SIZE of $WANTED_GB GB is higher than the $AVAIL_GB GB of memory available."
-  exit 15
-fi
-
-if (( (RAM_WANTED + 1950000000) > RAM_AVAIL )); then
-  warn "your configured RAM_SIZE of $WANTED_GB GB is much too close to the $AVAIL_GB GB of memory available."
+if (( (RAM_WANTED + 500000000) > RAM_AVAIL )); then
+  error "Your configured RAM_SIZE of $WANTED_GB GB is higher than the $AVAIL_GB GB of memory available, please set a lower value."
+  exit 17
 fi
 
 # Cleanup files