Configurable prefix for zfs volume names of base images

Author: delan

.env.example

@@ -4,8 +4,11 @@ SERVO_CI_GITHUB_API_SCOPE=/repos/delan/servo
 # Register runners as “name.0@host”, where “host” is a name identifying this host.
 SERVO_CI_GITHUB_API_SUFFIX=host
 
-# Create ZFS volumes as “mypool/ci/name.0”.
+# Create libvirt guests as “ci-name.0”. Namespace must not be used by anything else!
+SERVO_CI_LIBVIRT_PREFIX=ci
+
+# Create ZFS volumes as “mypool/ci/name.0”. Namespace must not be used by anything else!
 SERVO_CI_ZFS_PREFIX=mypool/ci
 
-# Create libvirt guests as “ci-name.0”.
-SERVO_CI_LIBVIRT_PREFIX=ci
+# Clone ZFS volumes from “mypool/base/name”. Must be outside $SERVO_CI_ZFS_PREFIX!
+SERVO_CI_ZFS_CLONE_PREFIX=mybool/base

README.md

@@ -12,22 +12,22 @@ To build the base vm:
     - Windows Server 2019: [17763.3650.221105-1748.rs5_release_svc_refresh_SERVER_EVAL_x64FRE_en-us.iso](https://software-static.download.prss.microsoft.com/dbazure/988969d5-f34g-4e03-ac9d-1f9786c66749/17763.3650.221105-1748.rs5_release_svc_refresh_SERVER_EVAL_x64FRE_en-us.iso) (sha256 = 6dae072e7f78f4ccab74a45341de0d6e2d45c39be25f1f5920a2ab4f51d7bcbb)
     - VirtIO drivers: [virtio-win-0.1.240.iso](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/virtio-win-0.1.240-1/virtio-win-0.1.240.iso) (sha256 = ebd48258668f7f78e026ed276c28a9d19d83e020ffa080ad69910dc86bbcbcc6)
 - Create zvol and libvirt guest with random UUID and MAC address
-    - `zfs create -V 90G mypool/ci/servo-windows2019`
+    - `zfs create -V 90G mypool/base/servo-windows2019`
     - `virsh define windows2019.xml`
-    - `virt-clone --preserve-data --check path_in_use=off -o servo-windows2019-init -n servo-windows2019 -f /dev/zvol/mypool/ci/servo-windows2019`
+    - `virt-clone --preserve-data --check path_in_use=off -o servo-windows2019-init -n servo-windows2019 -f /dev/zvol/mypool/base/servo-windows2019`
     - `virsh undefine servo-windows2019-init`
 - Install Windows Server with desktop experience
     - Core can build Servo, but trying to run it yields DeviceOpenFailed in surfman
     - Load disk driver from `E:\vioscsi\2k19\amd64`
     - Set password for Administrator to `servo2024!`
     - Once installed, shut down the guest: `shutdown /s /t 0`
-- Take a snapshot: `zfs snapshot mypool/ci/servo-windows2019@0-fresh-install`
+- Take a snapshot: `zfs snapshot mypool/base/servo-windows2019@0-fresh-install`
 - Update base vm image: `./mount-runner.sh servo-windows2019 $PWD/windows2019/configure-base.sh`
-- Take another snapshot: `zfs snapshot mypool/ci/servo-windows2019@1-configure-base`
+- Take another snapshot: `zfs snapshot mypool/base/servo-windows2019@1-configure-base`
 - Boot base vm guest: `virsh start servo-windows2019`
     - The guest will reboot twice, due to the .NET and MSVC installations
     - Once installed, shut down the guest: `shutdown /s /t 0`
-- Take another snapshot: `zfs snapshot mypool/ci/servo-windows2019@2-ready`
+- Take another snapshot: `zfs snapshot mypool/base/servo-windows2019@2-ready`
 
 To clone and start a new runner:
 
@@ -46,15 +46,15 @@ To build the base vm:
     - Windows 10 (multi-edition ISO), English (United States): [Win10_22H2_English_x64v1.iso](https://www.microsoft.com/en-us/software-download/windows10ISO) (sha256 = a6f470ca6d331eb353b815c043e327a347f594f37ff525f17764738fe812852e)
     - VirtIO drivers: [virtio-win-0.1.240.iso](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/virtio-win-0.1.240-1/virtio-win-0.1.240.iso) (sha256 = ebd48258668f7f78e026ed276c28a9d19d83e020ffa080ad69910dc86bbcbcc6)
 - Create zvol and libvirt guest with random UUID and MAC address
-    - `zfs create -V 90G mypool/ci/servo-windows10`
+    - `zfs create -V 90G mypool/base/servo-windows10`
     - `virsh define windows10.xml`
-    - `virt-clone --preserve-data --check path_in_use=off -o servo-windows10-init -n servo-windows10 -f /dev/zvol/mypool/ci/servo-windows10`
+    - `virt-clone --preserve-data --check path_in_use=off -o servo-windows10-init -n servo-windows10 -f /dev/zvol/mypool/base/servo-windows10`
     - `virsh undefine servo-windows10-init`
 - Install Windows 10 Pro
     - Click “I don't have a product key”
     - Load disk driver from `E:\vioscsi\w10\amd64`
     - Shut down the guest when you see “Let’s start with region. Is this right?”: `virsh shutdown servo-windows10`
-- Take a snapshot: `zfs snapshot mypool/ci/servo-windows10@0-fresh-install`
+- Take a snapshot: `zfs snapshot mypool/base/servo-windows10@0-fresh-install`
 - Boot base vm guest: `virsh start servo-windows10`
     - Click “I don’t have internet”
     - Click “Continue with limited setup”
@@ -63,15 +63,15 @@ To build the base vm:
     - Turn off the six privacy settings
     - Click “Not now” for Cortana
     - Once installed, shut down the guest: `shutdown /s /t 0`
-- Take another snapshot: `zfs snapshot mypool/ci/servo-windows10@1-oobe`
+- Take another snapshot: `zfs snapshot mypool/base/servo-windows10@1-oobe`
 - Update base vm image: `./mount-runner.sh servo-windows10 $PWD/windows2019/configure-base.sh`
-- Take another snapshot: `zfs snapshot mypool/ci/servo-windows10@2-configure-base`
+- Take another snapshot: `zfs snapshot mypool/base/servo-windows10@2-configure-base`
 - Boot base vm guest: `virsh start servo-windows10`
     - Open an elevated PowerShell: **Win**+**X**, **A**
     - Allow running scripts: `Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Force`
     - Run the init script once: `C:\init\init.ps1`
     - Once installed, shut down the guest: `shutdown /s /t 0`
-- Take another snapshot: `zfs snapshot mypool/ci/servo-windows10@3-ready`
+- Take another snapshot: `zfs snapshot mypool/base/servo-windows10@3-ready`
 
 To clone and start a new runner:
 
@@ -87,9 +87,9 @@ To build the base vm:
 - Download images into /var/lib/libvirt/images
     - Ubuntu Server 22.04.4: [ubuntu-22.04.4-live-server-amd64.iso](http://mirror.internode.on.net/pub/ubuntu/releases/22.04.4/ubuntu-22.04.4-live-server-amd64.iso)
 - Create zvol and libvirt guest with random UUID and MAC address
-    - `zfs create -V 90G mypool/ci/servo-ubuntu2204`
+    - `zfs create -V 90G mypool/base/servo-ubuntu2204`
     - `virsh define ubuntu2204.xml`
-    - `virt-clone --preserve-data --check path_in_use=off -o servo-ubuntu2204-init -n servo-ubuntu2204 -f /dev/zvol/mypool/ci/servo-ubuntu2204`
+    - `virt-clone --preserve-data --check path_in_use=off -o servo-ubuntu2204-init -n servo-ubuntu2204 -f /dev/zvol/mypool/base/servo-ubuntu2204`
     - `virsh undefine servo-ubuntu2204-init`
 - Install Ubuntu
     - Uncheck “Set up this disk as an LVM group”
@@ -98,12 +98,12 @@ To build the base vm:
     - Check “Install OpenSSH server”
     - Uncheck “Allow password authentication over SSH”
     - Once installed, shut down the guest
-- Take a snapshot: `zfs snapshot mypool/ci/servo-ubuntu2204@0-fresh-install`
+- Take a snapshot: `zfs snapshot mypool/base/servo-ubuntu2204@0-fresh-install`
 - Update base vm image: `./mount-runner.sh servo-ubuntu2204 $PWD/ubuntu2204/configure-base.sh`
-- Take another snapshot: `zfs snapshot mypool/ci/servo-ubuntu2204@1-configure-base`
+- Take another snapshot: `zfs snapshot mypool/base/servo-ubuntu2204@1-configure-base`
 - Boot base vm guest: `virsh start servo-ubuntu2204`
     - Once installed, shut down the guest
-- Take another snapshot: `zfs snapshot mypool/ci/servo-ubuntu2204@2-ready`
+- Take another snapshot: `zfs snapshot mypool/base/servo-ubuntu2204@2-ready`
 
 To clone and start a new runner:
 

create-runner.sh

@@ -13,7 +13,7 @@ done
 vm=$base_vm.$i
 >&2 printf '[*] Creating runner: %s\n' $vm
 
-zfs clone $SERVO_CI_ZFS_PREFIX/{$base_snapshot,$vm}
+zfs clone $SERVO_CI_ZFS_CLONE_PREFIX/$base_snapshot $SERVO_CI_ZFS_PREFIX/$vm
 while ! test -e /dev/zvol/$SERVO_CI_ZFS_PREFIX/$vm-part2; do
     sleep 1
 done