Remove unused and deprecated function

- Shifted release info to packer variables
- Doubled boot_command initial wait to 20s
- Renamed Packer source to debian-live
- Removed .sh from debianzfs script path
- Tweaked comment wording
- Replaced hardcoded codename
- Used 'ln -fs' for existing /etc/mtab

Makefile

@@ -1,6 +1,13 @@
 all: debianzfs.qcow2
 
-debianzfs.qcow2: export PKR_VAR_password = "$(pwgen -s 8 1)"
+# Generate password
+debianzfs.qcow2: export PKR_VAR_password="$(pwgen -s 8 1)"
+
+# Release info
+debianzfs.qcow2: export PKR_VAR_release=12.0.0
+debianzfs.qcow2: export PKR_VAR_codename=bookworm
+debianzfs.qcow2: export PKR_VAR_sha256=fa3960f6f692fc60a43eec4362d60f754b4a246ab64aa662270dd879a946de84
+
 debianzfs.qcow2:
 	packer build -color=false . | tee debianzfs.log
 

debianzfs.pkr.hcl

@@ -1,9 +1,11 @@
 # Set 'password' using shell var: PKR_VAR_password=$(pwgen -s 8 1)
 variable "password" {}
+variable "release" {}
+variable "sha256" {}
 
-source "qemu" "bullseye-live" {
+source "qemu" "debian-live" {
-  iso_url           = "https://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/debian-live-11.5.0-amd64-standard.iso"
+  iso_url           = "https://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/debian-live-${var.release}-amd64-standard.iso"
-  iso_checksum      = "sha256:8172b188061d098080bb315972becbe9bd387c856866746cee018102cd00fc9b"
+  iso_checksum      = "sha256:${var.sha256}"
   output_directory  = "output"
   shutdown_command  = "echo 'packer' | sudo -S shutdown -P now"
   disk_size         = "5000M"
@@ -19,7 +21,7 @@ source "qemu" "bullseye-live" {
   disk_interface    = "virtio"
   boot_wait         = "5s"
   boot_command      = [
-        "<enter><wait10>",
+        "<enter><wait20>",
         "<enter><wait>",
         "sudo -i<enter><wait>",
         "read -s userpw<enter><wait>",
@@ -33,11 +35,11 @@ source "qemu" "bullseye-live" {
 
 build {
   name = "zfs"
-  sources = ["source.qemu.bullseye-live"]
+  sources = ["source.qemu.debian-live"]
 
   provisioner "file" {
     source      = "debianzfs.sh"
-    destination = "/tmp/debianzfs.sh"
+    destination = "/tmp/debianzfs"
   }
 
   provisioner "shell" {
@@ -45,7 +47,7 @@ build {
   }
 
   provisioner "shell" {
-     inline = ["sudo /tmp/debianzfs.sh -p changeme -P letmeinzfs! /dev/vda debianzfs"]
+     inline = ["sudo /tmp/debianzfs -i -s0 -p 'changeme' -P 'letmeinzfs!' /dev/vda debianzfs"]
   }
 
 }

debianzfs.sh

@@ -1,98 +1,131 @@
 #!/bin/bash
 
-# Script is based off official guide: see "Debian Bullseye Root on ZFS"
+# This script is originally based off the "Debian Bullseye Root on ZFS" guide
 # https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Bullseye%20Root%20on%20ZFS.html
 
 #################
 ### Functions ###
 #################
 function usage () {
-  echo "Usage: ./$(basename "$0") [-mpPr] <DISK> [hostname]"
+	echo "Usage: $(basename "$0") [-ghimpPrs] <DISK> [HOSTNAME]"
+	echo -e "\t-g\n\t\tMirror GRUB after the installation. Requires: -m"
+	echo -e "\n\t-h\n\t\tThe help menu, i.e., the menu you're seeing now."
+	echo -e "\n\t-i\n\t\tIgnore the check for the /dev/disk/by-id/* format. You'll likely want: -s"
+	echo -e "\n\t-m <MIRROR>\n\t\tSet the MIRROR disk for a ZFS mirror installation."
+	echo -e "\n\t-p <PASSWORD>\n\t\tSet the password for root. Caution: saves to file temporarily."
+	echo -e "\n\t-P <PASSWWORD>\n\t\tSet the password for encrypting the root zpool."
+	echo -e "\n\t-r <ZFSROOT>\n\t\tSet the path for the new ZFS chroot. Defaults to /mnt"
+	echo -e "\n\t-s <PARTSUFFIX>\n\t\tSet the partition suffix for disks, defaults to: -part"
+	echo -e "\t\tSet to a zero '0' to remove the suffix entirely, i.e., -s0"
 }
 
 function disk_check () {
-  DISK_TYPE=$(file "$1" | awk '{ print $2$3 }')
+	local DISK="$1"
-  if [ "$DISK_TYPE" != "blockspecial" ]; then
+	local DISK_TYPE
-    echo "ERROR: Disk '$1' is not a block device"
+	[ -L "$DISK" ] && DISK=$(readlink -f "$DISK")
-    exit 1
+	DISK_TYPE=$(file "$DISK" | awk '{ print $2$3 }')
-  fi
+	if [ "$DISK_TYPE" != "blockspecial" ]; then
+		echo "ERROR: Disk '$DISK' is not a block device"
+		exit 1
+	fi
 }
 
 function disk_status () {
-  OUTPUT=$(wipefs "$1")
+	local OUTPUT
-  if [ -n "$OUTPUT" ]; then
+	OUTPUT=$(wipefs "$1")
-    echo "ERROR: $1 is not empty"
+	if [ -n "$OUTPUT" ]; then
-    echo "$OUTPUT"
+		echo "ERROR: $1 is not empty"
-    exit 1
+		echo "$OUTPUT"
-  fi
+		exit 1
+	fi
 }
 
 function password_prompt () {
-  unset PASSWORD_PROMPT_RESULT
+	local password
-  while true; do
+	local password_confirm
-    read -r -s -p "${1}: " password
+	unset PASSWORD_PROMPT_RESULT
-    echo ''
+	while true; do
-    read -r -s -p "${1} (confirm): " password_confirm
+		read -r -s -p "${1}: " password
-    echo ''
+		echo ''
-    if [ "$password" == "$password_confirm" ]; then
+		read -r -s -p "${1} (confirm): " password_confirm
-      if [ -z "$password" ]; then
+		echo ''
-        echo "Password can not be empty, try again."
+		if [ "$password" == "$password_confirm" ]; then
-      else
+			if [ -z "$password" ]; then
-        break
+				echo "Password can not be empty, try again."
-      fi
+			else
-    else
+				break
-      echo "Passwords did not match, try again."
+			fi
-    fi
+		else
-  done
+			echo "Passwords did not match, try again."
-  PASSWORD_PROMPT_RESULT="$password"
+		fi
-  export PASSWORD_PROMPT_RESULT
+	done
+	PASSWORD_PROMPT_RESULT="$password"
+	export PASSWORD_PROMPT_RESULT
 }
 
 
 function disk_format () {
-  sgdisk -n2:1M:+512M -t2:EF00 "$1"
+	sgdisk -n2:1M:+512M -t2:EF00 "$1"
-  sgdisk -n3:0:+1G    -t3:BF01 "$1"
+	sgdisk -n3:0:+1G    -t3:BF01 "$1"
-  sgdisk -n4:0:0      -t4:BF00 "$1"
+	sgdisk -n4:0:0      -t4:BF00 "$1"
 }
 
 function create_boot_pool () {
-  zpool create -f \
+	# shellcheck disable=SC2086
-    -o ashift=12 \
+	zpool create -f \
-    -o autotrim=on -d \
+		-o ashift=12 \
-    -o cachefile=/etc/zfs/zpool.cache \
+		-o autotrim=on -d \
-    -o feature@async_destroy=enabled \
+		-o cachefile=/etc/zfs/zpool.cache \
-    -o feature@bookmarks=enabled \
+		-o feature@async_destroy=enabled \
-    -o feature@embedded_data=enabled \
+		-o feature@bookmarks=enabled \
-    -o feature@empty_bpobj=enabled \
+		-o feature@embedded_data=enabled \
-    -o feature@enabled_txg=enabled \
+		-o feature@empty_bpobj=enabled \
-    -o feature@extensible_dataset=enabled \
+		-o feature@enabled_txg=enabled \
-    -o feature@filesystem_limits=enabled \
+		-o feature@extensible_dataset=enabled \
-    -o feature@hole_birth=enabled \
+		-o feature@filesystem_limits=enabled \
-    -o feature@large_blocks=enabled \
+		-o feature@hole_birth=enabled \
-    -o feature@livelist=enabled \
+		-o feature@large_blocks=enabled \
-    -o feature@lz4_compress=enabled \
+		-o feature@livelist=enabled \
-    -o feature@spacemap_histogram=enabled \
+		-o feature@lz4_compress=enabled \
-    -o feature@zpool_checkpoint=enabled \
+		-o feature@spacemap_histogram=enabled \
-    -O devices=off \
+		-o feature@zpool_checkpoint=enabled \
-    -O acltype=posixacl -O xattr=sa \
+		-O devices=off \
-    -O compression=lz4 \
+		-O acltype=posixacl -O xattr=sa \
-    -O normalization=formD \
+		-O compression=lz4 \
-    -O relatime=on \
+		-O normalization=formD \
-    -O canmount=off -O mountpoint=/boot -R "$1" \
+		-O relatime=on \
-		bpool "$2"
+		-O canmount=off -O mountpoint=/boot -R "$1" \
+		bpool $2
 }
 
 function create_root_pool () {
-  echo "$3" | zpool create -f \
+	# shellcheck disable=SC2086
-    -o ashift=12 \
+	echo "$3" | zpool create -f \
-    -o autotrim=on \
+		-o ashift=12 \
-    -O encryption=on -O keylocation=prompt -O keyformat=passphrase \
+		-o autotrim=on \
-    -O acltype=posixacl -O xattr=sa -O dnodesize=auto \
+		-O encryption=on -O keylocation=prompt -O keyformat=passphrase \
-    -O compression=lz4 \
+		-O acltype=posixacl -O xattr=sa -O dnodesize=auto \
-    -O normalization=formD \
+		-O compression=lz4 \
-    -O relatime=on \
+		-O normalization=formD \
-    -O canmount=off -O mountpoint=/ -R "$1" \
+		-O relatime=on \
-		rpool "$2"
+		-O canmount=off -O mountpoint=/ -R "$1" \
+		rpool $2
+}
+
+function mirror_grub () {
+	umount /boot/efi
+	dd if="$1" of="$2"
+	efibootmgr -c -g -d "$2" -p 2 \
+		-L "debian-${3}" -l '\EFI\debian\grubx64.efi'
+	mount /boot/efi
+}
+
+function disk_byid_check () {
+	local BYID="/dev/disk/by-id/"
+	if [ ! "${1:0:${#BYID}}" == "$BYID" ]; then
+		echo "ERROR: DISK needs to be ${BYID}* format"
+		exit 1
+	fi
 }
 
 ################
@@ -100,19 +133,22 @@ function create_root_pool () {
 ################
 # Static
 export DEBIAN_FRONTEND=noninteractive
-CODENAME="bullseye"
+CODENAME="bookworm"
 
 # Options
-while getopts ':m:p:P:r:' OPTION; do
+while getopts ':ghim:p:P:r:s:' OPTION; do
-  case "$OPTION" in
+	case "$OPTION" in
-  m) MIRROR="$OPTARG";;
+		g) GRUB_MIRROR="true";;
-  p) ROOTPW="$OPTARG";;
+		i) IGNORE_BYID="true";;
-  P) RPOOLPW="$OPTARG";;
+		m) MIRROR="$OPTARG";;
-  r) ZFSROOT="$OPTARG";;
+		p) ROOTPW="$OPTARG";;
-  ?)
+		P) RPOOLPW="$OPTARG";;
-    usage
+		r) ZFSROOT="$OPTARG";;
-    exit 1;;
+		s) PARTSUFFIX="$OPTARG";;
-  esac
+		?)
+			usage
+			exit 1;;
+	esac
 done
 shift "$((OPTIND -1))"
 
