README.md: Add "Known Limitations" section

Add the "Known Limitations" section, initially pointing the use of the CONFIG_NR_CPUS=8 option in the kernel config. Fixes: containers/crun#1057 Signed-off-by: Sergio Lopez <[email protected]>
containers · Nov 25, 2022 · 481975e · 481975e
1 parent d1d4038
commit 481975e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -46,6 +46,10 @@ This will create a lightweight Linux VM using ```krunvm``` with the current work
 make
 ```
 
+## Known limitations
+
+* To save memory, the embedded kernel is configured with ```CONFIG_NR_CPUS=8```, which limits the maximum number of supported CPUs to 8. If this kernel runs in a VM with more CPUs, only the first 8 will be initialized and used.
+
 ## License
 
 This library bundles a Linux kernel but does not execute any code from it, acting as a mere storage format. As a consequence, this library does not constitute a derivative work of the Linux kernel. Thus, the following licenses apply: