Skip to content

Commit 83a9a55

Browse files
committed
doc: clarify kernel configuration usage in our repo
We keep in the repo the kernel configurations from which we build the kernel images we use in our CI pipelines. However, we don't mention what kernel sources we use to build these kernel images. Clarify in the documentation that these configurations are meant to be used with kernels provided by Amazon Linux and that we don't guarantee that they can be used to build kernels from upstream Linux. Signed-off-by: Babis Chalios <[email protected]>
1 parent fc55a48 commit 83a9a55

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/kernel-policy.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ The guest kernel configs used in our validation pipelines can be found
3737
[here](../resources/guest_configs/) while a breakdown of the relevant guest
3838
kernel modules can be found in the next section.
3939

40+
We use these configurations to build microVM-specific kernels vended by Amazon
41+
Linux. microVM kernel source code is published in the Amazon Linux
42+
[linux repo](https://github.com/amazonlinux/linux) under tags in the form of
43+
`microvm-kernel-*`, e.g. 6.1.128-3.201.amazn2023 kernel can be found
44+
[here](https://github.com/amazonlinux/linux/tree/microvm-kernel-6.1.128-3.201.amzn2023).
45+
These kernels may have diverged from the equivalent mainline versions, as we
46+
often backport patches that we require for supporting Firecracker features not
47+
present in the kernel versions we officially support. As a result, kernel
48+
configurations found in this repo should be used to build exclusively the
49+
aforementioned Amazon Linux kernels. We do not guarantee that using these
50+
configurations to build upstream kernels, will work or produce usable kernel
51+
images.
52+
4053
## Guest kernel configuration items
4154

4255
The configuration items that may be relevant for Firecracker are:

0 commit comments

Comments
 (0)