CLab Images

This repository contains images for PKU CLab.

Dependencies

• virt-customize
• virt-resize (for growing disk images)
• qemu-img (for growing disk images)

Usage

Build an Image

git clone https://github.com/lcpu-club/clab-images.git
cd clab-images
./bin/build-vm <distro> <flavor> [version]

Add a new distro

Setup config and respective scripts in images/<distro>/distro.conf, images/<distro>/{pre,post}_commands, images/<distro>/<flavor>/flavor.conf and images/<distro>/<flavor>/{pre,post}_commands.

You can also set global commands at `images/default/{pre,post}_commands. (This behavior can be disabled by exporting NO_DEFAULT=1)

• distro.conf

  SOURCE_URL="https://mirrors.pku.edu.cn/almalinux/8.10/cloud/x86_64/images/AlmaLinux-8-GenericCloud-latest.x86_64.qcow2" # REQUIRED! Image source url
  PACKAGES=(qemu-guest-agent) # Packages to install
  TIMEZONE=Asia/Singapore # Default: Asia/Shanghai
  

• flavor.conf

  PACKAGES=() # Packages to install
  DISK_SIZE=150G # Size to grow for disk
  PART_TO_GROW=/dev/sda4 #Partition to grow
  MEMORY=4096 # Memory limit for running virt-customize (MB)
  CPU=8 # CPUs for running virt-customize
  TIMEZONE=Asia/Singapore # Default: Asia/Shanghai
  

Paths should be relative to project root.

Q&A

/usr/bin/supermin exited with error

This error may be due to no permission to access vmlinuz and kernel modules. You could 1. allow current user to access /boot/vmlinuz and /lib/modules/<version>; 2. download linux kernel and modules to local folder.

To download kernel and kernel modules:

# e.g. extract required files from ubuntu mainline kernels
wget https://kernel.ubuntu.com/mainline/v6.14/amd64/linux-image-unsigned-6.14.0-061400-generic_6.14.0-061400.202503241442_amd64.deb
dpkg-deb -R linux-image-unsigned-6.14.0-061400-generic_6.14.0-061400.202503241442_amd64.deb kernel
wget https://kernel.ubuntu.com/mainline/v6.14/amd64/linux-modules-6.14.0-061400-generic_6.14.0-061400.202503241442_amd64.deb
dpkg-deb -R linux-modules-6.14.0-061400-generic_6.14.0-061400.202503241442_amd64.deb kernel/modules
depmod -b kernel/modules 6.14.0-061400-generic

Then run build-vm with SUPERMIN_KERNEL=kernel/boot/vmlinuz-6.14.0-061400-generic SUPERMIN_MODULES=kernel/modules/lib/modules/6.14.0-061400-generic/ ./build-vm almalinux8.10 eda

Can't resolve hostname inside virt-customize

Under circumstances when the host's /etc/resolv.conf specifies dns server at localhost or other corner cases, the virtual machine won't be able to resolve hostnames. Try running with sudo or specify dns in guest's /etc/resolv.conf directly.

To-dos

• Checksum and GPG Verify downloaded images
• GitHub Actions
• Global pre/post_commands