@@ -120,59 +156,90 @@ shift "$((OPTIND -1))"
 DISK=$1
 ZFSHOST=$2
 
+# Post-boot grub mirror?
+if [ "$GRUB_MIRROR" == "true" ]; then
+	while true; do
+		echo -e "ORIGINAL GRUB: $DISK\nMIRROR TO: $MIRROR"
+		read -r -p "Would you like to mirror GRUB? [y/N]: " yn
+		case $yn in
+			[Yy]*)
+				disk_check "$DISK"
+				disk_check "$MIRROR"
+				[ -z "$IGNORE_BYID" ] && disk_byid_check "$DISK"
+				[ -z "$IGNORE_BYID" ] && disk_byid_check "$MIRROR"
+				mirror_grub "$DISK" "$MIRROR" 2
+				exit 0;;
+			?)
+				echo "ABORTED: User did not confirm mirroring"
+				exit 1;;
+		esac
+	done
+fi
+
 # Verify variables
 [ -z "$ZFSROOT" ] && ZFSROOT="/mnt"
 
+if [ -z "$PARTSUFFIX" ]; then
+	PARTSUFFIX="-part"
+elif [ "$PARTSUFFIX" == "0" ]; then
+	PARTSUFFIX=""
+fi
+
 if [ -z "$DISK" ]; then
