Merge ~tchavadar/ubuntu-images:add-debian-packaging into ubuntu-images:noble

[Talha Can Havadar]

# Proposal to have ubuntu-images as debian package

Based on the experiences we have during hardware enablement using ubuntu-image and livecd-rootfs together in livefs build environment. We are thinking having ubuntu-images repo as package will give us much more flexibility in our customized builds. This is with an assumption of using (this new) ubuntu-images package as a dependency in livecd-rootfs package.

Right now we have a mechanism in upstream livecd-rootfs which just clones this repository to use image definitions. (https://git.launchpad.net/livecd-rootfs/tree/live-build/auto/config#n534)

This way of working with image-definitions is not suitable for private projects which in most cases, especially in early stages of enablement, we are using private PPAs to test and built the images which requires us to put image-definition files in private repos. With the current environment that livefs gives us it is not possible to clone a private git repository.

If ubuntu-images repo could be installed as debian package then we would be able to create our own version of ubuntu-images package and put it in our own private ppa and trigger livefs build using that ppa.

With the help of hooks being integrated with the ubuntu-images package, we could do any sort of customization without having a need of changing livecd-rootfs once we have livecd-rootfs compatible with ubuntu-images deb package.

I would like to hear your opinions about this and based on your feedback I will create a merge proposal in livecd-rootfs repo as well to support this way of working.

PPA: https://launchpad.net/~tchavadar/+archive/ubuntu/ubuntu-images-test
Please see the changes in livecd-rootfs as well: https://code.launchpad.net/~tchavadar/livecd-rootfs/+git/livecd-rootfs/+merge/464550

Unmerged commits

46c8b06... by Talha Can Havadar on 2024-04-17

debian: add debian packaging files

4ed7bc1... by Talha Can Havadar on 2024-04-17

add readme to explain usage of hooks

diff --git a/debian/changelog b/debian/changelog
new file mode 100644
index 0000000..251c089
--- /dev/null
+++ b/debian/changelog
@@ -0,0 +1,5 @@
+ubuntu-images (0.0.1) noble; urgency=low
+
+  * Initial release.
+
+ -- Talha Can Havadar <[e-mail]>  Wed, 17 Apr 2024 14:41:36 +0200
diff --git a/debian/control b/debian/control
new file mode 100644
index 0000000..27e50c8
--- /dev/null
+++ b/debian/control
@@ -0,0 +1,13 @@
+Source: ubuntu-images
+Section: devel
+Priority: optional
+Maintainer: Talha Can Havadar <[e-mail]>
+Build-Depends: debhelper-compat (= 13)
+Standards-Version: 4.6.2
+
+Package: ubuntu-images
+Architecture: any
+Multi-Arch: foreign
+Depends: ${misc:Depends}, ${shlibs:Depends}
+Description: ubuntu-image image definitions
+ ubuntu-images holds the image definition files that can be used by ubuntu-image tool.
diff --git a/debian/copyright b/debian/copyright
new file mode 100644
index 0000000..ce06e54
--- /dev/null
+++ b/debian/copyright
@@ -0,0 +1,22 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+Files:     *
+Copyright: Canonical Ltd.
+License:   GPL-3.0
+
+License: GPL-3.0
+ This program is free software: you can redistribute it and/or modify it
+ under the terms of the GNU General Public License version 3, as
+ published by the Free Software Foundation.
+ .
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranties of
+ MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ PURPOSE.  See the applicable version of the GNU Lesser General Public
+ License for more details.
+ .
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ .
+ On Debian systems, the complete text of the GNU General Public License
+ can be found in `/usr/share/common-licenses/GPL-3'
diff --git a/debian/gbp.conf b/debian/gbp.conf
new file mode 100644
index 0000000..ccb69a5
--- /dev/null
+++ b/debian/gbp.conf
@@ -0,0 +1,6 @@
+# Configuration file for "gbp <command>"
+
+[DEFAULT]
+debian-branch = noble
+debian-tag = ubuntu/%(version)s
+export-dir = ../build-area
diff --git a/debian/install b/debian/install
new file mode 100644
index 0000000..6ff555d
--- /dev/null
+++ b/debian/install
@@ -0,0 +1,2 @@
+*.yaml usr/share/ubuntu-images
+hooks usr/share/ubuntu-images
diff --git a/debian/rules b/debian/rules
new file mode 100755
index 0000000..098338c
--- /dev/null
+++ b/debian/rules
@@ -0,0 +1,5 @@
+#!/usr/bin/make -f
+export DEB_BUILD_MAINT_OPTIONS = hardening=+all
+
+%:
+	dh $@
diff --git a/debian/source/format b/debian/source/format
new file mode 100644
index 0000000..89ae9db
--- /dev/null
+++ b/debian/source/format
@@ -0,0 +1 @@
+3.0 (native)
diff --git a/hooks/README.md b/hooks/README.md
new file mode 100644
index 0000000..675884e
--- /dev/null
+++ b/hooks/README.md
@@ -0,0 +1,45 @@
+# Hooks to Run During Image Build
+`hooks` directory witholds the necessary hooks to build specific images.
+Hooks must be structered using a specific convention explained below and each hook file must be executable.
+```
+hooks/
+├── <subarch>
+    ├── <execution_order>-<hook_name>.binary
+    └── <hook_name>.chroot
+```
+
+Example:
+```
+hooks/
+├── kria
+    ├── 010-flash-kernel-fitimage.binary
+    ├── 080-add-snaps-to-manifest.binary
+    ├── wait-cloud-init-before-getty.sh.chroot
+    └── run-flash-kernel.sh.chroot
+```
+
+## .binary hooks
+Binary hooks are the hooks that must be run after ubuntu-image build is completed.
+
+This hooks are typically being executed from a build script after the image build is completed. Please see below as an example:
+
+```bash
+echo "Binary hooks for $SUBARCH is being executed"
+for binary in $LB_UBUNTU_IMAGES_ROOT/hooks/$SUBARCH/*.binary; do
+  echo "Executing $binary $PREFIX..."
+  $binary $PREFIX
+done
+echo "Binary hooks execution completed"
+```
+
+## .chroot hooks
+Chroot hooks are the hooks that is designed to be run in the chroot shell of the image that is being built. These are the hooks that is typically will be specified in image-definition yaml file as in the example below.
+
+```yaml
+manual:
+    copy-file:
+      - source: hooks/kria/wait-cloud-init-before-getty.sh.chroot
+        destination: /home
+    execute:
+      - path: /home/wait-cloud-init-before-getty.sh.chroot
+```