Replace old buildiso.sh with live-build script

The old script was cumbersome and complex. Replace it with a script that
leverages the Debian live-build (lb) framework to simplify the script
and configuration as well as minimize sprawl in the final image (~40MB
savings).
This commit is contained in:
Joshua Boniface 2021-12-04 02:19:13 -05:00
parent e3d3cbe6fa
commit f858d03ff9
1 changed files with 89 additions and 162 deletions

View File

@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# Generate a PVC autoinstaller ISO # Generate a PVC autoinstaller ISO via live-build
# This ISO makes a number of assumptions about the system and asks # This ISO makes a number of assumptions about the system and asks
# minimal questions in order to streamline the install process versus # minimal questions in order to streamline the install process versus
@ -12,14 +12,8 @@ fail() {
exit 1 exit 1
} }
fail="" which lb &>/dev/null || fail "This script requires live-build"
which debootstrap &>/dev/null || fail="y" sudo -n true &>/dev/null || fail "The user running this script must have sudo privileges."
which mksquashfs &>/dev/null || fail="y"
which xorriso &>/dev/null || fail="y"
test -f /usr/lib/ISOLINUX/isohdpfx.bin &>/dev/null || fail="y"
if [[ -n ${fail} ]]; then
fail "This script requires debootstrap, xorriso, squashfs-tools, and isolinux"
fi
isofilename="pvc-installer_$(date +%Y-%m-%d).iso" isofilename="pvc-installer_$(date +%Y-%m-%d).iso"
deployusername="deploy" deployusername="deploy"
@ -27,26 +21,18 @@ deployusername="deploy"
show_help() { show_help() {
echo -e "PVC install ISO generator" echo -e "PVC install ISO generator"
echo echo
echo -e " Generates a mostly-automated installer ISO for a PVC node base system. The ISO" echo -e " Generates a mostly-automated installer ISO for a PVC node base system via lb."
echo -e " boots, then runs 'install.sh' to perform the installation to a target server."
echo -e " This script prompts for a few questions on startup to configure the system, then"
echo -e " performs the remaining installation to PVC node specifications unattended,"
echo -e " including configuring networking on the selected interface, wiping the selected"
echo -e " disk, partitioning, installing the base OS, and performing some initial"
echo -e " configuration to allow the PVC Ansible role to take over after completion."
echo echo
echo -e "Usage: $0 [-h] [-o <output_filename>] [-s <liveiso_source_url>] [-a] [-u username]" echo -e "Usage: $0 [-h] [-o <output_filename>] [-u username] [-a]"
echo echo
echo -e " -h: Display this help message." echo -e " -h: Display this help message."
echo -e " -o: Create the ISO as <output_filename> instead of the default." echo -e " -o: Create the ISO as <output_filename> instead of the default."
echo -e " -s: Obtain the source Debian Live ISO from <liveiso_source_url> instead of"
echo -e " the default."
echo -e " -a: Use cached squashfs artifact during rebuild (cached ISO and debootstrap"
echo -e " artifacts are always used)."
echo -e " -u: Change 'deploy' user to a new username." echo -e " -u: Change 'deploy' user to a new username."
echo -e " -a: Preserve live-build artifacts."
echo -e " -k: Preserve live-build config."
} }
while getopts "h?o:s:au:" opt; do while getopts "h?o:u:ak" opt; do
case "$opt" in case "$opt" in
h|\?) h|\?)
show_help show_help
@ -55,161 +41,102 @@ while getopts "h?o:s:au:" opt; do
o) o)
isofilename=$OPTARG isofilename=$OPTARG
;; ;;
s)
srcliveisourl=$OPTARG
;;
a)
usecachedsquashfs='y'
;;
u) u)
deployusername=$OPTARG deployusername=$OPTARG
;; ;;
a)
preserve_artifacts='y'
;;
k)
preserve_livebuild='y'
;;
esac esac
done done
srcliveisopath="https://cdimage.debian.org/mirror/cdimage/release/current-live/amd64/iso-hybrid" PACKAGE_LIST_MAIN="live-tools linux-image-amd64 mdadm lvm2 parted gdisk debootstrap grub-pc-bin grub-efi-amd64 sipcalc vim ca-certificates vlan"
srcliveisofilename="$( wget -O- ${srcliveisopath}/ 2>/dev/null | grep 'debian-live-.*-amd64-standard.iso' | awk -F '"' '{ print $6 }' )" PACKAGE_LIST_NONFREE="firmware-bnx2 firmware-bnx2x"
srcliveisourl="${srcliveisopath}/${srcliveisofilename}"
srcliveisofile="$( basename ${srcliveisourl} )"
tempdir=$( mktemp -d ) mkdir -p artifacts/lb
pushd artifacts/lb
cleanup() { # Initialize the live-build config
echo -n "Cleaning up... " lb config --distribution buster --architectures amd64 --archive-areas "main contrib non-free" --apt-recommends false
sudo rm -rf ${tempdir} &>/dev/null
echo "done."
echo
}
fail() { # Configure the "standard" live task (no GUI)
echo $@ echo "live-task-standard" > config/package-lists/desktop.list.chroot
cleanup
exit 1
}
prepare_iso() { # Add additional live packages
echo -n "Creating temporary directories... " echo ${PACKAGE_LIST_MAIN} > config/package-lists/installer.list.chroot
if [[ ! -d artifacts ]]; then echo ${PACKAGE_LIST_NONFREE} > config/package-lists/nonfree.list.chroot
mkdir artifacts &>/dev/null || fail "Error creating artifacts directory."
fi
mkdir ${tempdir}/rootfs/ ${tempdir}/installer/ &>/dev/null || fail "Error creating temporary directories."
echo "done."
echo -n "Downloading Debian Live ISO... " # Add root password hook
if [[ ! -f artifacts/${srcliveisofile} ]]; then mkdir -p config/includes.chroot/lib/live/config/
wget -O artifacts/${srcliveisofile} ${srcliveisourl} &>/dev/null || { rm -f artifacts/${srcliveisofile}; fail "Error downloading source ISO."; } cat <<EOF > config/includes.chroot/lib/live/config/2000-remove-root-pw
echo "done." #!/bin/sh
else echo "I: remove root password"
echo "using cached file 'artifacts/${srcliveisofile}'." passwd --delete root
fi EOF
chmod +x config/includes.chroot/lib/live/config/2000-remove-root-pw
echo -n "Extracting Debian Live ISO files... " # Set root bashrc
iso_tempdir=$( mktemp -d ) mkdir -p config/includes.chroot/root
sudo mount artifacts/${srcliveisofile} ${iso_tempdir} &>/dev/null || fail "Error mounting Live ISO file." echo "/install.sh" > config/includes.chroot/root/.bashrc
sudo rsync -a --exclude live/filesystem.squashfs --exclude isolinux/menu.cfg --exclude isolinux/stdmenu.cfg ${iso_tempdir}/ ${tempdir}/installer/ &>/dev/null || fail "Error extracting Live ISO files."
sudo umount ${iso_tempdir} &>/dev/null || fail "Error unmounting Live ISO file."
rmdir ${iso_tempdir} &>/dev/null
echo "done."
}
prepare_rootfs() { # Set hostname and resolv.conf
echo -n "Preparing Debian live installation via debootstrap... " mkdir -p config/includes.chroot/etc
SQUASHFS_PKGLIST="mdadm,lvm2,parted,gdisk,debootstrap,grub-pc,grub-efi-amd64,linux-image-amd64,sipcalc,live-boot,dosfstools,vim,ca-certificates,vlan" echo "pvc-live-installer" > config/includes.chroot/etc/hostname
if [[ ! -d artifacts/debootstrap ]]; then echo "nameserver 8.8.8.8" > config/includes.chroot/etc/resolv.conf
sudo mkdir -p artifacts/debootstrap/var/cache/apt/archives &>/dev/null
clean_me="y"
sudo mount --bind /var/cache/apt/archives artifacts/debootstrap/var/cache/apt/archives &>/dev/null && clean_me=""
sudo /usr/sbin/debootstrap \
--include=${SQUASHFS_PKGLIST} \
buster \
artifacts/debootstrap/ \
http://ftp.ca.debian.org/debian &>debootstrap.log || fail "Error performing debootstrap."
# Grab some additional files in non-free
sudo wget http://ftp.ca.debian.org/debian/pool/non-free/f/firmware-nonfree/firmware-bnx2_20190114-2_all.deb -O artifacts/debootstrap/var/cache/apt/archives/firmware-bnx2_20190114-2_all.deb
sudo chroot artifacts/debootstrap/ dpkg -i /var/cache/apt/archives/firmware-bnx2_20190114-2_all.deb || fail "Error installing supplemental package firmware-bnx2"
sudo wget http://ftp.ca.debian.org/debian/pool/non-free/f/firmware-nonfree/firmware-bnx2x_20190114-2_all.deb -O artifacts/debootstrap/var/cache/apt/archives/firmware-bnx2x_20190114-2_all.deb
sudo chroot artifacts/debootstrap/ dpkg -i /var/cache/apt/archives/firmware-bnx2x_20190114-2_all.deb || fail "Error installing supplemental package firmware-bnx2x"
if [[ -n ${clean_me} ]]; then
sudo chroot artifacts/debootstrap/ apt clean &>/dev/null || fail "Error cleaning apt cache in debootstrap."
else
sudo umount artifacts/debootstrap/var/cache/apt/archives &>/dev/null
fi
sudo rsync -au artifacts/debootstrap/ ${tempdir}/rootfs/ &>/dev/null || fail "Error copying debootstrap to tempdir."
echo "done."
else
sudo rsync -au artifacts/debootstrap/ ${tempdir}/rootfs/ &>/dev/null || fail "Error copying debootstrap to tempdir."
echo "using cached debootstrap 'artifacts/debootstrap'."
fi
echo -n "Configuring Debian live installation... " # Set single vty
sudo cp -a artifacts/debootstrap/boot/vmlinuz* ${tempdir}/installer/live/vmlinuz &>/dev/null || fail "Error copying kernel." mkdir -p config/includes.chroot/etc/systemd/
sudo cp -a artifacts/debootstrap/boot/initrd.img* ${tempdir}/installer/live/initrd.img &>/dev/null || fail "Error copying initrd." cat <<EOF > config/includes.chroot/etc/systemd/logind.conf
sudo cp ${tempdir}/rootfs/lib/systemd/system/getty\@.service ${tempdir}/rootfs/etc/systemd/system/getty@tty1.service &>/dev/null || fail "Error copying getty override to tempdir." [Login]
sudo sed -i 's|/sbin/agetty|/sbin/agetty --autologin root|g' \ NAutoVTs=2
${tempdir}/rootfs/etc/systemd/system/getty@tty1.service &>/dev/null || fail "Error setting autologin in getty override." EOF
sudo tee ${tempdir}/rootfs/etc/hostname <<<"pvc-node-installer" &>/dev/null || fail "Error setting hostname."
sudo tee ${tempdir}/rootfs/etc/resolv.conf <<<"nameserver 8.8.8.8" &>/dev/null || fail "Error setting resolv.conf"
sudo tee -a ${tempdir}/rootfs/root/.bashrc <<<"/install.sh" &>/dev/null || fail "Error setting bashrc."
sudo chroot ${tempdir}/rootfs/ /usr/bin/passwd -d root &>/dev/null || fail "Error disabling root password."
sudo cp install.sh ${tempdir}/rootfs/ &>/dev/null || fail "Error copying install.sh to tempdir."
sudo sed -i "s/XXISOXX/${isofilename}/g" ${tempdir}/rootfs/install.sh &>/dev/null || fail "Error editing install.sh script."
sudo sed -i "s/XXDEPLOYUSERXX/${deployusername}/g" ${tempdir}/rootfs/install.sh &>/dev/null || fail "Error editing install.sh script."
echo "done."
echo -n "Generating squashfs image of live installation... " mkdir -p config/includes.chroot/etc/systemd/system/getty@.service.d
if [[ ! -f artifacts/filesystem.squashfs || -z ${usecachedsquashfs} ]]; then cat <<EOF > config/includes.chroot/etc/systemd/system/getty@.service.d/override.conf
if [[ -f artifacts/filesystem.squashfs ]]; then [Service]
rm -f artifacts/filesystem.squashfs &>/dev/null ExecStart=
fi ExecStart=-/sbin/agetty -o '-p -- \\\u' --autologin root --noclear %I \$TERM
sudo nice mksquashfs ${tempdir}/rootfs/ artifacts/filesystem.squashfs -e boot &>/dev/null || fail "Error generating squashfs." EOF
sudo rsync -a artifacts/filesystem.squashfs ${tempdir}/installer/live/filesystem.squashfs &>/dev/null || fail "Error copying squashfs to tempdir."
echo "done."
else
sudo rsync -a artifacts/filesystem.squashfs ${tempdir}/installer/live/filesystem.squashfs &>/dev/null || fail "Error copying squashfs to tempdir."
echo "using cached squashfs 'artifacts/filesystem.squashfs'."
fi
}
build_iso() { mkdir -p config/includes.chroot/etc/systemd/system/serial-getty@.service.d
echo -n "Copying live boot configurations... " cat <<EOF > config/includes.chroot/etc/systemd/system/serial-getty@.service.d/override.conf
sudo cp -a grub.cfg ${tempdir}/installer/boot/grub/grub.cfg &>/dev/null || fail "Error copying grub.cfg file." [Service]
sudo cp -a theme.txt ${tempdir}/installer/boot/grub/theme.txt &>/dev/null || fail "Error copying theme.txt file." ExecStart=
sudo cp -a isolinux.cfg ${tempdir}/installer/isolinux/isolinux.cfg &>/dev/null || fail "Error copying isolinux.cfg file." ExecStart=-/sbin/agetty -o '-p -- \\\u' --autologin root --noclear --keep-baud 115200,38400,9600 %I \$TERM
sudo cp -a splash.png ${tempdir}/installer/splash.png &>/dev/null || fail "Error copying splash.png file." EOF
echo "done."
echo -n "Creating LiveCD ISO... " # Install GRUB config, theme, and splash
pushd ${tempdir}/installer &>/dev/null mkdir -p config/includes.chroot/boot/grub
xorriso \ cp ../../grub.cfg config/includes.chroot/boot/grub/grub.cfg
-as mkisofs \ cp ../../theme.txt config/includes.chroot/boot/grub/theme.txt
-iso-level 3 \ cp ../../splash.png config/includes.chroot/splash.png
-o ../${isofilename} \
-full-iso9660-filenames \
-volid "PVC_NODE_INSTALLER" \
-isohybrid-mbr /usr/lib/ISOLINUX/isohdpfx.bin \
-eltorito-boot \
isolinux/isolinux.bin \
-no-emul-boot \
-boot-load-size 4 \
-boot-info-table \
--eltorito-catalog isolinux/isolinux.cat \
-eltorito-alt-boot \
-e boot/grub/efi.img \
-no-emul-boot \
-isohybrid-gpt-basdat \
-append_partition 2 0xef boot/grub/efi.img \
. &>/dev/null || fail "Error creating ISO file."
popd &>/dev/null
echo "done."
echo -n "Moving generated ISO to './${isofilename}'... " # Install install.sh script
mv -f ${tempdir}/${isofilename} ${isofilename} &>/dev/null || fail "Error moving ISO file." cp ../../install.sh config/includes.chroot/install.sh
echo "done." chmod +x config/includes.chroot/install.sh
}
prepare_iso # Customize install.sh script
prepare_rootfs sed -i "s/XXDATEXX/$(date)/g" config/includes.chroot/install.sh
build_iso sed -i "s/XXDEPLOYUSERXX/${deployusername}/g" config/includes.chroot/install.sh
cleanup
# Build the live image
sudo lb build
# Move the ISO image out
cp live-image-amd64.hybrid.iso ../../${isofilename}
# Clean up the artifacts
if [[ -z ${preserve_artifacts} ]]; then
sudo lb clean
fi
popd
# Clean up the config
if [[ -z ${preserve_livebuild} ]]; then
sudo rm -rf artifacts/lb
fi
echo "PVC Live Installer ISO generation complete."