-  echo "ERROR: DISK not set"
+	echo "ERROR: DISK not set"
-  usage
+	usage
-  exit 1
+	exit 1
 fi
 
 if [ -z "$ZFSHOST" ]; then
-  echo "ERROR: HOSTNAME not set"
+	echo "ERROR: HOSTNAME not set"
-  usage
+	usage
-  exit 1
+	exit 1
 fi
 
 if [ -z "$ROOTPW" ]; then
-  password_prompt "Root Passphrase"
+	password_prompt "Root Passphrase"
-  ROOTPW="$PASSWORD_PROMPT_RESULT"
+	ROOTPW="$PASSWORD_PROMPT_RESULT"
-  unset PASSWORD_PROMPT_RESULT
+	unset PASSWORD_PROMPT_RESULT
 fi
 
 if [ -z "$RPOOLPW" ]; then
-  password_prompt "ZFS Encryption Passphrase"
+	password_prompt "ZFS Encryption Passphrase"
-  RPOOLPW="$PASSWORD_PROMPT_RESULT"
+	RPOOLPW="$PASSWORD_PROMPT_RESULT"
-  unset PASSWORD_PROMPT_RESULT
+	unset PASSWORD_PROMPT_RESULT
 fi
 
 if [ "$DEBUG" == "true" ]; then
