prox-cloud-template-add.sh

#!/bin/bash

# NOTE: Requires apt-get install libguestfs-tools

Black='\033[0;30m'
DarkGray='\033[1;30m'
Red='\033[0;31m'
LightRed='\033[1;31m'
Green='\033[0;32m'
LightGreen='\033[1;32m'
Brown='\033[0;33m'
Yellow='\033[1;33m'
Blue='\033[0;34m'
LightBlue='\033[1;34m'
Purple='\033[0;35m'
LightPurple='\033[1;35m'
Cyan='\033[0;36m'
LightCyan='\033[1;36m'
LightGray='\033[0;37m'
White='\033[1;37m'
NC='\033[0m' # No Color

Name='ProxMox / Ubuntu Cloud Init Image Creation Utility (PUCIICU)'
Version='v1.0.0-alpha.4'

echo -e "${LightPurple}$Name $Version${NC}"
echo ""

if [[ "$1" == "" || $1 == "?" || $1 == "/?" || $1 == "--help" ]];
then
    echo -e "USAGE: sudo $0 [id] [storage] [distro] [version] [user] [password] \
        [searchdomain] [launchpadid]\n\n\tsudo $0 4000 SSD-01A focal sysadmin \
        G00dPazz22 intranet.example.com jdoe\n"
    exit -2
fi

if [[ $(whoami) != "root" ]];
then
    echo -e "ERROR: This utility must be run as root (or sudo)."
    exit -1
fi

# [id] [storage] [distro] [version] [user] [password]

if [ ! -z "$1" ] ; then
    VM_ID="$1"
else
    echo -e "ERROR: [id] missing. (ex.: 101)\n"
    exit -1
fi
if [ ! -z "$2" ] ; then
    STORAGE_NAME="$2"
else
    echo -e "ERROR: [storage] missing. (ex.: SSD-01A)\n"
    exit -1
fi
if [ ! -z "$3" ] ; then
    UBUNTU_DISTRO="$3"
else
    echo -e "ERROR: [distro] missing. (ex.: bionic, focal, jammy, etc)\n"
    exit -1
fi
if [ ! -z "$4" ] ; then
    UBUNTU_VERSION="$4"
else
    echo -e "ERROR: [version] missing. (ex.: 22.04, 20.04, etc)\n"
    exit -1
fi
if [ ! -z "$5" ] ; then
    STD_USER_NAME="$5"
else
    echo -e "ERROR: [user] missing. (ex.: sysadmin)\n"
    exit -1
fi
if [ ! -z "$6" ] ; then
    STD_USER_PASSWORD="$6"
else
    echo -e "ERROR: [password] missing. (ex.: P4zzw0rd!)\n"
    exit -1
fi
if [ ! -z "$7" ] ; then
    SEARCH_DOMAIN="$7"
else
    echo -e "ERROR: [searchdomain] missing. (ex.: intranet.example.com)\n"
    exit -1
fi
if [ ! -z "$8" ] ; then
    LAUNCHPAD_ID="$8"
else
    echo -e "ERROR: [launchpadid] missing. (ex.: jdoe)\n"
    exit -1
fi

if [[ "${UBUNTU_VERSION}" == "16.04" ]] ; then
    IMAGE_FILE="${UBUNTU_DISTRO}-server-cloudimg-amd64-disk1.img"
else
    IMAGE_FILE="${UBUNTU_DISTRO}-server-cloudimg-amd64.img"
fi

MEM_SIZE="4096"
CORES="4"
DISK_SIZE="60G"
SSH_KEYS="./keys"
IMAGE_URL="https://cloud-images.ubuntu.com/${UBUNTU_DISTRO}/current/${IMAGE_FILE}"
HASH_URL="https://cloud-images.ubuntu.com/${UBUNTU_DISTRO}/current/SHA256SUMS"
HASH_FILE="${UBUNTU_DISTRO}_SHA256SUMS"

echo ""
echo "VM_ID................: $VM_ID"
echo "UBUNTU_DISTRO........: $UBUNTU_DISTRO"
echo "UBUNTU_VERSION.......: $UBUNTU_VERSION"
echo "STORAGE_NAME.........: $STORAGE_NAME"
echo "IMAGE_FILE...........: $IMAGE_FILE"
echo "IMAGE_URL............: $IMAGE_URL"
echo "HASH_URL.............: $HASH_URL"
echo "HASH_FILE............: $HASH_FILE"
echo "STD_USER_NAME........: $STD_USER_NAME"
echo "STD_USER_PASSWORD....: $STD_USER_PASSWORD"
echo "SEARCH_DOMAIN........: $SEARCH_DOMAIN"
echo "LAUNCHPAD_ID.........: $LAUNCHPAD_ID"
echo ""

function setStatus(){

    description=$1
    severity=$2

    logger "$Name $Version: [${severity}] $description"


    case "$severity" in
        s)
            echo -e "[${LightGreen}+${NC}] ${LightGreen}${description}${NC}"
        ;;
        f)
            echo -e "[${Red}-${NC}] ${LightRed}${description}${NC}"
        ;;
        q)
            echo -e "[${LightPurple}?${NC}] ${LightPurple}${description}${NC}"
        ;;
        *)
            echo -e "[${LightCyan}*${NC}] ${LightCyan}${description}${NC}"
        ;;
    esac

    [[ $WithVoice -eq 1 ]] && echo -e ${description} | espeak
}

