debos: Split in two recipes for rootfs and image

lool · lool · commit 5089cdd1a748 · 2025-03-31T14:10:23.000+02:00
This reduces the time under QEMU and paves the way to generating multiple
images.

Signed-off-by: Loïc Minier &lt;loic.minier@oss.qualcomm.com&gt;
diff --git a/.github/workflows/debos.yml b/.github/workflows/debos.yml
@@ -90,13 +90,15 @@ jobs:
               # these commands are run inside the container
               cat <<EOF
               cd /build
+              # start by building the root filesystem
+              debos qualcomm-linux-debian-rootfs.yaml
               # debos tries KVM and UML as backends, and falls back to building
               # directly on the host, but that requires loop devices; use
               # qemu backend explicitly even if it's slower
               # qemu backend also requires to set scratchsize, otherwise
               # the whole build is done from memory and the out of memory
               # killer gets triggered
-              debos -b qemu --scratchsize 4GiB qualcomm-linux-debian.yaml
+              debos -b qemu --scratchsize 4GiB qualcomm-linux-debian-image.yaml
           EOF
           ) | sudo incus exec "${INCUS_NAME}" -- sh
 
diff --git a/README.md b/README.md
@@ -21,7 +21,11 @@ main: Primary development branch. Contributors should develop submissions based
 
 To build a disk image, run debos as follows:
 ```bash
-debos debos-recipes/qualcomm-linux-debian.yaml
+# build a root filesystem tarball
+debos debos-recipes/qualcomm-linux-debian-rootfs.yaml
+
+# build a disk image from the root filesystem
+debos debos-recipes/qualcomm-linux-debian-image.yaml
 ```
 
 ### Build backends
@@ -30,21 +34,24 @@ By default, debos will try to pick a fast build backend; it will try to use its
 
 To build large images, the debos resource defaults might not be sufficient. Consider raising the default debos memory and scratchsize settings. This should provide a good set of minimum defaults:
 ```bash
-debos --fakemachine-backend qemu --memory 1GiB --scratchsize 4GiB debos-recipes/qualcomm-linux-debian.yaml
+debos --fakemachine-backend qemu --memory 1GiB --scratchsize 4GiB debos-recipes/qualcomm-linux-debian-image.yaml
 ```
 
 ### Build options
 
-A few options are provided in the debos recipe:
+A few options are provided in the debos recipes; for the root filesystem recipe:
+- experimentalkernel: update the linux kernel to the version from experimental; default: don't update the kernel
+- xfcedesktop: install a Xfce desktop environment; default: console only environment
+
+For the image recipe:
+- dtb: override the firmware provided device tree with one from the linux kernel, e.g. `qcom/qcs6490-rb3gen2.dtb`; default: don't override
 - image: set the output disk image filename; default: `disk.img`
 - imagesize: set the output disk image size; default: `4GiB`
-- dtb: override the firmware provided device tree with one from the linux kernel, e.g. `qcom/qcs6490-rb3gen2.dtb`; default: don't override
-- xfcedesktop: install a Xfce desktop environment; default: console only environment
-- experimentalkernel: update the linux kernel to the version from experimental; default: don't update the kernel
 
 These can be passed as follows:
 ```bash
-debos -t dtb:qcom/qcs6490-rb3gen2.dtb -t xfcedesktop:true -t experimentalkernel:true debos-recipes/qualcomm-linux-debian.yaml
+debos -t xfcedesktop:true -t experimentalkernel:true debos-recipes/qualcomm-linux-debian-rootfs.yaml
+debos -t dtb:qcom/qcs6490-rb3gen2.dtb debos-recipes/qualcomm-linux-debian-image.yaml
 ```
 
 ## Flashing Instructions
