Debian: Added support for versions 10, 11 and 12 (#162)

Added experimental support for Debian 10 (Buster), 11 (Bullseye) & 12
(Bookworm).

Closes #24

README.md

@@ -16,6 +16,9 @@ Read more about how [custom images](https://maas.io/docs/how-to-customise-images
 | CentOS 7        | Stable             | >= 2.3           |
 | CentOS 8        | EOL                | >= 2.7           |
 | CentOS 8 Stream | Beta               | >= 3.2           |
+| Debian 10       | Beta               | >= 3.3           |
+| Debian 11       | Beta               | >= 3.3           |
+| Debian 12       | Beta               | >= 3.3           |
 | OL8             | Beta               | >= 3.5           |
 | OL9             | Beta               | >= 3.5           |
 | RHEL 7          | EOL                | >= 2.3           |

debian/Makefile

@@ -0,0 +1,67 @@
+#!/usr/bin/make -f
+
+include ../scripts/check.mk
+
+PACKER ?= packer
+PACKER_LOG ?= 0
+export PACKER_LOG
+
+SERIES ?= bullseye
+BOOT ?= uefi
+ARCH ?= amd64
+
+ifeq ($(strip $(SERIES)),buster)
+	VERSION = 10
+else ifeq ($(strip $(SERIES)),bullseye)
+	VERSION = 11
+else ifeq ($(strip $(SERIES)),bookworm)
+	VERSION = 12
+else
+	VERSION = 11
+endif
+
+# Safeguard
+ifeq ($(strip $(ARCH)),arm64)
+	boot = uefi
+endif
+
+.PHONY: all clean
+
+all: debian
+
+$(eval $(call check_packages_deps,cloud-image-utils ovmf,cloud-image-utils ovmf))
+
+lint:
+	packer validate .
+	packer fmt -check -diff .
+
+format:
+	packer fmt .
+
+OVMF_VARS.fd: /usr/share/OVMF/OVMF_VARS.fd
+	cp -v $< $@
+
+debian: check-deps clean
+	${PACKER} init . && ${PACKER} build \
+		-var debian_series=${SERIES} \
+		-var debian_version=${VERSION} \
+		-var architecture=${ARCH} \
+		-var boot_mode=${BOOT} .
+
+clean:
+	${RM} -rf output-* debian-custom-*.gz \
+		seeds-cloudimg.iso \
+		OVMF_VARS.fd \
+		AAVMF_VARS.fd
+
+CUSTOM_PKGS:=${wildcard packages/*.deb}
+
+packages/custom-packages.tar.gz: ${CUSTOM_PKGS}
+ifeq ($(strip $(CUSTOM_PKGS)),)
+	tar czf $@ -C packages -T /dev/null
+else
+	tar czf $@ -C packages ${notdir $^}
+endif
+
+.INTERMEDIATE: OVMF_VARS.fd packages/custom-packages.tar.gz \
+	seeds-cloudimg.iso

debian/README.md

@@ -0,0 +1,147 @@
+# Debian Packer Templates for MAAS
+
+## Introduction
+
+The Packer templates in this directory creates Debian images for use with MAAS.
+
+## Prerequisites (to create the image)
+
+* A machine running Ubuntu 18.04+ with the ability to run KVM virtual machines.
+* qemu-utils, libnbd-bin, nbdkit and fuse2fs
+* qemu-system
+* ovmf
+* cloud-image-utils
+* [Packer](https://www.packer.io/intro/getting-started/install.html), v1.7.0 or newer
+
+## Requirements (to deploy the image)
+
+* [MAAS](https://maas.io) 3.2+
+* [Curtin](https://launchpad.net/curtin) 21.0+
+* [A Custom Preseed for Debian (Important - See below)]
+
+## Supported Debian Versions
+
+The builds and deployment has been tested on MAAS 3.3.5 with Jammy ephemeral images,
+in BIOS and UEFI modes. The process currently works with the following Debian series:
+
+* Debian 10 (Buster)
+* Debian 11 (Bullseye)
+* Debian 12 (Bookworm)
+
+## Supported Architectures
+
+Currently amd64 (x86_64) and arm64 (aarch64) architectures are supported with aemd64
+being the default.
+
+## Known Issues
+
+* UEFI images fro Debian 10 (Buster) and 11 (Bullseye) are usable on both BIOS and 
+UEFI systems. However for Debian 12 (Bookworm) explicit images are required to
+support BIOS and UEFI modes. See BOOT make parameter for more details.
+
+
+## debian-cloudimg.pkr.hcl
+
+This template builds a tgz image from the official Debian cloud images. This
+results in an image that is very close to the ones that are on
+<https://images.maas.io/>.
+
+### Building the image
+
+The build the image you give the template a script which has all the
+customizations:
+
+```shell
+packer init .
+packer build -var customize_script=my-changes.sh -var debian_series=bullseye \
+    -var debian_version=11 .
+```
+
+`my-changes.sh` is a script you write which customizes the image from within
+the VM. For example, you can install packages using `apt-get`, call out to
+ansible, or whatever you want.
+
+Using make:
+
+```shell
+make debian SERIES=bullseye
+```
+
+#### Accessing external files from you script
+
+If you want to put or use some files in the image, you can put those in the `http` directory.
+
+Whatever file you put there, you can access from within your script like this:
+
+```shell
+wget http://${PACKER_HTTP_IP}:${PACKER_HTTP_PORT}:/my-file
+```
+
+### Installing a kernel
+
+If you do want to force an image to always use a specific kernel, you can
+include it in the image.
+
+The easiest way of doing this is to use the `kernel` parameter:
+
+```shell
+packer init .
+packer build -var kernel=linux-image-amd64 -var customize_script=my-changes.sh .
+```
+
+You can also install the kernel manually in your `my-changes.sh` script.
+
+### Custom Preseed for Debian
+
+As mentioned above, Debian images require a custom preseed file to be present in the
+preseeds directory of MAAS region controllers. 
+
+When used snaps, the path is /var/snap/maas/current/preseeds/curtin_userdata_custom
+
+Example ready to use preesed files has been included with this repository. Please
+see curtin_userdata_custom_amd64 and curtin_userdata_custom_arm64.
+
+Please be aware that this could potentially create a conflict with the rest of custom
+images present in your setup, hence a through investigation and testing might be
+required prior to deployment.
+
+To work around a conflict, it is possible to name the preseed file something similar to
+curtin_userdata_custom_amd64_generic_debian-10 assuming the architecture was set to
+amd64/generic and the uploaded name was set to custom/debian-10.
+
+### Makefile Parameters
+
+#### PACKER_LOG
+
+Enable (1) or Disable (0) verbose packer logs. The default value is set to 0.
+
+#### SERIES
+
+Specify the Debian Series to build. The default value is set to bullseye.
+
+#### BOOT
+
+Supported boot mode baked into the image. The default is set to uefi. Please
+see the Known Issues section for more details. This parameter is only valid 
+for amd64 architecture.
+
+#### ARCH
+
+Target image architecture. Supported values are amd64 (default) and arm64.
+
+### Default Username
+
+The default username is ```debian```
+
+## Uploading images to MAAS
+
+TGZ image
+
+```shell
+maas admin boot-resources create \
+    name='custom/debian-12' \
+    title='Debian 12 Custom' \
+    architecture='amd64/generic' \
+    filetype='tgz' \
+    content@=debian-custom-cloudimg.tar.gz
+```

debian/curtin_userdata_custom_amd64

@@ -0,0 +1,24 @@
+#cloud-config
+kernel:
+  fallback-package: linux-image-amd64
+  package: linux-image-amd64
+
+apt:
+  preserve_sources_list: true
+
+debconf_selections:
+ maas: |
+  {{for line in str(curtin_preseed).splitlines()}}
+  {{line}}
+  {{endfor}}
+
+late_commands:
+  maas: [wget, '--no-proxy', '{{node_disable_pxe_url}}', '--post-data', '{{node_disable_pxe_data}}', '-O', '/dev/null']
+  late_1: mount --bind $TARGET_MOUNT_POINT /mnt
+  late_2: grep -A2 datasource /etc/cloud/cloud.cfg.d/91_kernel_cmdline_url.cfg | sed 's/curtin//' | tee /mnt/etc/cloud/cloud.cfg.d/debian.cfg
+  late_3: sed -i '[email protected]/[email protected]/debian@g;s@archive@deb@g;s@ubuntu@debian@g;s@Ubuntu@Debian@g;' /mnt/etc/cloud/cloud.cfg
+  late_4: debver=$(cat /mnt/etc/debian_version | awk -F. '{print $1}'); if [ ${debver} -eq 10 ]; then rel="buster"; elif [ ${debver} -eq 11 ]; then rel="bullseye"; elif [ ${debver} -eq 12 ]; then rel="bookworm"; fi; sed -i s/stable/${rel}/g /mnt/etc/apt/sources.list;
+  late_5: sed -i '/^set -e/{n;N;d}' /mnt/etc/kernel/postinst.d/zz-update-grub
+  late_6: rm -f /usr/local/bin/dpkg-query
+  late_7: rm -f /usr/local/bin/netplan
+

debian/curtin_userdata_custom_arm64

@@ -0,0 +1,24 @@
+#cloud-config
+kernel:
+  fallback-package: linux-image-arm64
+  package: linux-image-arm64
+
+apt:
+  preserve_sources_list: true
+
+debconf_selections:
+ maas: |
+  {{for line in str(curtin_preseed).splitlines()}}
+  {{line}}
+  {{endfor}}
+
+late_commands:
+  maas: [wget, '--no-proxy', '{{node_disable_pxe_url}}', '--post-data', '{{node_disable_pxe_data}}', '-O', '/dev/null']
+  late_1: mount --bind $TARGET_MOUNT_POINT /mnt
+  late_2: grep -A2 datasource /etc/cloud/cloud.cfg.d/91_kernel_cmdline_url.cfg | sed 's/curtin//' | tee /mnt/etc/cloud/cloud.cfg.d/debian.cfg
+  late_3: sed -i '[email protected]/[email protected]/debian@g;s@archive@deb@g;s@ubuntu@debian@g;s@Ubuntu@Debian@g;' /mnt/etc/cloud/cloud.cfg
+  late_4: debver=$(cat /mnt/etc/debian_version | awk -F. '{print $1}'); if [ ${debver} -eq 10 ]; then rel="buster"; elif [ ${debver} -eq 11 ]; then rel="bullseye"; elif [ ${debver} -eq 12 ]; then rel="bookworm"; fi; sed -i s/stable/${rel}/g /mnt/etc/apt/sources.list;
+  late_5: sed -i '/^set -e/{n;N;d}' /mnt/etc/kernel/postinst.d/zz-update-grub
+  late_6: rm -f /usr/local/bin/dpkg-query
+  late_7: rm -f /usr/local/bin/netplan
+