function runCommand(){

    beforeText=$1
    afterText=$2
    commandToRun=$3

    setStatus "${beforeText}" "s"

    eval $commandToRun

    setStatus "$afterText" "s"

}

setStatus "STEP 1: Get Ubuntu Cloud image and SHA256 hash" "*"

HASHES_MATCH=-1
ATTEMPT=0

while [ $HASHES_MATCH -lt 1 ]
do

    ATTEMPT=$(($ATTEMPT+1))

    setStatus "Checking to see if '${IMAGE_FILE}-orig' has been downloaded (attempt: $ATTEMPT)..." "*"
    if [ ! -f ./${IMAGE_FILE}-orig ]; then
        setStatus " - File not found." "f"
        setStatus " - Downloading file from internet (${IMAGE_URL})..." "*"

        if wget ${IMAGE_URL} -v --output-document=${IMAGE_FILE}-orig ; then
            setStatus " - Complete." "s"
        else
            setStatus " - Download failed." "f"
            #exit -2
        fi
    else
        setStatus " - File found." "s"
        if [ "$HASHES_MATCH" -eq "0" ]; then
            setStatus " - SHA256 hashes do not match. File is invalid." "f"
            setStatus " - Downloading file from internet and overwriting invalid, local file (${IMAGE_URL})..." "*"
            if wget ${IMAGE_URL} -v --output-document=${IMAGE_FILE}-orig ; then
                setStatus " - Complete." "s"
            else
                setStatus " - Download failed." "f"
            fi
        fi
    fi

    setStatus "Generating SHA256 hash from the file on-disk..." "*"
    SHA256_HASH_ONDISK=`sha256sum ./${IMAGE_FILE}-orig | cut -d ' ' -f1`
    setStatus " - Done: $SHA256_HASH_ONDISK" "s"

    setStatus "Downloading SHA256 sums from Ubuntu (${HASH_URL})..." "*"
    if wget -q -N ${HASH_URL} --output-document=${HASH_FILE} ; then
        setStatus " - Extracting SHA256 hash from Ubuntu (${HASH_FILE})..." "*"
        SHA256_HASH_FROMINET=`grep "${IMAGE_FILE}" ./${HASH_FILE} | cut -d ' ' -f1`
        setStatus " - Done: $SHA256_HASH_FROMINET" "s"
    else
        setStatus " - Download of SHA245 hashes failed." "f"
        exit -2
    fi

    setStatus "Comparing SHA256 hashes..." "*"
    if [[ "$SHA256_HASH_ONDISK" != "$SHA256_HASH_FROMINET" ]]; then
        HASHES_MATCH=0
        setStatus " - Hashes do NOT match. Retrying..." "f"
    else
        HASHES_MATCH=1
        setStatus " - Hashes match." "s"
    fi

    if [ $ATTEMPT -gt 3 ]; then
        setStatus "FATAL: Can't seem to download a valid image and confirm the \
            SHA256 hash after 3 attempts. Cannot continue." "f"
        exit -1
    fi

done

cp ./${IMAGE_FILE}-orig ./${IMAGE_FILE}

setStatus "STEP 1b: Purge existing VM template (${VM_ID}) if it already exists."
if qm destroy ${VM_ID} --purge ; then
    setStatus " - Successfully deleted." "s"
else
    setStatus " - No existing template found." "s"
fi

setStatus "STEP 1c: Configure VM template with software."
if virt-customize -a ./${IMAGE_FILE} --install qemu-guest-agent,figlet,neofetch,ufw,fail2ban \
    --run-command "cat /dev/null > /etc/machine-id"; then
    setStatus " - Successfully installed." "s"
else
    setStatus " - Unable to install software into image file ./${IMAGE_FILE}." "s"
fi

setStatus "STEP 2: Create a virtual machine" "*"
if qm create ${VM_ID} --memory ${MEM_SIZE} --name ubuntu-cloud-${UBUNTU_DISTRO} \
    --net0 virtio,bridge=vmbr0 --tags cloud-image,ubuntu,ubuntu-${UBUNTU_VERSION},ubuntu-${UBUNTU_DISTRO} ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "STEP 3: Import the disk into the proxmox storage, into '${STORAGE_NAME}' in this case."
if qm importdisk ${VM_ID} ./${IMAGE_FILE} ${STORAGE_NAME} ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "STEP 4: Add the new, imported disk to the VM."

# check storage type before trying to access this disk in the appropriate syntax
STORAGE_TYPE=$(pvesm status --storage ${STORAGE_NAME} | awk 'NR == 2 {print $2}')
if [ "$STORAGE_TYPE" = "dir" ]; then
  setStatus " - Storage type 'Directory' detected."
  IMPORTED_DISKFILE=${STORAGE_NAME}:${VM_ID}/vm-${VM_ID}-disk-0.raw
  rm ${IMPORTED_DISKFILE}
