From 08176aa1fb43e437dda1ccdb483a87da341862b6 Mon Sep 17 00:00:00 2001 From: Alban Crequy Date: Tue, 26 May 2015 10:46:03 +0200 Subject: [PATCH] documentation: kernel requirements Fixes #918 --- Documentation/hacking.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/Documentation/hacking.md b/Documentation/hacking.md index 6a4038a..d4992a6 100644 --- a/Documentation/hacking.md +++ b/Documentation/hacking.md @@ -10,7 +10,7 @@ For more information on the rkt internals, see the [`devel`](devel/) documentati rkt should be able to be built on any modern Linux system. For the most part the codebase is self-contained (e.g. all dependencies are vendored), but assembly of the stage1 requires some other tools to be installed on the system. -### Requirements +### Build-time requirements * Linux 3.8+ * make @@ -30,6 +30,21 @@ cd rkt ./build ``` +### Run-time requirements + +rkt is statically linked and does not require any dynamic libraries to be installed. However, it requires the following kernel features: + +* `CONFIG_CGROUPS` +* `CONFIG_NAMESPACES` +* `CONFIG_UTS_NS` +* `CONFIG_IPC_NS` +* `CONFIG_PID_NS` +* `CONFIG_NET_NS` + +Additionally, the following features are nice to have: + +* `CONFIG_OVERLAY_FS` (to prepare the rootfs without tar) + ### With Docker Alternatively, you can build rkt in a Docker container with the following command.