-  echo "CODENAME=${CODENAME}"
+	echo "CODENAME='${CODENAME}'"
-  echo "DISK=${DISK}"
+	echo "DISK='${DISK}'"
-  echo "ZFSHOST=${ZFSHOST}"
+	echo "ZFSHOST='${ZFSHOST}'"
-  echo "ZFSROOT=${ZFSROOT}"
+	echo "ZFSROOT='${ZFSROOT}'"
-  echo "MIRROR=${MIRROR}"
+	echo "MIRROR='${MIRROR}'"
-  echo "ROOTPW=${ROOTPW}"
+	echo "ROOTPW='${ROOTPW}'"
-  echo "RPOOLPW=${RPOOLPW}"
+	echo "RPOOLPW='${RPOOLPW}'"
+	echo "PARTSUFFIX='${PARTSUFFIX}'"
+	echo "GRUB_MIRROR='${GRUB_MIRROR}'"
+	echo "IGNORE_BYID='${IGNORE_BYID}'"
 fi
 
-# Display commands
-set -x
-
 # Are the DISK paths block devices? AND
 # Are the DISK pathes empty devices? i.e., no filesystem signatures
 disk_check "$DISK"
 disk_status "$DISK"
+[ -z "$IGNORE_BYID" ] && disk_byid_check "$DISK"
 if [ -n "$MIRROR" ]; then