elif [ "$STORAGE_TYPE" = "lvm" ]; then
  setStatus " - Storage type 'LVM' detected."
  IMPORTED_DISKFILE=${STORAGE_NAME}:vm-${VM_ID}-disk-0
  lvremove ${IMPORTED_DISKFILE}
elif [ "$STORAGE_TYPE" = "lvmthin" ]; then
  setStatus " - Storage type 'LVM-Thin' detected."
  IMPORTED_DISKFILE=${STORAGE_NAME}:vm-${VM_ID}-disk-0
  lvremove ${IMPORTED_DISKFILE}
elif [ "$STORAGE_TYPE" = "zfspool" ]; then
  setStatus " - Storage type 'ZFS Pool' detected."
  IMPORTED_DISKFILE=${STORAGE_NAME}:vm-${VM_ID}-disk-0
  zfs destroy ${IMPORTED_DISKFILE}
else
  setStatus " - Storage type not detected. Defaulting to treating as Directory storage."
  IMPORTED_DISKFILE=${STORAGE_NAME}:${VM_ID}/vm-${VM_ID}-disk-0.raw
fi
sleep 1


if qm set ${VM_ID} --scsihw virtio-scsi-pci --scsi0 ${IMPORTED_DISKFILE} ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "STEP 5: Add a CD-ROM."
if qm set ${VM_ID} --ide2 ${STORAGE_NAME}:cloudinit ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "STEP 6: Specify the boot disk."
if qm set ${VM_ID} --boot c --bootdisk scsi0 ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

# I don't think this is needed? Still evaluating.
#setStatus "STEP 7: Add support for VNC and a serial console."
#if qm set ${VM_ID} --serial0 socket --vga serial0 ; then
#    setStatus " - Success." "s"
#else
#    setStatus " - Error completing step." "f"
#    exit -1
#fi

setStatus "STEP 8: Retrieve SSH keys from LaunchPad for: ${LAUNCHPAD_ID}..."
if wget https://launchpad.net/~${LAUNCHPAD_ID}/+sshkeys -O ./keys ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "STEP 9: Set other template variables..."
if qm set ${VM_ID} --ciuser ${STD_USER_NAME} --cipassword ${STD_USER_PASSWORD} \
    --cores ${CORES} --searchdomain ${SEARCH_DOMAIN} --sshkeys ${SSH_KEYS} \
    --description "Virtual machine based on the Ubuntu '${UBUNTU_DISTRO}' Cloud \
    image. Last generated: `date`" --ipconfig0 ip=dhcp --onboot 1 --ostype l26 --agent 1 ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "STEP 10: Resize boot disk to ${DISK_SIZE}B"

ATTEMPT=0
while [ $ATTEMPT -lt 5 ];
do
    ATTEMPT=$(($ATTEMPT + 1))

    if qm resize ${VM_ID} scsi0 ${DISK_SIZE} ; then
        setStatus " - Success." "s"
        ATTEMPT=100
    else
        if [ $ATTEMPT -lt 5 ] ; then
            setStatus " - Error executing step. Retrying..." "f"
        else
            setStatus " - Error completing step." "f"
            exit -1
        fi
    fi
done
setStatus " - Refreshing view of drives, and waiting for I/O to catch up..."
qm rescan --vmid ${VM_ID}

setStatus "STEP 11: Convert VM to a template"
if qm template ${VM_ID} ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

setStatus "Cleaning up..."
if rm ./keys ; then
    setStatus " - Success." "s"
else
    setStatus " - Error completing step." "f"
    exit -1
fi

echo "======================================================================"
echo "S U M M A R Y"
echo "======================================================================"
echo "New VM template based on Ubuntu '$UBUNTU_DISTRO' was created as VM_ID"
echo "$VM_ID on ProxMox server `hostname`. It has $CORES CPU cores and ${MEM_SIZE}"
echo "of RAM. The primary '/' mount point has ${DISK_SIZE} of space. Login with:"
echo ""
echo "  User......: $STD_USER_NAME"
echo "  Password..: $STD_USER_PASSWORD"
echo ""
echo "======================================================================"
echo "T E M P L A T E  C O N F I G"
echo "======================================================================"
qm config ${VM_ID} | grep -v sshkeys | column -t -s' '
echo ""
echo "======================================================================"
echo "D I S K  S P A C E"
echo "======================================================================"
echo "Ubuntu cloud images are using the following amount of space:"
echo ""
du -chs ./*.img
echo ""
echo "Available on the / mount point:"
TOTAL=`df -h | grep "/$" | xargs | cut -d ' ' -f2`
FREE=`df -h | grep "/$" | xargs | cut -d ' ' -f4`
USED=`df -h | grep "/$" | xargs | cut -d ' ' -f3`
USED_PCT=`df -h | grep "/$" | xargs | cut -d ' ' -f5`
echo -e "Total: Used: Avail: Used%\n$TOTAL $USED $FREE $USED_PCT" | column -t -s' '