Merge pull request #35 from gardenlinux/pxe

toanju · web-flow · commit e6dc0b768def · 2025-02-07T16:57:03.000+01:00
Add pxe feature from GL
diff --git a/features/_pxe/README.md b/features/_pxe/README.md
@@ -0,0 +1,28 @@
+## Feature: _pxe
+### Description
+<website-feature>
+This flag feature creates an artifact for supporting PXE network boot of Garden Linux.
+</website-feature>
+
+### Features
+This feature creates files meant to be booted via PXE network boot: `.squashfs`, `.vmlinuz` and `.initrd`.
+
+#### Hint
+Ignition Files can be used with PXE to inject information into the system at the first boot of Garden Linux. This includes creating users, groups, ssh keys, files, permissions and network configuration. This way machines can be defined in a declarative way.
+
+See also:
+- [iPXE Documentation @ ipxe.org](https://ipxe.org/docs)
+- [iPXE Script Examples @ ipxe.org](https://ipxe.org/scripting)
+- [Ignition Documentation @ fedoraproject.org](https://docs.fedoraproject.org/en-US/fedora-coreos/producing-ign/#_ignition_overview)
+
+
+### Unit testing
+This feature does not support unit tests.
+
+### Meta
+|||
+|---|---|
+|type|flag|
+|artifact|`.squashfs`, `.vmlinuz`, `.initrd`|
+|included_features|`_ignite`|
+|excluded_features|None|
diff --git a/features/_pxe/exec.config b/features/_pxe/exec.config
@@ -0,0 +1 @@
+#!/usr/bin/env bash
diff --git a/features/_pxe/file.exclude b/features/_pxe/file.exclude
@@ -0,0 +1 @@
+/etc/repart.d/root.conf
diff --git a/features/_pxe/file.include/etc/dracut.conf.d/20-gl-live.conf b/features/_pxe/file.include/etc/dracut.conf.d/20-gl-live.conf
@@ -0,0 +1 @@
+add_dracutmodules+=" gardenlinux-live "
diff --git a/features/_pxe/file.include/etc/dracut.conf.d/30-omit-cdc-ether.conf b/features/_pxe/file.include/etc/dracut.conf.d/30-omit-cdc-ether.conf
@@ -0,0 +1 @@
+omit_drivers+=" cdc_ether "
diff --git a/features/_pxe/file.include/etc/systemd/network/91-default.network b/features/_pxe/file.include/etc/systemd/network/91-default.network
@@ -0,0 +1 @@
+/dev/null
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/99-any.conf b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/99-any.conf
@@ -0,0 +1,5 @@
+[Service]
+ExecStart=
+ExecStart=/lib/systemd/systemd-networkd-wait-online --any
+[Unit]
+ConditionPathExists=
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/cleanup.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/cleanup.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+rm /run/systemd/network/91-default.network
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/gl-end.service b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/gl-end.service
@@ -0,0 +1,17 @@
+[Unit]
+Description=GardenLinux End Service
+
+Before=initrd-switch-root.service
+Wants=initrd-switch-root.target
+
+OnFailure=emergency.target
+OnFailureJobMode=isolate
+DefaultDependencies=no
+
+ConditionPathExists=/sysroot/gardenlinux.dracut.end
+
+[Service]
+Type=oneshot
+TimeoutStartSec=600
+RemainAfterExit=yes
+ExecStart=/bin/bash -Eeuo pipefail -c 'mv /sysroot/gardenlinux.dracut.end /run/dracut.end || cp /sysroot/gardenlinux.dracut.end /run/dracut.end; ./run/dracut.end; rm -f /run/dracut.end'
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/is-live-image.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/is-live-image.sh
@@ -0,0 +1,15 @@
+#!/usr/bin/env sh
+
+type getarg >/dev/null 2>&1 || . /lib/dracut-lib.sh
+
+live=$(getarg gl.live=)
+live="${live#gl.live=}"
+
+case "$live" in
+	no,false,0,disabled,disable)
+            exit 1
+            ;;
+        *)
+            exit 0
+            ;;
+esac
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/live-get-squashfs.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/live-get-squashfs.sh
@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+type getarg >/dev/null 2>&1 || . /lib/dracut-lib.sh
+type info >/dev/null 2>&1 || . /lib/dracut-lib.sh
+type warn >/dev/null 2>&1 || . /lib/dracut-lib.sh
+
+
+shaFile="/root.squashfs.sha256sum"
+squashFile="/tmp/root.squashfs"
+
+# download squashfs
+
+url=$(getarg gl.url=)
+if [ -z "${url#gl.url=}" ]; then
+	info "gl.url not defined, skipping"
+	exit 0
+fi
+
+if ! curl --globoff --location --retry 10 --retry-delay 3 --retry-max-time 30 --fail --show-error "${url}" --output "${squashFile}"; then
+       warn "can't fetch the squashfs from ${url#gl.url=}"
+       exit 1
+fi       
+
+# verify sha256
+if [ ! -f "${shaFile}" ]; then
+	warn "no sha256sum file exists - exiting"
+	exit 1
+fi
+
+if ! echo "$(grep . ${shaFile}) ${squashFile}" | sha256sum --status --check; then
+	warn "the hash verification of the squashfs has failed - exiting"
+	exit 1
+fi
+
+# move image to proper place
+mv "${squashFile}" /run/root.squashfs
+
+exit 0
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/live-overlay-setup.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/live-overlay-setup.sh
@@ -0,0 +1,121 @@
+#!/bin/bash
+
+command -v getarg >/dev/null || . /lib/dracut-lib.sh
+
+GENERATOR_DIR=$1
+
+ovlconf=$(getarg gl.ovl=)
+ovlconf=${ovlconf#gl.ovl=}
+
+if [ -z "$ovlconf" ]; then
+    exit 0
+fi
+
+echo $ovlconf | awk -F, 'BEGIN {OFS="\n"}; {$1=$1; gsub(/:/, " "); print}' > /tmp/overlay.conf
+
+# add a test for /tmp/overlay.conf
+if [ ! -f /tmp/overlay.conf ]; then
+    echo "there is no /tmp/overlay.conf - exiting"
+    exit 1
+fi
+
+mkdir -p /run/overlay
+
+# check if overlay for root is wanted
+if echo "$ovlconf" | grep -q '^/:\|,/:'; then
+	# we have overlay for root defined, ignore everything else
+	dev=$(grep '^/ ' /tmp/overlay.conf | awk '{print $2}')
+	devescape=$(systemd-escape -p --suffix=service "$dev")
+	mkdir -p "/run/sysroot.ovl"
+
+	if [[ "$dev" != tmpfs ]]; then
+		echo "[Unit]
+		Before=sysroot.mount
+		After=ignition-disks.service
+		DefaultDependencies=no
+		Requires=systemd-fsck@${devescape}
+		After=systemd-fsck@${devescape}
+
+		[Mount]
+		What=$dev
+		Where=/run/sysroot.ovl" | awk '{$1=$1}1' > "${GENERATOR_DIR}/run-sysroot.ovl.mount"
+
+		mkdir ${GENERATOR_DIR}/systemd-fsck@${devescape}.d
+
+            	echo "[Unit]
+            	After=ignition-disks.service" > ${GENERATOR_DIR}/systemd-fsck@${devescape}.d/after-ignition-disks.conf
+	fi
+
+	echo "[Unit]
+	After=run-sysroot.ovl.mount
+	After=ignition-disks.service
+	Before=sysroot.mount
+	DefaultDependencies=no
+
+	[Service]
+	Type=oneshot
+	User=root
+	Group=root
+	ExecStart=/bin/mkdir -p /run/sysroot.ovl/upper /run/sysroot.ovl/work" | awk '{$1=$1}1' > "${GENERATOR_DIR}/create-mountpoints.service"
+
+	echo "[Unit]
+	Before=initrd-root-fs.target
+	After=run-rootfs.mount
+	Requires=run-rootfs.mount
+	After=ignition-disks.service
+	After=create-mountpoints.service
+	Requires=create-mountpoints.service
+	DefaultDependencies=no
+	Description=sysroot.mount
+	[Mount]
+	What=ovl_sysroot
+	Where=/sysroot
+	Type=overlay
+	Options=lowerdir=/run/rootfs,upperdir=/run/sysroot.ovl/upper,workdir=/run/sysroot.ovl/work" | awk '{$1=$1}1' > "${GENERATOR_DIR}/sysroot.mount"
+
+	mkdir -p "$GENERATOR_DIR"/initrd-root-fs.target.requires
+	ln -s ../sysroot.mount "$GENERATOR_DIR"/initrd-root-fs.target.requires/sysroot.mount
+	if [[ "$dev" != tmpfs ]]; then
+		ln -s ../run-sysroot.ovl.mount "$GENERATOR_DIR"/initrd-root-fs.target.requires/run-sysroot.ovl.mount
+	fi
+
+	exit 0
+fi
+
+while read -r line; do
+	what=$(echo "$line" | awk '{ print $1}')
+	where=$(echo "$line" | awk '{ print $2}')
+	dev=$(echo "$line" | awk '{ print $3}')
+	unit=$(systemd-escape -p --suffix=mount "/sysroot$what")
+	if [ "$where" == "tmpfs" ]; then
+		upper="/run/overlay$what-upper"
+		work="/run/overlay$what-work"
+		mkdir -p "$upper"
+		mkdir -p "$work"
+	else
+		# FIXME for disks handled by ignition - this will fail on squashfs
+		# FIXME persistent overlays should probably be handled fully by ignition
+		upper="/sysroot/$where/up"
+		work="/sysroot/$where/work"
+	fi
+
+
+	{
+	echo "[Unit]"
+	echo "Before=initrd-root-fs.target"
+	echo "After=sysroot.mount"
+	echo "DefaultDependencies=no"
+	echo "Description=$unit"
+
+	echo "[Mount]"
+	echo "What=ovl_$what"
+	echo "Where=/sysroot$what"
+	echo "Type=overlay"
+	echo "Options=lowerdir=/sysroot$what,upperdir=$upper,workdir=$work"
+	} > "$GENERATOR_DIR/$unit"
+
+	mkdir -p "$GENERATOR_DIR"/initrd-root-fs.target.requires
+	ln -s ../$unit $GENERATOR_DIR/initrd-root-fs.target.requires/$unit
+done < /tmp/overlay.conf
+
+exit 0
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/live-sysroot-generator.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/live-sysroot-generator.sh
@@ -0,0 +1,34 @@
+#!/bin/bash
+
+command -v getarg >/dev/null || . /lib/dracut-lib.sh
+
+set -e
+
+GENERATOR_DIR=$1
+
+getarg gl.ovl= > /dev/null || exit 0
+ovlconf=$(getarg gl.ovl=)
+ovlconf=${ovlconf#gl.ovl=}
+
+# if an overlay is predefined for sysroot, skip sysroot.mount generation
+if echo "$ovlconf" | grep -q '^/:\|,/:'; then
+	exit 0
+fi
+
+GENERATOR_DIR="$1"
+
+cat >"${GENERATOR_DIR}/sysroot.mount" <<EOF
+[Unit]
+After=live-get-squashfs.service
+Before=initrd-root-fs.target
+DefaultDependencies=no
+
+[Mount]
+What=/run/root.squashfs
+Where=/sysroot
+Type=squashfs
+Options=loop
+EOF
+
+mkdir -p "$GENERATOR_DIR"/initrd-root-fs.target.requires
+ln -s ../sysroot.mount "$GENERATOR_DIR"/initrd-root-fs.target.requires/sysroot.mount
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/module-setup.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/module-setup.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+
+check() {
+    [[ $mount_needs ]] && return 1
+    return 0
+}
+
+depends() {
+    echo "fs-lib dracut-systemd systemd-networkd systemd-resolved systemd-repart"
+}
+
+install() {
+    inst_multiple curl grep sfdisk awk mawk sha256sum efibootmgr mkfs.ext4 mkfs.vfat chroot
+
+    inst_simple "$moddir/gl-end.service" ${systemdsystemunitdir}/gl-end.service
+    inst_script "$moddir/live-get-squashfs.sh" /sbin/live-get-squashfs
+    inst_script "$moddir/live-sysroot-generator.sh" $systemdutildir/system-generators/live-sysroot-generator
+    inst_script "$moddir/squash-mount-generator.sh" $systemdutildir/system-generators/squash-mount-generator
+    inst_script "$moddir/live-overlay-setup.sh" $systemdutildir/system-generators/live-overlay-setup
+    systemctl -q --root "$initdir" add-wants initrd-switch-root.target gl-end.service
+
+    # for ignition
+    inst_simple "$moddir/is-live-image.sh" "/usr/bin/is-live-image"
+
+    #inst_simple "/usr/lib/file/magic.mgc" "/usr/lib/file/magic.mgc"
+
+    mkdir -m 0755 -p ${initdir}/etc/systemd/system/systemd-networkd-wait-online.service.d
+    inst_simple "$moddir/99-any.conf" "/etc/systemd/system/systemd-networkd-wait-online.service.d/99-zany.conf"
+
+    # ignition-fetch after resolved
+    mkdir -m 0755 -p "${initdir}/etc/systemd/system/ignition-fetch.service.d"
+    inst_simple "$moddir/ignition-fetch.conf" /etc/systemd/system/ignition-fetch.service.d/ignition-fetch.conf
+
+    # clean up
+    inst_hook cleanup 00 "$moddir/cleanup.sh"
+
+    # ca-certificates
+    if ! inst_simple /etc/ssl/certs/ca-certificates.crt; then
+	    dwarn "GL PXE module, can't install ca-certificates"
+	    exit 1
+    fi
+}
diff --git a/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/squash-mount-generator.sh b/features/_pxe/file.include/usr/lib/dracut/modules.d/98gardenlinux-live/squash-mount-generator.sh
diff --git a/features/_pxe/image.pxe.tar.gz b/features/_pxe/image.pxe.tar.gz
diff --git a/features/_pxe/info.yaml b/features/_pxe/info.yaml
diff --git a/features/_pxe/pkg.include b/features/_pxe/pkg.include
diff --git a/features/_pxe/test/test_capabilities.py b/features/_pxe/test/test_capabilities.py
diff --git a/features/_pxe/test/test_packages_musthave.py b/features/_pxe/test/test_packages_musthave.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+add_dracutmodules+=" gardenlinux-live "`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +#!/usr/bin/env bash
++
 +set -e
++
 +rm /run/systemd/network/91-default.network