-  disk_check "$MIRROR"
+	disk_check "$MIRROR"
-  disk_status "$MIRROR"
+	disk_status "$MIRROR"
+	[ -z "$IGNORE_BYID" ] && disk_byid_check "$MIRROR"
 fi
 
 ###############################################
 ### Step 1: Prepare The Install Environment ###
 ###############################################
 
+# Display commands
+set -xe
+
 # 1. Boot the Debian GNU/Linux Live CD... done
 # 2. Setup and update the repositories
 SOURCES_LIST="/etc/apt/sources.list"
@@ -199,19 +266,26 @@ swapoff --all
 # UEFI booting + boot pool + ZFS native encryption
 disk_format "$DISK"
 [ -n "$MIRROR" ] && disk_format "$MIRROR"
+sleep 5
 
-# 4. Create the boot pool
+# Check for partitions 3 and 4
-if [ -z "$MIRROR" ]; then
+disk_check "${DISK}${PARTSUFFIX}3"
-  create_boot_pool "$ZFSROOT" "${DISK}3"
+disk_check "${DISK}${PARTSUFFIX}4"
-else
+if [ -n "$MIRROR" ]; then
-  create_boot_pool "$ZFSROOT" "mirror ${DISK}3 ${MIRROR}3"
+	disk_check "${DISK}${PARTSUFFIX}3"
+	disk_check "${DISK}${PARTSUFFIX}4"
 fi
 
+# 4. Create the boot pool
 # 5. Create the root pool
 if [ -z "$MIRROR" ]; then
-  create_root_pool "$ZFSROOT" "${DISK}4" "$RPOOLPW"
+	create_boot_pool "$ZFSROOT" "${DISK}${PARTSUFFIX}3"
+	create_root_pool "$ZFSROOT" "${DISK}${PARTSUFFIX}4" "$RPOOLPW"
 else
-  create_root_pool "$ZFSROOT" "mirror ${DISK}4 ${MIRROR}4" "$RPOOLPW"
+	create_boot_pool "$ZFSROOT" \
+		"mirror ${DISK}${PARTSUFFIX}3 ${MIRROR}${PARTSUFFIX}3"
+	create_root_pool "$ZFSROOT" \
+		"mirror ${DISK}${PARTSUFFIX}4 ${MIRROR}${PARTSUFFIX}4" "$RPOOLPW"
 fi
 
 ###################################
@@ -299,28 +373,38 @@ deb http://deb.debian.org/debian ${CODENAME}-updates main contrib
 deb-src http://deb.debian.org/debian ${CODENAME}-updates main contrib
 EOF
 
