cc-check: Document "unrestricted_guest" requirement

The `cc-check` command requires the "unrestricted_guest" KVM feature. This is used as a heuristic to determine if the system is new enough to run a Clear Container. Fixes #421. Signed-off-by: James O. D. Hunt <[email protected]>
clearcontainers · Jan 30, 2018 · 93c71c9 · 93c71c9
1 parent 3aec1b6
commit 93c71c9
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/cc-check.go b/cc-check.go
@@ -86,7 +86,11 @@ var requiredKernelModules = map[string]kernelModule{
 	"kvm_intel": {
 		desc: "Intel KVM",
 		parameters: map[string]string{
-			"nested":             "Y",
+			"nested": "Y",
+			// "VMX Unrestricted mode support". This is used
+			// as a heuristic to determine if the system is
+			// "new enough" to run a Clear Container
+			// (atleast a Westmere).
 			"unrestricted_guest": "Y",
 		},
 	},