buildiso.sh

#!/usr/bin/env bash

# Generate a PVC autoinstaller ISO via live-build

# This ISO makes a number of assumptions about the system and asks
# minimal questions in order to streamline the install process versus
# using a standard Debian intaller ISO. The end system is suitable
# for immediate bootstrapping with the PVC Ansible roles.

fail() {
    echo "$@"
    exit 1
}

which lb &>/dev/null || fail "This script requires live-build"
sudo -n true &>/dev/null || fail "The user running this script must have sudo privileges."

idir=$( dirname $0 )
pushd ${idir} &>/dev/null

show_help() {
    echo -e "PVC install ISO generator"
    echo
    echo -e " Generates a mostly-automated installer ISO for a PVC node base system via lb."
    echo
    echo -e "Usage: $0 [-h] [-o <output_filename>] [-u username] [-a]"
    echo
    echo -e "   -h: Display this help message."
    echo -e "   -o: Create the ISO as <output_filename> instead of the default."
    echo -e "   -u: Change 'deploy' user to a new username."
    echo -e "   -c: Change CPU architecture to a new architecture [x86_64/aarch64]."
    echo -e "   -m: Change the mirror server (default 'https://ftp.debian.org/debian')."
    echo -e "   -a: Preserve live-build artifacts."
    echo -e "   -k: Preserve live-build config."
}

while [ $# -gt 0 ]; do
    case "${1}" in
        -h|\?)
            show_help
            exit 0
        ;;
        -o)
            isofilename="${2}"
            shift 2
        ;;
        -u)
            deployusername="${2}"
            shift 2
        ;;
        -c)
            current_arch=$( uname -m )
            if [[ ${current_arch} != ${2} ]]; then
                case ${2} in
                    x86_64)
                        arch="amd64"
                        arch_config_append="--architecture amd64 --bootloader grub-efi --bootstrap-qemu-arch amd64 --bootstrap-qemu-static /usr/bin/qemu-x86_64-static"
                    ;;
                    aarch64)
                        arch="arm64"
                        arch_config_append="--architecture arm64 --bootloader grub-efi --bootstrap-qemu-arch arm64 --bootstrap-qemu-static /usr/bin/qemu-aarch64-static"
                    ;;
                    *)
                        echo "Invalid arch: ${2}"
                        echo
                        show_help
                        exit 1
                    ;;
                esac  
            fi
            shift 2
        ;;
        -m)
            mirror_server="${2}"
            shift 2
        ;;
        -a)
            preserve_artifacts='y'
            shift
        ;;
        -k)
            preserve_livebuild='y'
            shift
        ;;
        *)
            echo "Invalid option: ${1}"
            echo
            show_help
            exit 1
        ;;
    esac
done

if [[ -z ${arch} ]]; then
    arch="amd64"
fi
if [[ -z ${isofilename} ]]; then
    isofilename="pvc-installer_$(date +%Y-%m-%d)_${arch}.iso"
fi
if [[ -z ${deployusername} ]]; then
    deployusername="deploy"
fi
if [[ -z ${mirror_server} ]]; then
    mirror_server="https://ftp.debian.org/debian"
fi

mkdir -p artifacts/lb
pushd artifacts/lb &>/dev/null

echo "Pre-cleaning live-build environment..."
sudo lb clean
echo

echo "Initializing config..."
# Initialize the live-build config
lb config \
       --distribution bookworm \
       --archive-areas "main contrib non-free-firmware" \
       --mirror-bootstrap "${mirror_server}" \
       --mirror-chroot-security "http://security.debian.org/debian-security" \
       --debconf-frontend readline \
       --apt-recommends false \
       --debian-installer netinst \
       --debian-installer-gui true \
       ${arch_config_append} || fail "Failed to initialize live-build config"
echo

# Configure the package lists
echo -n "Copying package lists... "
cp ../../templates/installer.list.chroot config/package-lists/installer.list.chroot || fail "Failed to copy critical template file"
cp ../../templates/installer_${arch}.list.chroot config/package-lists/installer_${arch}.list.chroot || fail "Failed to copy critical template file"
cp ../../templates/firmware.list.chroot config/package-lists/firmware.list.chroot || fail "Failed to copy critical template file"
echo "done."