-# 4. Bind the virtual filesystems from the LiveCD environment to the new system and chroot into it
+# Copy self and GRUB mirror helper script into chroot
-# Copy DISK/MIRROR vars under ZFSROOT
+if [ -n "$MIRROR" ]; then
-echo -e "DISK=${DISK}\nROOTPW=${ROOTPW}" > "$ZFSROOT/var/tmp/zfsenv"
+	cp "$0" "$ZFSROOT/usr/local/bin/debianzfs"
+	chmod +x "$ZFSROOT/usr/local/bin/debianzfs"
+	HELPER_SCRIPT="/root/MIRROR_GRUB_POSTINSTALL.sh"
+	cat <<-GRUBMIRROR > "${ZFSROOT}${HELPER_SCRIPT}"
+	#!/bin/bash
+	# Post-install GRUB mirror helper script
+	/usr/local/bin/debianzfs \
+		-gm ${MIRROR}${PARTSUFFIX}2 \
+		${DISK}${PARTSUFFIX}2
+	GRUBMIRROR
+fi
 
-# Bind
+# 4. Bind the virtual filesystems from the LiveCD environment to the new system and chroot into it
 mount --make-private --rbind /dev /mnt/dev
 mount --make-private --rbind /proc /mnt/proc
 mount --make-private --rbind /sys /mnt/sys
 
-# Chroot
+# Copy DISK/MIRROR vars under ZFSROOT and chroot
+echo -e "DISK=\"$DISK\"\nPARTSUFFIX=\"${PARTSUFFIX}\"\nROOTPW=\"${ROOTPW}\"" > "$ZFSROOT/var/tmp/zfsenv"
 cat << CHROOT | chroot /mnt bash --login
 # Setup
 export DEBIAN_FRONTEND=noninteractive
-export LC_CTYPE=en_US.UTF-8
-export LC_ALL=en_US.UTF-8
 set -ex
 . /var/tmp/zfsenv
+rm -f /var/tmp/zfsenv
 unset CDPATH
 cd
 
 # 5. Configure a basic system environment
-ln -s /proc/self/mounts /etc/mtab
+ln -fs /proc/self/mounts /etc/mtab
 apt-get update && apt-get upgrade -y
 apt-get install -y console-setup locales
 
@@ -336,9 +420,9 @@ echo REMAKE_INITRD=yes > /etc/dkms/zfs.conf
 # Install GRUB for UEFI booting
 apt-get install -y dosfstools
 
-mkdosfs -F 32 -s 1 -n EFI "\${DISK}2"
+mkdosfs -F 32 -s 1 -n EFI "\${DISK}\${PARTSUFFIX}2"
 mkdir /boot/efi
-BLKID_BOOT="/dev/disk/by-uuid/\$(blkid -s UUID -o value \${DISK}2)"
+BLKID_BOOT="/dev/disk/by-uuid/\$(blkid -s UUID -o value \${DISK}\${PARTSUFFIX}2)"
 echo "\${BLKID_BOOT} /boot/efi vfat defaults 0 0" >> /etc/fstab
 mount /boot/efi
 apt-get install -y grub-efi-amd64 shim-signed
@@ -403,7 +487,7 @@ update-grub
 # 6. Install the boot loader
 # For UEFI booting, install GRUB to the ESP
 grub-install --target=x86_64-efi --efi-directory=/boot/efi \
-						 --bootloader-id=debian --recheck --no-floppy
+	--bootloader-id=debian --recheck --no-floppy
 
 # 7. Fix filesystem mount ordering
 mkdir /etc/zfs/zfs-list.cache
@@ -432,9 +516,11 @@ CHROOT
 
 # 3. Run these commands in the LiveCD environment to unmount all filesystems
 mount | grep -v zfs | tac | awk '/\/mnt/ {print $3}' | \
-    xargs -I{} umount -lf {}
+	xargs -I{} umount -lf {}
 
 # 4. If this fails for rpool, mounting it on boot will fail and you will need to
 #    zpool import -f rpool, then exit in the initamfs prompt
 zpool export -a || exit 0
+[ -n "$HELPER_SCRIPT" ] && \
+	echo "NOTICE: A GRUB mirror helper script was placed at $HELPER_SCRIPT"
 exit 0

scripts/setup.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 sudo passwd -d user
-sudo chmod u+x /tmp/debianzfs.sh
+sudo chmod u+x /tmp/debianzfs