From 32d0cbd5b30c8a94d0aefd42cfc4bba08106a6d9 Mon Sep 17 00:00:00 2001 From: Franck Cuny Date: Sat, 15 May 2021 13:54:00 -0700 Subject: readme: update instructions --- README.org | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.org b/README.org index 53cee39..b821eb7 100644 --- a/README.org +++ b/README.org @@ -13,3 +13,19 @@ A recent [[https://fly.io/blog/docker-without-docker/][article]] from the team a 7. Hand all this stuff off to Firecracker and tell it to boot . As I've been interested in playing with both containerd's API and firecracker, I thought it would be a good opportunity to try to implement this. +* How +You'll need a few things before you can run this tool. +** Kernel +You'll need a kernel to run this. The following instructions should do it (to get a 5.8 kernel): +#+begin_src sh +git clone https://github.com/torvalds/linux.git linux.git +cd linux.git +git checkout v5.8 +curl -o .config -s https://github.com/firecracker-microvm/firecracker/blob/main/resources/microvm-kernel-x86_64.config +make menuconfig +make vmlinux -j8 +#+end_src +** CNI +You need CNI plugins and configurations installed. The recommended configuration is stored under ~hack/cni~. It needs to be copied to ~/etc/cni/conf.d~. +** Firecracker binaries +Running ~make firecracker-binary~ will download a version of firecracker under the directory ~hack/firecracker~. -- cgit 1.4.1