Skip to content

Commit

Permalink
implemented kaps in quardle feature
Browse files Browse the repository at this point in the history 
- setup: install kaps sources
- add_kaps: build kaps from sources and add it to quardle

Signed-off-by: leofvo <[email protected]>
  • Loading branch information
@leofvo
leofvo committed May 2, 2022
1 parent 7f2c155 commit 794a31c
Show file tree
Hide file tree
Showing 2 changed files with 126 additions and 26 deletions.
143 changes: 120 additions & 23 deletions src/quardle/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ impl Quardle {
.add_kernel()
.add_initramfs()
.add_config_file()
.clean_quardle_build_dir()
.make_archive()?;

// Deleting temporary files used to build the quardle
Expand Down Expand Up @@ -92,6 +93,16 @@ impl Quardle {
.expect("failed to setup quark");
}

// Install kaps sources
if !std::path::Path::new(&format!("{}kaps", QUARK_CONFIG_DIR)).exists() {
info!("Kaps not found, installing it !");
Command::new("git")
.args(["clone", "https://github.com/virt-do/kaps.git"]) // Using https protocol because it seems not supporting ssh
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to fetch kaps");
}

// Install a default kernel configuration file
if !std::path::Path::new(&format!("{}linux-config-x86_64", QUARK_CONFIG_DIR)).exists() {
info!("Kernel config file not found, installing it !");
Expand Down Expand Up @@ -152,28 +163,43 @@ impl Quardle {
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to extract rootfs archive");

// Adding kaps binary to the rootfs
self.add_kaps_to_rootfs();
}

if !std::path::Path::new(&format!("{}mkinitramfs.sh", QUARK_CONFIG_DIR)).exists() {
info!("InitramFS build script not found, installing it !");
Command::new("curl")
.arg("https://raw.githubusercontent.com/virt-do/quark/main/tools/mkinitramfs.sh")
.arg("-O")
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to download initramfs build script");
Command::new("chmod")
.arg("+x")
.arg(format!("{}mkinitramfs.sh", QUARK_CONFIG_DIR))
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to make initramfs build script executable");
}

// Install a script to build kaps bundle
if !std::path::Path::new(&format!("{}mkbundle.sh", QUARK_CONFIG_DIR)).exists() {
info!("Kaps bundle build script not found, installing it !");
Command::new("curl")
.arg("https://raw.githubusercontent.com/virt-do/lab/main/do-vmm/rootfs/mkbundle.sh")
.arg("-O")
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to fetch kaps bundle build script");

if !std::path::Path::new(&format!("{}mkinitramfs.sh", QUARK_CONFIG_DIR)).exists() {
info!("InitramFS build script not found, installing it !");
Command::new("curl")
.arg("https://raw.githubusercontent.com/virt-do/quark/main/tools/mkinitramfs.sh")
.arg("-O")
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to download initramfs build script");
Command::new("chmod")
.arg("+x")
.arg(format!("{}mkinitramfs.sh", QUARK_CONFIG_DIR))
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to make initramfs build script executable");
}

info!("InitramFS not builded, building it !");
Command::new(format!("{}mkinitramfs.sh", QUARK_CONFIG_DIR))
Command::new("chmod")
.arg("+x")
.arg(format!("{}mkbundle.sh", QUARK_CONFIG_DIR))
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to build initramfs");
.output()
.expect("failed to make kernel build script executable");
}
self
}
Expand All @@ -195,14 +221,68 @@ impl Quardle {
fn add_initramfs(&self) -> &Quardle {
info!("Installing initRamFS image to quardle");
Command::new("cp")
.arg(format!("{}initramfs.img", QUARK_CONFIG_DIR))
.arg("-r")
.arg(format!("{}alpine-minirootfs", QUARK_CONFIG_DIR))
.arg(format!("{}", self.clone().get_work_dir()))
.output()
.expect("failed to write initramfs");
.spawn()
.expect("failed to copy rootfs");

// If offline mode is active, we need to build kaps bundle image directly in the quardle.
if self.offline {
println!("Offline mode, adding kaps bundle to the quardle.");
Command::new(format!("{}mkbundle.sh", QUARK_CONFIG_DIR))
.arg(format!("{}/alpine-minirootfs/ctr-bundle", self.clone().get_work_dir()))
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to build initramfs");
}

// add init file to it
info!("InitramFS not builded, building it !");
Command::new(format!("{}mkinitramfs.sh", QUARK_CONFIG_DIR))
.arg(format!("{}/alpine-minirootfs", self.clone().get_work_dir()))
.current_dir(format!("{}", QUARK_CONFIG_DIR))
.output()
.expect("failed to build initramfs");

self
}

fn clean_quardle_build_dir(&self) -> &Quardle {
info!("Cleaning quardle build directory !");
Command::new("rm")
.arg("-rdf")
.arg("alpine-minirootfs")
.arg("mkbundle.sh")
.arg("mkinitramfs.sh")
.current_dir(format!("{}", self.clone().get_work_dir()))
.output()
.expect("failed to clean quardle build directory");
self
}

/// Append kaps binary to rootfs image
/// Fetch kaps source code if isn't already installed, build it from source and copy it to the working directory
fn add_kaps_to_rootfs(&self) -> &Quardle {
info!("Installing kaps to quardle");
Command::new("cargo")
.current_dir(format!("{}kaps", QUARK_CONFIG_DIR))
.arg("build")
.arg("--release")
// .arg("--out-dir") //TODO: outdir is only available on nightly for now, should be used later
// .arg(format!("{}/rootfs/usr/bin/kaps",self.clone().get_work_dir()))
.output()
.expect("failed to build kaps");

Command::new("cp")
.arg(format!("{}kaps/target/release/kaps", QUARK_CONFIG_DIR))
.arg(format!("{}/alpine-minirootfs/usr/bin/kaps",self.clone().get_work_dir()))
.output()
.expect("failed to copy kaps");

self
}

/// Generate the config file of the quardle
/// The config file is a JSON file containing a QuardleConfig struct
fn add_config_file(&self) -> &Quardle {
Expand Down Expand Up @@ -277,4 +357,21 @@ mod tests {
assert_eq!(quardle.as_ref().unwrap().name, "test4");
assert_eq!(quardle.as_ref().unwrap().container_image_url, "container4");
}

#[test]
fn quardle_add_kaps_to_rootfs() {
let quardle = Quardle::new("test6".to_string(), "container6".to_string(), false);
quardle.as_ref().unwrap().add_initramfs().add_kaps_to_rootfs();
assert_eq!(quardle.as_ref().unwrap().name, "test6");
assert_eq!(quardle.as_ref().unwrap().container_image_url, "container6");
}

#[test]
#[should_panic]
fn quardle_clean_quardle_build_dir() {
let quardle = Quardle::new("test5".to_string(), "container5".to_string(), false);
quardle.as_ref().unwrap().clean_quardle_build_dir();
assert_eq!(quardle.as_ref().unwrap().name, "test5");
assert_eq!(quardle.as_ref().unwrap().container_image_url, "container5");
}
}
9 changes: 6 additions & 3 deletions tools/mkinitramfs.sh
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/bash
DEST=${1:-"alpine-minirootfs"}

pushd alpine-minirootfs
pushd "$DEST"
cat > init <<EOF
#! /bin/sh
#
Expand All @@ -10,8 +11,10 @@ mount -t devtmpfs dev /dev
mount -t proc proc /proc
mount -t sysfs sysfs /sys
ip link set up dev lo
exec /sbin/getty -n -l /bin/sh 115200 /dev/console
poweroff -f
exec /opt/kaps run --bundle /ctr-bundle
# exec /sbin/getty -n -l /bin/sh 115200 /dev/console
# poweroff -f
EOF

chmod +x init
Expand Down

0 comments on commit 794a31c

Please sign in to comment.