# Add root password hook
echo -n "Copying live-boot templates... "
mkdir -p config/includes.chroot/etc/live/config.conf.d
cat <<EOF > config/includes.chroot/etc/live/config.conf.d/noeject.conf
noeject
EOF
mkdir -p config/includes.chroot/lib/live/boot/
cp ../../templates/9990-initramfs-tools.sh config/includes.chroot/lib/live/boot/9990-initramfs-tools.sh || fail "Failed to copy critical template file"
chmod +x config/includes.chroot/lib/live/boot/9990-initramfs-tools.sh || fail "Failed to copy critical template file"
mkdir -p config/includes.chroot/lib/live/config/
cp ../../templates/2000-remove-root-pw.sh config/includes.chroot/lib/live/config/2000-remove-root-pw.sh || fail "Failed to copy critical template file"
chmod +x config/includes.chroot/lib/live/config/2000-remove-root-pw.sh || fail "Failed to copy critical template file"
echo "done."

# Set root bashrc
echo -n "Copying root bashrc template... "
mkdir -p config/includes.chroot/root
cp ../../templates/root.bashrc config/includes.chroot/root/.bashrc || fail "Failed to copy critical template file"
echo "done."

# Set hostname and resolv.conf
echo -n "Copying networking templates... "
mkdir -p config/includes.chroot/etc
cp ../../templates/hostname config/includes.chroot/etc/hostname || fail "Failed to copy critical template file"
cp ../../templates/resolv.conf config/includes.chroot/etc/resolv.conf || fail "Failed to copy critical template file"
echo "done."

# Set single vty and autologin
echo -n "Copying getty templates... "
mkdir -p config/includes.chroot/etc/systemd/
cp ../../templates/logind.conf config/includes.chroot/etc/systemd/logind.conf || fail "Failed to copy critical template file"
mkdir -p config/includes.chroot/etc/systemd/system/getty@.service.d
cp ../../templates/getty-override.conf  config/includes.chroot/etc/systemd/system/getty@.service.d/override.conf || fail "Failed to copy critical template file"
mkdir -p config/includes.chroot/etc/systemd/system/serial-getty@.service.d
cp ../../templates/serial-getty-override.conf config/includes.chroot/etc/systemd/system/serial-getty@.service.d/override.conf || fail "Failed to copy critical template file"
echo "done."

# Install GRUB config, theme, and splash
echo -n "Copying bootloader (GRUB) templates... "
cp -a /usr/share/live/build/bootloaders/grub-pc config/bootloaders/ || fail "Failed to copy grub-pc bootloader config from host system"
cp ../../templates/grub.cfg config/bootloaders/grub-pc/grub.cfg || fail "Failed to copy critical template file"
cp ../../templates/theme.txt config/bootloaders/grub-pc/live-theme/theme.txt || fail "Failed to copy critical template file"
cp ../../templates/splash.png config/bootloaders/grub-pc/splash.png || fail "Failed to copy critical template file"
echo "done."

# Install module blacklist template
echo -n "Copying module blacklist template... "
mkdir -p config/includes.chroot/etc/modprobe.d
cp ../../templates/blacklist.conf config/includes.chroot/etc/modprobe.d/blacklist.conf || fail "Failed to copy critical template file"
echo "done."

# Install module initramfs requirements (Broadcom NICs)
echo -n "Copying initramfs modules template... "
mkdir -p config/includes.chroot/etc/initramfs-tools
cp ../../templates/modules config/includes.chroot/etc/initramfs-tools/modules || fail "Failed to copy critical template file"
echo "done."

# Install install.sh and detect.py scripts
echo -n "Copying PVC node installer script template... "
cp ../../templates/install.sh config/includes.chroot/install.sh || fail "Failed to copy critical template file"
chmod +x config/includes.chroot/install.sh
cp ../../templates/detect.py config/includes.chroot/detect.py || fail "Failed to copy critical template file"
chmod +x config/includes.chroot/detect.py
echo "done."

# Customize install.sh script
echo -n "Customizing PVC node installer script... "
sed -i "s/XXDATEXX/$(date)/g" config/includes.chroot/install.sh
sed -i "s/XXDEPLOYUSERXX/${deployusername}/g" config/includes.chroot/install.sh
echo "done."
echo

# Build the live image
echo "Building live image..."
sudo lb build || fail "Failed to build live image"
echo

# Move the ISO image out
echo -n "Copying generated ISO to repository root... "
cp live-image-${arch}.hybrid.iso ../../${isofilename}
echo "done."

# Clean up the artifacts
if [[ -z ${preserve_artifacts} ]]; then
    echo "Cleaning live-build environment..."
    sudo lb clean
fi

popd &>/dev/null

# Clean up the config
if [[ -z ${preserve_livebuild} ]]; then
    echo -n "Removing artifacts... "
    sudo rm -rf artifacts/lb
    echo "done."
fi

echo
echo "Build completed. ISO file: ${isofilename}"

popd &>/dev/null