diff --git a/debos-recipes/qualcomm-linux-debian-image.yaml b/debos-recipes/qualcomm-linux-debian-image.yaml
@@ -0,0 +1,95 @@
+{{- $dtb := or .dtb "firmware" }}
+{{- $image := or .image "disk.img" }}
+{{- $imagesize := or .imagesize "4GiB" }}
+
+architecture: arm64
+
+actions:
+  - action: unpack
+    description: Unpack root filesystem
+    compression: gz
+    file: rootfs.tar.gz
+
+{{- if ne $dtb "firmware" }}
+  - action: run
+    description: Use OS device tree override (board specific)
+    chroot: true
+    command: |
+      set -eu
+      mkdir -p /etc/kernel
+      echo {{ $dtb }} >/etc/kernel/devicetree
+{{- end }}
+
+  # parttype values are from:
+  # https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/
+  - action: image-partition
+    description: Create an image file
+    imagename: {{ $image }}
+    imagesize: {{ $imagesize }}
+    partitiontype: gpt
+    partitions:
+      - name: esp
+        partlabel: ESP
+        flags: [ boot, esp ]
+        # EFI System Partition
+        parttype: c12a7328-f81f-11d2-ba4b-00a0c93ec93b
+        fs: vfat
+        start: 4MiB
+        # size of 512MiB
+        end: 516MiB
+        fsck: true
+      - name: root
+        # Root Partition (64-bit ARM/AArch64)
+        parttype: b921b045-1df0-41c3-af44-4c6f280d3fae
+        fs: ext4
+        # 4MiB after ESP
+        start: 520MiB
+        end: 100%
+        fsck: true
+    mountpoints:
+      - mountpoint: /boot/efi/
+        partition: esp
+      - mountpoint: /
+        partition: root
+
+  # XXX these kernel options might be specific to a kernel version or board
+  - action: filesystem-deploy
+    setup-fstab: true
+    append-kernel-cmdline: clk_ignore_unused pd_ignore_unused audit=0 deferred_probe_timeout=30
+
+  - action: apt
+    recommends: true
+    description: Make system bootable with systemd-boot
+    packages:
+      - systemd-boot
+      # TODO investigate why systemd-boot Recommends: shim-signed which
+      # Depends on grub packages
+      - shim-signed-
+
+  - action: run
+    description: Create task to grow root filesystem on first boot
+    chroot: true
+    command: |
+      set -eu
+      # for growpart
+      apt -y install cloud-guest-utils
+      # extract the dev of the root filesystem from fstab; change UUID=id into
+      # /dev/disk/by-uuid/id
+      ROOTFS_DEV=$(
+          awk '$2 == "/" {gsub("UUID=", "/dev/disk/by-uuid/"); print $1}' \
+              /etc/fstab
+          )
+      # generate systemd unit to grow the second partition with above UUID
+      cat >/etc/systemd/system/debos-grow-rootfs.service <<EOF
+      [Unit]
+      Description=Grow root partition and filesystem (debos)
+      [Service]
+      Type=oneshot
+      ExecStartPre=-sh -c 'growpart /dev/\`lsblk -n -o pkname $ROOTFS_DEV\` 2'
+      ExecStart=resize2fs $ROOTFS_DEV
+      [Install]
+      WantedBy=default.target
+      EOF
+      # enable unit
+      systemctl enable debos-grow-rootfs
+
diff --git a/debos-recipes/qualcomm-linux-debian-rootfs.yaml b/debos-recipes/qualcomm-linux-debian-rootfs.yaml
@@ -1,6 +1,3 @@
-{{- $image := or .image "disk.img" }}
-{{- $imagesize := or .imagesize "4GiB" }}
-{{- $dtb := or .dtb "firmware" }}
 {{- $xfcedesktop := or .xfcedesktop "false" }}
 {{- $experimentalkernel := or .experimentalkernel "false" }}
 
@@ -187,86 +184,7 @@ actions:
           /etc/apt/sources.list.d/debian-experimental.sources
 {{- end }}
 
-  # parttype values are from:
-  # https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/
-  - action: image-partition
-    description: Create an image file
-    imagename: {{ $image }}
-    imagesize: {{ $imagesize }}
-    partitiontype: gpt
-    partitions:
-      - name: esp
-        partlabel: ESP
-        flags: [ boot, esp ]
-        # EFI System Partition
-        parttype: c12a7328-f81f-11d2-ba4b-00a0c93ec93b
-        fs: vfat
-        start: 4MiB
-        # size of 512MiB
-        end: 516MiB
-        fsck: true
-      - name: root
-        # Root Partition (64-bit ARM/AArch64)
-        parttype: b921b045-1df0-41c3-af44-4c6f280d3fae
-        fs: ext4
-        # 4MiB after ESP
-        start: 520MiB
-        end: 100%
-        fsck: true
-    mountpoints:
-      - mountpoint: /boot/efi/
-        partition: esp
-      - mountpoint: /
-        partition: root
-
-  # XXX these kernel options might be specific to a kernel version or board
-  - action: filesystem-deploy
-    setup-fstab: true
-    append-kernel-cmdline: clk_ignore_unused pd_ignore_unused audit=0 deferred_probe_timeout=30
-
-{{- if ne $dtb "firmware" }}
-  - action: run
-    description: Use OS device tree override (board specific)
-    chroot: true
-    command: |
-      set -eu
-      mkdir -p /etc/kernel
-      echo {{ $dtb }} >/etc/kernel/devicetree
-{{- end }}
-
-  - action: apt
-    recommends: true
-    description: Make system bootable with systemd-boot
-    packages:
-      - systemd-boot
-      # TODO investigate why systemd-boot Recommends: shim-signed which
-      # Depends on grub packages
-      - shim-signed-
-
-  - action: run
-    description: Create task to grow root filesystem on first boot
-    chroot: true
-    command: |
-      set -eu
-      # for growpart
-      apt -y install cloud-guest-utils
-      # extract the dev of the root filesystem from fstab; change UUID=id into
-      # /dev/disk/by-uuid/id
-      ROOTFS_DEV=$(
-          awk '$2 == "/" {gsub("UUID=", "/dev/disk/by-uuid/"); print $1}' \
-              /etc/fstab
-          )
-      # generate systemd unit to grow the second partition with above UUID
-      cat >/etc/systemd/system/debos-grow-rootfs.service <<EOF
-      [Unit]
-      Description=Grow root partition and filesystem (debos)
-      [Service]
-      Type=oneshot
-      ExecStartPre=-sh -c 'growpart /dev/\`lsblk -n -o pkname $ROOTFS_DEV\` 2'
-      ExecStart=resize2fs $ROOTFS_DEV
-      [Install]
-      WantedBy=default.target
-      EOF
-      # enable unit
-      systemctl enable debos-grow-rootfs
+  - action: pack
+    file: rootfs.tar.gz
+    compression: gz
 
