Skip to content

Commit d84d76c

Browse files
committed
doc: fix obsolete guide for building guest kernels and rootfs
Documentation for building guest kernels was pointing to a devtool command that does not exist any more. Fix that by pointing to the newly added `./tools/devtool build_ci_artifacts` command. Also, fix rootfs instructions to use this command rather than directly calling `resources/rebuild.sh` which assumes an Ubuntu host. Signed-off-by: Babis Chalios <[email protected]>
1 parent 6b1b729 commit d84d76c

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

docs/rootfs-and-kernel-setup.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,28 @@ For a list of currently supported kernel versions, check out the
5656
### Use the provided recipe
5757

5858
The kernel images used in our CI to test Firecracker's features are obtained by
59-
using the recipe inside devtool:
59+
running the script `resources/rebuild.sh`.
60+
61+
Users can build those locally by running:
6062

6163
```bash
62-
config="resources/guest_configs/microvm-kernel-x86_64-4.14.config"
63-
./tools/devtool build_kernel -c $config -n 8
64+
./tools/devtool build_ci_artifacts kernels
6465
```
6566

66-
or
67+
This will build all versions that we currently use in our CI. `kernels`
68+
subcommand allows passing a specific kernel version to build. For example:
6769

6870
```bash
69-
config="resources/guest_configs/microvm-kernel-arm64-4.14.config"
70-
./tools/devtool build_kernel -c $config -n 8
71+
./tools/devtool build_ci_artifacts kernels 6.1
7172
```
7273

73-
on an aarch64 machine.
74+
will build only the 6.1 kernel.
75+
76+
Currently supported kernel versions are: `5.10`, `5.10-no-acpi` (same as 5.10
77+
but without ACPI support) and `6.1`.
78+
79+
After the command finishes, the kernels along with the corresponding KConfig
80+
used will be stored under `resources/$(uname -m)`.
7481

7582
## Creating a rootfs Image
7683

@@ -170,11 +177,11 @@ The disk images used in our CI to test Firecracker's features are obtained by
170177
using the recipe (in a Ubuntu 22.04 host):
171178

172179
```bash
173-
./resources/rebuild.sh
180+
./tools/devtool build_ci_artifacts rootfs
174181
```
175182

176183
The images resulting using this method are minimized Ubuntu 22.04. Feel free to
177184
adjust the script(s) to suit your use case.
178185

179-
You should now have a kernel image (`vmlinux`) and a rootfs image
180-
(`rootfs.ext4`), that you can boot with Firecracker.
186+
You should now have a rootfs image (`ubuntu-22.04.ext4`), that you can boot with
187+
Firecracker.

0 commit comments

Comments
 (0)